Pay API
Overview
BC Registries Pay system is used by the BC Registries account services and integrated systems to create payment transactions to pay for the products purchased. This abstracts the integrated systems from the underlying payment integrations and payment methods.
With this API you can submit the following transactions:
- Create payment transactions
- Get payment status
- Delete unpaid payment transactions
- Generate PDF receipt
- Retrieve account statements
- Generate account transactions reports
Note: All requests must include a BC Registries issued API key and an Account ID.
View the API
View the definition and select a path to try it out. To submit a request you will need an API key and an account ID, which are obtained as part of completing anaccess request. To set your session API key, click on the top, right AUTHORIZE button and under API Key Auth enter your key value. Click on AUTHORIZE, then OK.
API Quick Reference
| Endpoint Path | Description |
|---|---|
| GET /pay/api/v1/fees/{business_type}/{filing_type} | Get fee details based on the type business type and filing type. |
| POST /pay/api/v1/payment-requests | Create invoice records. This will create transaction records in payment system based on account settings. Below payment methods are decided based on the account preference.
|
| GET /pay/api/v1/payment-requests/{invoice_identifier} | Get invoice details by request identifier. |
| DELETE /pay/api/v1/payment-requests/{invoice_identifier} | Delete an invoice. |
| GET /pay/api/v1/payment-requests/{invoice_identifier}/receipts | Returns payment receipt details. |
| POST /pay/api/v1/payment-requests/{invoice_identifier}/receipts | Generates a payment receipt as a PDF. |
| POST /pay/api/v1/accounts/{accountId}/payments/queries | Query account transaction reports. |
| GET /pay/api/v1/accounts/{accountId}/statements | Get a list of statements generated for the account. |
| GET /pay/api/v1/accounts/{accountId}/statments/{statementId} | Return the statement as either PDF or CSV. |
Date and Date Time Formats
| Type | Format | Example |
|---|---|---|
| Date | YYYY-MM-DD | 2020-05-14 |
| DateTime | YYYY-MM-DDThh:mm:ss[Z|+hh:mm]. Either +hh:mm (the time zone offset) or Z must be supplied. Default Z for Pacific time zone value. | 2020-05-14T21:08:32Z |
API Version History
| Date | Version | Description |
|---|---|---|
| 2020-10-06 | 1.0.0 | Initial version |
Additional Resources
Download a Demo Postman collection to view at least one example of each API path. Provide your own API key and account Id to submit requests and view the responses.
Page History
Updates of note to this page are recorded here.
| Date | Description |
|---|---|