Skip to main content
POST
Add a payment destination

Authorizations

Authorization
string
header
required

Access token issued by POST /v1/auth/token.

x-zeam-auth
string
header
required

Application secret (the apiKey issued at registration), validated at the Kong edge.

Path Parameters

beneficiaryId
string<uuid>
required

Beneficiary identifier.

Body

application/json

Required fields vary by method. BANK: bankName, accountNumber, accountName, countryIsoCode2, currencyIsoCode3, and branch/routing identifiers as needed. MOMO: mobileNumber, mobileProvider, countryIsoCode2, currencyIsoCode3. CRYPTO: networkName, assetSymbol, walletAddress. For CRYPTO, networkName is resolved server-side; an unknown name is a 422. Internal ids (networkId, assetId, connectorId) are not accepted.

method
string
required

BANK, MOMO, or CRYPTO.

Example:

"BANK"

label
string
isPrimary
boolean
countryIsoCode2
string

ISO 3166-1 alpha-2 country code.

currencyIsoCode3
string

ISO 4217 currency code.

bankName
string
bankCode
string
accountNumber
string
accountName
string
accountType
string
sortCode
string
iban
string
swiftBic
string
branchCode
string
mobileNumber
string
mobileProvider
string
networkName
string

Platform network name for CRYPTO destinations (resolved server-side).

assetSymbol
string
walletAddress
string

Response

Payment destination created.

id
string<uuid>
required
method
string
required

Payment method — BANK, MOMO, or CRYPTO.

Example:

"BANK"

beneficiaryId
string<uuid>
label
string
isPrimary
boolean
countryIsoCode2
string

ISO 3166-1 alpha-2 country code.

currencyIsoCode3
string

ISO 4217 currency code.

bankName
string
bankCode
string
accountNumber
string
accountName
string
accountType
string
sortCode
string
iban
string
swiftBic
string
branchCode
string
mobileNumber
string
mobileProvider
string
networkName
string

Platform network name (CRYPTO destinations).

assetSymbol
string
walletAddress
string
isZeamAccount
boolean
createdAt
string<date-time>
updatedAt
string<date-time>