v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Batch Request Endpoints

batch

This endpoint is used to fetch a listing of all your batch transaction requests

get/batch

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

TransactionTypestring

Filters results by transaction type: EFT, Interac, or Paylink. Default is '' (i.e., batch transaction requests of all transaction types are returned).

PaymentTypestring

Filters results by payment type: Credit or Debit. Default is '' (i.e., batch transaction requests of all payment types are returned).

FromDatestring

Returns all batch transaction requests submitted after this date. Date format is YYYY-MM-DD.

ToDatestring

Returns all batch transaction requests submitted before this date. Date format is YYYY-MM-DD.

Response

Successboolean required

True if the sending was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Example response

{
  "Success": true,
  "Batches": {
    "0": {
      "BatchName": "Funding transactions - Jan 2022",
      "TransactionType": "EFT",
      "PaymentType": "Credit",
      "DateAdded": "2022-01-12"
    }
  }
}