Payouts

Get a payout

Get payout details by ID

get/payouts/{id}

Request

  • Base URL
    https://public-api.alternativepayments.io
  • URL
    https://public-api.alternativepayments.io/payouts/{id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: payouts:read

Path parameters

idstring required

Payout ID

Response

OK

arrival_datestring
created_atstring
customer_idstring
idstring
status'unspecified' | 'creating' | 'processing' | 'analyzing' | 'succeeded' | 'scheduled' | 'approved' | 'canceled' | 'pending' | 'failed'
sub_totalnumber
totalnumber

Changes

No recorded changes to this operation across all 7 revisions of this API.