Skip to main content

SimulatePayoutRequest

Move a payment's payout one step through its lifecycle in sandbox

paymentRequestReferencestringrequired

Payment request UUID, your externalId, or the paymentLinkReference. The JSON field paymentRequestId is also accepted.

Possible values: non-empty

Example: ORDER-10045
paymentIdstring<uuid>required

The completed payment whose payout to move: the id of the entry in the payment request's payments array, or the paymentId returned by a simulation.

Example: e9df7b8b-2276-4941-9f87-c4b556c5382d
outcomestringrequired

APPROVED or REJECTED act on a payout in PENDING_APPROVAL. PAID or FAILED act on a payout in INITIATED, as the bank would report it.

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

Example: PAID
failureReasonstring

Optional reason recorded for REJECTED or FAILED

Possible values: <= 255 characters

Example: Beneficiary account closed
SimulatePayoutRequest
{
  "paymentRequestReference": "ORDER-10045",
  "paymentId": "e9df7b8b-2276-4941-9f87-c4b556c5382d",
  "outcome": "PAID",
  "failureReason": "Beneficiary account closed"
}