API Suite - Feb 2022 Release Summary

Summary of changes for the API Suite functional release for February 2022

Draft Payments
Payments via Bank Draft are now available in the API Suite. View the documentation on Draft Payments for more details.

  1. Payment Method set to Draft
  2. Currencies supported: UAE Dirham (AED), Bahraini Dinar (BHD), Canadian Dollar (CAD) , Swiss Franc (CHF), Euro (EUR), Fiji Dollar (FJD), British Pound (GBP), Hong Kong Dollar (HKD) , Japanese Yen (JPY), Cayman Island Dollar (KYD), Mexican Peso (MXN), Philippine Peso (PHP), Singapore Dollar (SGD), United States Dollar (USD)
  3. Draft payments can only be processed one per batch

Settlement Notifications
Additional settlement information is now available through two new endpoints and an additional webhook event. Events are triggered anytime a settlement activity is received. Information included:

  1. Customer ID
  2. Batch or Order ID (API can be initiated by Batch or OrderID)
  3. Date the funds were received
  4. Settlement currency
  5. Total settlement amount
  6. Settlement amount received
  7. Remaining settlement amount (when the settlement received is not for the full amount)
    "customerId": "Customer123",
    "batchId": "Batch123",
    "settlementOrder": [
            "orderId": "Order123",
            "lastDateReceived": "2022-01-01T00:00:00",
            "settlementCurrency": "USD",
            "amountReceived": 500.00,
            "remainingAmountDue": 300.00,
            "totalDue": 800.00

Payment Error Codes
Several generic error code responses have been updated to provide more descriptive details. You can view the full list of Error Codes here.

  1. Payment customer is not set up to use the selected settlement method
    a. Error code: 1210
    b. Description: Customer is not set up to use settlement method
  2. Payment settlement currency is not a ‘Holding’ currency
    a. Error code: 1213
    b. Description: It is not possible to carry a holding balance in this currency
  3. Payment settlement method is E-Debit and total order amount exceeds the customers debit account limit
    a. Error code: 1209
    b. Description: Total amount of the order exceeds the customers debit limit
  4. When making a coupled payment and settling from a holding account with insufficient funds. Or, when making a coupled or decoupled payment and funding the holding account from another holding account with insufficient funds.
    a. Error code: 1111
    b. Description: Insufficient holding balance for settlement