Mandates

Create mandates

post/api/v1/Mandates

Request

Base URL: https://api.payex.io
URL: https://api.payex.io/api/v1/Mandates
Auth: HTTP bearer

Request body

customer_namestring

emailstring email

contact_numberstring

merchant_reference_numberstring

id_type1 | 2 | 3 | 4 | 5

id_numberstring

fpx_mode'01' | '02'

fpx_buyer_bank_idstring

effective_datestring yyyyMMdd

expiry_datestring yyyyMMdd

max_amountinteger

Values should be in cents. For example, MYR 10.00 should be inputed as 1000. Maximum of MYR 30,000.00 for FPX, and MYR 1,000,000.00 for FPX Corporate

initial_amountinteger

Only applicable when debit_type = "AD" (using cards). Specify initial charge of mandate, to be charged on authorization of mandate, outside of the specified collection schedule. Can use used for one-time-charges, upfront fees, etc.

frequency'DL' | 'WK' | 'MT' | 'QR' | 'YR'

frequency_intervalinteger

max_frequencyinteger

'frequency_interval' = 3, and 'frequency' = "MT", means every 3 months

purposestring

debit_type'DD' | 'AD'

Omit parameter if allow customer to choose debit type. Specify debit type to determine debit type for customer

return_urlstring

callback_urlstring

accept_urlstring

reject_urlstring

addressstring

postcodestring

citystring

statestring

countrystring

metadataobject

Any data as long as in the form of dictionary

status'Pending' | 'Draft'

autoboolean

retryboolean

retry_countinteger

Example request

[
  {
    "fpx_mode": "01 - retail, 02 - corporate",
    "max_amount": 1000,
    "initial_amount": 1000,
    "frequency": "DL - daily, WK - weekly, MT - monthly, QR - quarterly, YR - yearly",
    "frequency_interval": 1,
    "max_frequency": 1,
    "debit_type": "DD - direct debit (using bank account), AD - auto debit (using card)",
    "metadata": {
      "id": 1,
      "color": "blue"
    }
  }
]

Response

Success

status'00' | '99'

messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.