Mandates

Update mandates

put/api/v1/Mandates

Request

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

Path parameters

reference_numberstring required

Request body

customer_namestring

emailstring email

contact_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

initial_amountinteger

Only applicable when debit_type = "AD"

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

frequency_intervalinteger

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

max_frequencyinteger

purposestring

debit_type'DD' | 'AD'

Only applicable when debit_type = "AD". 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.

status'Draft'

autoboolean

retryboolean

retry_countinteger

metadataobject

Any data as long as in the form of dictionary

Example request

{
  "fpx_mode": "01 - retail, 02 - corporate",
  "effective_date": "yyyyMMdd",
  "expiry_date": "yyyyMMdd",
  "max_amount": 1000,
  "initial_amount": 1000,
  "frequency": "DL - daily, WK - weekly, MT - monthly, YR - yearly",
  "frequency_interval": 1,
  "max_frequency": 1,
  "debit_type": "DD - direct debit, AD - auto debit",
  "metadata": {
    "id": 1,
    "color": "blue"
  }
}

Response

Success

statusstring

messagestring

Changes

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