Save transaction webhook

In order for the Toqio system to correctly identify the direct debit transaction, it is important to include the following fields in the Save Transaction webhook:

"corePaymentType": DIRECT_DEBIT_OUTBOUND
"mandateId":"string",
"frequency":"CUSTOM, LAST\_DAY\_OF\_MONTH, WEEKLY, EVERY\_OTHER\_WEEK, MONTHLY, DAILY",

Apply Direct Debit

data (boolean): indicates whether the specified customer has activated outbound direct debit functionality for the given currency.

Get Mandates

The integration should return an array of mandates associated with the specified account.

mandateId (required)(string): Unique identifier of the mandate.
merchantName (required)(string): Name of the merchant or service provider.
merchantAccountNumber (string): Bank account number of the merchant or service provider. (Not the client)
merchantSortCode (string): Sort code of the merchant or service provider’s account, if available.
merchantIban (string): IBAN of the merchant, if available.
mandateStatus (required)(string): Current status of the mandate (active OR cancelled).
frequency (string): How often payments are collected.
currency (required)(string): Currency in which the mandate transactions are conducted.
amount (double): amount authorised per collection under this mandate, if available.

Get Mandate Detail

This endpoint retrieves the detailed information of a specific direct debit mandate for a given customer, account, and mandate ID. The response includes all available mandate details, including a list of related transactions and other relevant metadata.

merchantName (required)(string): the name of the merchant or service provider associated with the mandate.
mandateStatus (required)(string): current status of the mandate
amount (double): amount authorised per collection under this mandate, if available.
frequency (string): how often payments are collected.
startDate (date-time): the date when the mandate became active.
nextPaymentDate (date-time): the scheduled date for the next payment under this mandate.