Skip to main content

SimulatePayoutResponse

Payout state after the simulation, as the payment request payment now reports it

paymentRequestIdstring<uuid>
paymentIdstring<uuid>
payoutStatusstring

Payout status after this step

Possible values: [PENDING_APPROVAL, INITIATED, PAID, FAILED]

Example: PAID
outcomestring

Possible values: [APPROVED, REJECTED, PAID, FAILED]

alreadyProcessedboolean

True when the payout had already reached the requested outcome; nothing changed

messagestring

Human-readable result naming the webhook queued

SimulatePayoutResponse
{
  "paymentRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "paymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "payoutStatus": "PAID",
  "outcome": "APPROVED",
  "alreadyProcessed": true,
  "message": "string"
}