/
Payout request changed

Payout request changed
Webhook

Request

Security
SecretApiKey or JWT
Bodyapplication/json

Payload of a webhook event for a payout request or payout request allocation change.

eventTypestringrequired

Webhook event type.

Value:"payout-request-changed"
changeTypestringrequired

Specific payout request change that triggered the webhook.

Enum:"payout-request-created""payout-request-modified""payout-request-blocked""payout-request-unblocked""payout-request-ready""payout-request-returned-to-pending""payout-request-approved""payout-request-approval-undone""payout-request-processing-started""payout-request-fulfilled"
Discriminator
changeobject(PayoutRequestChange)required

Details specific to the payout request or allocation change that triggered the webhook.

payoutRequestIdstring, <= 50 charactersrequired

ID of the payout request.

Example:"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"
customerIdstring, <= 50 charactersrequired

ID of the customer associated with the payout request.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
occurredTimestring, (date-time)required

Date and time when the change occurred.

_embeddedobjectrequired
Payload
{
  "eventType": "payout-request-changed",
  "changeType": "payout-request-created",
  "change": {
    "previousStatus": "string",
    "status": "string",
    "blockReason": "string",
    "blockDescription": "string",
    "splitReason": "string",
    "splitDescription": "string",
    "canceledBy": "string",
    "description": "string",
    "amount": 0.1,
    "remainingAllocationAmount": 0.1,
    "totalFulfilled": 0.1,
    "paymentInstrumentId": "string",
    "allocationId": "string",
    "transactionId": "string",
    "mergedIntoPayoutRequestId": "string",
    "replayTransferId": "string",
    "isAutoAllocation": true,
    "replacedByRemainder": true
  },
  "payoutRequestId": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80",
  "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  "occurredTime": "2019-08-24T14:15:22Z",
  "_embedded": {
    "payoutRequest": { … },
    "customer": { … }
  },
  "_links": [
    { … }
  ]
}

Responses

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