Query Payment

Query the current status of a payment or get other payment information.

GET   /v1/payment/query/{PartnerPaySeq}

Request

PartnerPaySeq  (url)

StringMax Size: 16 characters

Unique identifier for this payment.

HostPaymentToken (optional header)

StringMax Size: 2000 characters

Required by the Hosted Payment Page to authenticate.

Example

/v1/payment/query/4420031

Response

PartnerPaySeq

IntegerMax Size: 16 digits

Unique identifier for this payment.

Status

StringMax Size: 20 characters

Current status of this payment. Can be one of the following:

PaymentType

StringMax Size: 20 characters

Payment type for this payment.

Value: InteracRFM

PaymentURL

StringMax Size: 200 characters

URL to give to the customer to complete their payment. (If you use the URL method)

CreatedDate

StringMax Size: 25 characters

Datetime of when this payment was created (in UTC).

DepositedDate (Optional)

StringMax Size: 25 characters

Datetime of when this payment was deposited successfully (in UTC).

PaymentRef

StringMax Size: 200 characters

Unique identifier for this payment.

CustomerRef

StringMax Size: 100 characters

Unique identifier for this customer.

Email (Optional)

StringMax Size: 100 characters

Email address to send the payment link

PhoneNumber (Optional)

StringMax Size: 100 characters

Phone number to send the payment link to. (Required if no Email)

Amount

Number (8, 2 decimals)Max Size: 11

Total amount for the payment to charge the customer.

Language

StringSize: 2 characters

Customer's preferred language.

Values: en or fr | Default: en

Example

{

  "PartnerPaySeq": 4420031,

  "Status": "DEPOSITED",

  "PaymentType": "InteracRFM", 

  "PaymentURL": "https://paymentlink.ca", 

  "CreatedDate": "2021-03-31T22:18:21.000Z",

  "DepositedDate":"2021-03-31T22:38:21.000Z",

"PaymentRef": "98765444",

  "CustomerRef": "ABCDE12345",

"Email": "example@gmail.com",

"Amount": 98.25,

"Language": "en"

}