Fetch PayOut

get

https://api.nxp.techworks.app/api/payout/{reference_code}

Returns a pay-out by the reference_code supplied when it was created, scoped
to the authenticated account. Use this to poll for settlement when the webhook
is not an option: status moves from pending to done, and completed_at
and end_to_end_id are populated at that moment. A rejected transfer carries
the reason in error.

Possible Status

done
failed
totally_refunded
partially_refunded

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Possible Status

200The pay-out, including any refunds recorded against it

400Empty reference_code in the path

401Bearer token missing, expired, or presented from an IP outside the key's allowlist

404No pay-out with this reference code belongs to the authenticated account

500Internal failure. Never carries internal detail