logo

Payout request modifiedWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Payout request webhook request body resource.

payoutRequestId
string

ID of the payout request.

eventType
string

Type of webhook event.

Enum: "payout-request-created" "payout-request-modified"
object

Embedded objects.

object (PayoutRequest)
websiteId
required
string (WebsiteId) <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

customerId
required
string <= 50 characters

ID of the customer who is requesting a payout.

currency
required
string = 3 characters

Currency of the payout.

amount
required
number <double>

Amount of the payout.

id
string <= 50 characters

Unique resource ID.

paymentInstrumentId
string <= 50 characters

ID of the requested payment instrument to offer for the payout.

unallocatedAmount
number <double>

Available payout request amount that has not been allocated.

status
string

Status of the request.

Enum: Description
pending

Request is awaiting customer's selection of the payment instrument or fulfillment.

instrument-selected

Request has a selected payment instrument and is awaiting fulfillment.

partially-fulfilled

Request is partially paid out when availableAmount is less than amount.

fulfilled

Request is fully paid out when availableAmount reaches zero.

selectPaymentInstrumentUrl
string <uri>

URL for the customer to select a preferred payment instrument.

Array of objects

List of credit transactions that are allocated to reduce the available amount of a payout request.

selectedPaymentInstrumentRedirectUrl
string <uri>

URL where the customer is redirected when a payment instrument is selected. The default value is the website URL. Use {{id}} as a placeholder for the payout request ID.

createdTime
string <date-time>

Date and time when the payout request is created.

updatedTime
string <date-time>

Date and time when the payout request is updated.

Array of objects (SelfLink)

Related links.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "payoutRequest"
Responses
2xx

Returns any 2xx status to indicate that the data received.

Request samples
application/json
{
  • "payoutRequestId": "string",
  • "eventType": "payout-request-created",
  • "_embedded": {
    },
  • "_links": [
    ]
}
➔ Next to Risk score changed