Sign in
Payouts

Get payout details

Changed on

Retrieve a single payout by ID. Returns 404 if the ID is not a payout for this business.

get/v1/payouts/{payout_id}

Request

  • Base URL: https://api.hit-pay.com
  • URL: https://api.hit-pay.com/v1/payouts/{payout_id}
  • Auth: none declared. Required headers: X-BUSINESS-API-KEY

Path parameters

payout_idstring uuid required

Payout ID

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Response

Payout

idstring uuid required
status'scheduled' | 'processing' | 'paid' | 'failed' | 'canceled' | 'pending' required
currencystring required
amountnumber required

Payout amount in major units

source_currencystring required
source_amountnumber required
bank_namestring nullable
bank_accountstring nullable

Masked bank account number

remarkstring nullable
referencestring nullable
failure_codestring nullable

Present when status is failed

failure_messagestring nullable
arrival_datestring date nullable
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "currency": "sgd",
  "source_currency": "sgd"
}

Changes