{
"currency": "NGN",
"institution": "GTBINGLA",
"accountIdentifier": "0123456789",
"accountName": "Jane Doe",
"memo": "Invoice 42"
}
{
"status": "success",
"message": "Recipient created",
"data": {
"recipientId": "75aa152e-c63f-4d9d-a5c1-4c9d4be7fc3c",
"expiresInSeconds": 86400
}
}
API Reference
Create Recipient
Stage a payout beneficiary and get a recipientId to reference in create-order — so bank details aren’t re-sent on every order.
POST
/
v1
/
sender
/
recipients
{
"currency": "NGN",
"institution": "GTBINGLA",
"accountIdentifier": "0123456789",
"accountName": "Jane Doe",
"memo": "Invoice 42"
}
{
"status": "success",
"message": "Recipient created",
"data": {
"recipientId": "75aa152e-c63f-4d9d-a5c1-4c9d4be7fc3c",
"expiresInSeconds": 86400
}
}
Registers a payout beneficiary (bank / mobile-money account) and returns a
recipientId. Pass that id to Create Order
instead of re-sending the account details each time.
A
recipientId is scoped to your account and valid for 24 hours.Header Parameters
string
required
Unique API key issued manually through Telegram.
Request Body
string
required
Destination fiat ISO code (
NGN, KES, UGX, TZS, MWK).string
required
Payout institution code from List Institutions.
string
required
Account number / wallet handle.
string
required
Exact account name of record.
string
Optional payment memo.
string
Optional preferred LP provider id.
Response
string
Response state (
success).{
"currency": "NGN",
"institution": "GTBINGLA",
"accountIdentifier": "0123456789",
"accountName": "Jane Doe",
"memo": "Invoice 42"
}
{
"status": "success",
"message": "Recipient created",
"data": {
"recipientId": "75aa152e-c63f-4d9d-a5c1-4c9d4be7fc3c",
"expiresInSeconds": 86400
}
}