Skip to main content
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

​
API-Key
string
required
Unique API key issued manually through Telegram.

​
Request Body

​
currency
string
required
Destination fiat ISO code (NGN, KES, UGX, TZS, MWK).
​
institution
string
required
Payout institution code from List Institutions.
​
accountIdentifier
string
required
Account number / wallet handle.
​
accountName
string
required
Exact account name of record.
​
memo
string
Optional payment memo.
​
providerId
string
Optional preferred LP provider id.

​
Response

​
status
string
Response state (success).
​
data
object
​
recipientId
string
Reference to pass to create-order.
​
expiresInSeconds
integer
Lifetime of the id (86400 = 24h).
{
  "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
  }
}