Skip to main content

OpenWalletRequest

Request to open a wallet

currencystringrequired

ISO 4217 code of a currency the account holds

Possible values: non-empty, Value must match regular expression [A-Z]{3}

Example: AED
namestringrequired

Label of your own for the wallet, for example your end-customer's name or reference. The holder name on its settlement details is always the account's legal name

Possible values: non-empty and <= 140 characters, Value must match regular expression .*\S.*

Example: Customer 42
externalIdstring | nullnullable

Your own reference for the wallet, fixed once the wallet is opened. Unique per account: a repeat with the same externalId returns the existing wallet, whatever its status, instead of opening another; a repeat with the same externalId and different fields is rejected with 409 conflict. The comparison uses the original open request, so a later name change does not affect it. Omit it to open a new wallet on every request

Possible values: non-empty and <= 36 characters, Value must match regular expression .*\S.*

Example: cust-42
OpenWalletRequest
{
  "currency": "AED",
  "name": "Customer 42",
  "externalId": "cust-42"
}