Sign in
Payouts

Mock a payout

Changed on

Mocks a payout of the available balance so you can test payout.created webhooks and list charges on a payout. This is not a production payout. Sandbox only. Returns 404 in production.

post/v1/payouts

Request

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

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Request body

currencystring

Wallet currency to pay out. Defaults to the business home currency.

Example request

{
  "currency": "sgd"
}

Response

Payout created

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