v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Bill Pay Endpoints

bill-pay/transaction

This endpoint is used to fetch a bill pay transaction.

get/bill-pay/transaction

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

TransactionIDstring required

The ID of the transaction to fetch.

Response

Successboolean

ErrorMessagestring

TransactionIDstring

TransactionStatusstring

TransactionDateTimestring

Amountnumber

Currencystring

LastModifiedstring

MerchantIDstring

MerchantNamestring

MerchantCategorystring

PaymentAccountFormatstring

CreditInstitutionstring

CreditCategorystring

CanadianCreditorIdentificationNumberstring

Nicknamestring

PaymentAccountstring

AdditionalInformationstring

ClientReferenceNumberstring

Notestring

Example response

{
  "Success": true,
  "TransactionID": "12345",
  "TransactionStatus": "Completed",
  "TransactionDateTime": "2025-07-25 12:00:00",
  "Amount": 100,
  "Currency": "CAD",
  "LastModified": "2025-07-25 12:00:00",
  "MerchantID": "M123",
  "MerchantName": "Merchant Name",
  "MerchantCategory": "Utilities",
  "PaymentAccountFormat": "123456789",
  "CreditInstitution": "Bank of Montreal",
  "CreditCategory": "Credit Card",
  "CanadianCreditorIdentificationNumber": "123456789",
  "Nickname": "My Hydro Bill",
  "PaymentAccount": "123456789",
  "AdditionalInformation": "Additional Info",
  "ClientReferenceNumber": "CRN123",
  "Note": "Payment for July"
}