Get a payment destination

Returns a single payment destination. A destination that exists but does not belong to this beneficiary (or a beneficiary in a different association) 404s identically to one that does not exist.

GET /beneficiaries/{beneficiaryId}/payment-destinations/{destinationId}

Get a payment destination

cURL

curl --request GET \
  --url https://api.zeam.money/gw/v1/beneficiaries/{beneficiaryId}/payment-destinations/{destinationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-zeam-auth: <api-key>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "method": "BANK",
  "label": "<string>",
  "isPrimary": true,
  "countryIso": "<string>",
  "countryName": "<string>",
  "currencyCode": "<string>",
  "region": "<string>",
  "bankName": "<string>",
  "bankCode": "<string>",
  "accountNumber": "<string>",
  "accountName": "<string>",
  "accountType": "<string>",
  "sortCode": "<string>",
  "iban": "<string>",
  "swiftBic": "<string>",
  "branchCode": "<string>",
  "mobileNumber": "<string>",
  "networkName": "<string>",
  "assetSymbol": "<string>",
  "walletAddress": "<string>",
  "isZeamAccount": true,
  "verificationStatus": "NOT_REQUIRED",
  "verifyAsMe": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>"
}

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), required on every request.

Path Parameters

beneficiaryId · string<uuid> · required

Beneficiary identifier.

destinationId · string<uuid> · required

Payment destination identifier.

Response

200

application/json

The payment destination.

id · string<uuid> · required

method · string · required

Payment method — BANK, MOMO, or CRYPTO.

Example:

"BANK"

label · string

isPrimary · boolean

countryIso · string

The destination's country code.

countryName · string

currencyCode · string

ISO 4217 currency code.

region · string

bankName · string

bankCode · string

accountNumber · string

accountName · string

accountType · string

sortCode · string

iban · string

swiftBic · string

branchCode · string

mobileNumber · string

networkName · string

Platform network name (CRYPTO destinations).

assetSymbol · string

walletAddress · string

isZeamAccount · boolean

verificationStatus · enum<string>

Destination verification state. Every state listed here is payable, whatever the beneficiary's classification; the state sets the limits the payment is checked against, not whether it can be made.

Available options: NOT_REQUIRED, PENDING, APPROVED, REJECTED

verifyAsMe · boolean

The destination was submitted for verification as the sender's own account.

createdAt · string<date-time>

updatedAt · string<date-time>

updatedBy · string

Present when the record has been updated.