Payments Canada Developer Portal

POST  Request To Pay

Request to Pay will allow any business or individual to send an electronic request for payment to the debtor. The request will be received by the debtor containing information such as the requested amount and the due date.

Please note: You will need to download the sample request, modify it and attach it to the form to execute this API.

Resource URL /request_to_pay


Content Type



Name Values Description
Accept  (required)
Accept Header (application/json)
Content-Type  (required)
Content-Type Header (application/json)
Name Value Description
body  (required)
Import request to pay request body (json format).

Request Body

HTTP Basic
OAuth 2.0

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Details

HTTP Code Description
200 Status OK (Success)
400 Invalid JSON, please ensure that the JSON is correctly formatted.
401 Unauthorized User (Please check the access token).
404 Not found.
405 Request method not allowed (must be a HTTPS POST request).
406 Not Acceptable (Please set the Accept Header as application/json).
408 Request Timeout.
415 Unsupported Media Type (Please set the Content-Type as application/json).
500 Internal Server Error (Something went wrong).