Create a payment method

The payment method channel

The unique identifier of the customer.

The capability of this payment method. DEPOSIT means funds can be pulled from this method (e.g. charge/collect from the customer). WITHDRAW means funds can be sent to this method (e.g. pay out to the customer). If omitted, defaults to WITHDRAW.

The name of the account holder. Must use Latin-script letters (A-Z / a-z, including accented forms such as é, ñ, ü, ç) or Chinese (Han) characters, digits (0-9), spaces and the characters & ( ) + , - . / : ? and apostrophe; it must contain at least one letter. Names in other scripts (e.g. Arabic, Cyrillic) or containing other symbols are rejected. Exception: China-facing payouts on the WE_CHAT and ALIPAY channels accept the beneficiary's local-script (e.g. Chinese) name. On ALIPAY, and on WE_CHAT with currency CNY, the name must be split into first and last name with a space (e.g. "张 伟" or "Wei Zhang").

The account number. For a BANK_ACCOUNT in NG it must be exactly 10 digits. For a BANK_ACCOUNT in a country that uses IBANs (e.g. EUR) it must be a valid IBAN. For MOBILE_MONEY send digits only, with no leading + (country code plus national number); the length is checked for some countries and the number must be a valid phone number for countryCode.

The ISO 3166-1 alpha-2 country code. This has to be one of the countries we support

Optional. Tags the payment method to one of your wallets (DEPOSIT, WITHDRAW or FEE). Stored as sent and not returned on the payment method.

Optional WeChat ID, sent alongside the phone number in accountNumber. Only used on the WE_CHAT channel; ignored on every other channel.

The receiver's district as an ISO 3166-2 code (e.g. BD-13). Only accepted on a MOBILE_MONEY payment method in Bangladesh (countryCode BD), and needed there: a payout to a Bangladesh wallet saved without it is refused. Rejected on every other channel and country.