Skip to navigation
API ReferencePayouts

Retrieve a Payout

Returns one Payout by id: its amount, rail and status, and why it failed if it did. Payouts from the other mode or another Merchant are 404.

Authentication

AuthorizationBearer

Your secret key: sk_test_… in Test mode, sk_live_… in Live mode.

Path parameters

idstringRequired
Payout identifier.

Response

The requested Payout.
idstring
Payout identifier.
amountinteger

Amount paid out, in FJD cents (minor units).

railenum

Business -> bank_transfer, Individual -> wallet.

Allowed values:
statusenum

pending until the money reaches your payout destination, then paid. failed means the transfer didn’t go through; the amount returns to your balance and goes out in the next Payout. Test mode Payouts are always paid.

Allowed values:
paidAtinteger or null
Unix ms timestamp the Payout was paid, or null.
failureReasonstring or null
Why the transfer failed, when status is failed.
createdAtinteger
Unix ms timestamp of the settlement run that created this Payout.

Errors

401
Unauthorized Error
404
Not Found Error