Connecting to the REST API

Headers (Required for all communication)

• x-api-key: This token provided by PSI Integration Manager.

• x-api-uid: Unique ID for each communication.  Suggest using UUID.

Body

• Content-Type: application/json

API endpoints

• Provided in the Testing & Certification Plan

API calls

See the flow diagram for this process.

Request Payment Call

Request a payment link to be created and returned back in the API response (depending on Partner's configuration).

Incoming Payment Callback

PSI will connect to the Partner when an Interac e-Transfer payment has been completed by a customer. 

Partner returns a response to indicate if they want to accept or deny the payment.

Successful Payment Callback

PSI will connect to the Partner when the payment is successfully deposited.

Query Payment Call

Check the current status of a payment.

Security checks before accepting a payment

This step is not required.

Limit checking

You could check that the customer is not exceeding their limits for a given time period (ex. a daily limit of $500)

Account status checking

You could check that the customer's account is in a state that is allowed to be loaded (ex active, approved, etc.)