Skip to main content
POST
Node.js
Required scope: recipient_manage type identifies the destination’s requirements, and fields contains its details. A new recipient is pending until approved; some recipients may be approved automatically after all checks pass. Saving a recipient does not by itself approve it. For crypto_address or crypto, currency and country may be omitted; put network, address and accountName in fields. If supplied, currency must be supported on that network. Bank and mobile money recipients require currency and country. Discover crypto options through GET /v1/recipient-requirements/crypto-networks.

Authorizations

x-ledig-key
string
header
required

Your business API key ID. Keep its secret on your server and use that secret to sign each request.

x-ledig-timestamp
string
header
required

The current Unix timestamp in seconds, used in the signed request.

x-ledig-signature
string
header
required

The request's HMAC-SHA256 signature. Use the v1= prefix for supported own-business requests, or v2= when acting for a managed business with signed business-selection headers. Follow the authentication guide to construct and sign the exact request.

Body

application/json
type
string
required

The destination requirement ID. Both crypto_address and crypto select a crypto wallet recipient.

currency
string
required unless type = crypto_address or crypto

May be omitted for crypto_address or crypto. If supplied, the asset must be supported on the chosen network. Required for bank and mobile money recipients.

Minimum string length: 1
country
string
required unless type = ledig, crypto_address or crypto

May be omitted for crypto_address, crypto or ledig. Crypto recipients default to an empty country because their destination is identified by the network.

fields
object[]

Required for applicable non-ZAR bank and mobile money recipients. For an individual, fields needs firstName and lastName; middleName is optional. For a business, fields needs businessName.

Available options:
individual,
business
bankDetailsSource
enum<string>

Manual bank details are accepted only when the recipient requirements offer that choice. Request payment options for this recipient and use one of the returned methods. ZAR does not support manual bank entry.

Available options:
directory,
manual
oneTime
boolean

Response

Recipient created.

status
string
required
Allowed value: "success"
data
object
required

A saved payment destination with its review status and payment eligibility.

message
string