Skip to main content
POST
/
partners
/
payouts
curl --request POST \
  --url https://api.hyperrails.io/api/v1/partners/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference": "payout-001",
  "amount": 10000,
  "currency": "NGN",
  "destination": {
    "accountNumber": "0123456789",
    "accountName": "Jane Doe",
    "bankCode": "058",
    "branchCode": "001"
  },
  "narration": "Vendor payout April"
}
'
{
  "reference": "payout-001",
  "hyperrailReference": "HPR-TRSF-3a1b2c3d4e5f",
  "amount": 10000,
  "fee": 50,
  "currency": "NGN",
  "destination": {
    "accountNumber": "0123456789",
    "accountName": "Jane Doe",
    "bankCode": "058",
    "branchCode": "001",
    "bankName": "GTBank"
  },
  "narration": "Vendor payout April",
  "status": "processing",
  "createdAt": "2026-04-24T10:30:00Z",
  "estimatedCompletionAt": "2026-04-24T10:35:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.hyperrails.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key authentication using Bearer token

Body

application/json
​
reference
string
required

Unique idempotency reference for this payout. Used to prevent duplicate transfers.

Required string length: 1 - 100
Example:

"payout-li"

​
amount
number
required
Example:

100

​
currency
string
required

Currency code for the transfer

Example:

"NGN"

​
destination
object
required
​
narration
string
Example:

".."

Response

Withdrawal initiated successfully

​
amount
number<double>
Example:

100

​
currency
string
Example:

"NGN"

​
destination
object
​
providerStatus
string

Status of the transaction with the upstream provider.

Example:

"PROCESSING"

​
reference
string

Unique transaction reference.

Example:

"TRF-a633516c526a40c4b2ebc6e3c249c5f5"

​
status
string

Internal processing status.

Example:

"PROCESSING"