Home / API Guide

API guide

A practical walkthrough of how a transaction is created, funded, approved and released through the Rbcpay API.

Build. Integrate. Transact.

The Rbcpay API gives developers the tools to build secure, reliable and scalable transaction workflows.

RESTful API

Simple and consistent endpoints using standard HTTP methods.

Bank-grade security

OAuth 2.0 authentication, end-to-end encryption and IP allowlisting.

Real-time updates

Webhooks keep your system in sync with transaction events.

Developer friendly

Well documented endpoints, SDKs and a sandbox environment.

Scalable infrastructure

Built for reliability, performance and global scale.

Expert support

Dedicated developer support to help you succeed.

How a transaction works via API

1. Create transaction

Create a transaction with terms, parties, items and your commission.

2. Fund transaction

The buyer funds the transaction securely through Rbcpay.

3. Approvals

The buyer approves the transaction and funds are confirmed.

4. Deliver or fulfil

The seller delivers the items or fulfils the agreed terms.

5. Release funds

The buyer confirms receipt and funds are released to the seller.

6. Everyone is paid

Rbcpay releases the commission to you in the same step.

API overview

The Rbcpay API is a REST interface over HTTPS. Requests and responses are JSON. Every integration should be built and tested against the sandbox before it is pointed at live credentials.

Base URL

https://api.rbcpay.com/v1

Authentication

Rbcpay uses OAuth 2.0 for secure API access. Include the access token in the Authorization header on every request. Credentials must stay server side and should never appear in client-side code or a public repository.

Authorization: Bearer {access_token}

Transactions

A transaction is created with the two parties, the amount, the currency, the items and any broker commission. Both parties must accept the terms before it can be funded.

cURL

curl -X POST https://api.rbcpay.com/v1/transactions \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "New Transaction",
    "amount": 12500.00,
    "currency": "CAD",
    "buyer":  {"email": "buyer@example.com"},
    "seller": {"email": "seller@example.com"},
    "items": [{"name": "Server equipment", "qty": 1}],
    "commission": 250.00
  }'

Webhooks

Rbcpay notifies your server whenever a transaction changes state, so your product stays in sync without polling. Verify every delivery before you trust it, and use the developer portal to inspect and replay past deliveries.

Webhook payload

POST https://your-server.example.com/rbcpay/webhook
Content-Type: application/json

{
  "event": "transaction.status_changed",
  "transaction_id": "txn_00000000",
  "status": "funded",
  "occurred_at": "2026-08-27T10:15:00Z"
}

Errors

A failed request returns a standard HTTP status code together with a JSON body describing the problem. Handle the code rather than matching on the message, since wording can change.

Error response

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
  "error": {
    "code": "invalid_currency",
    "message": "The currency is not supported for this transaction.",
    "field": "currency"
  }
}

Rate limits

Requests are rate limited per set of credentials. When a limit is reached the API responds with 429 Too Many Requests. Applications should back off and retry rather than repeating immediately. Current limits are published in the full API reference.

SDKs and libraries

Integration is possible from any language that can make HTTPS requests and parse JSON. Official SDKs and code libraries are listed in the developer portal.

Sandbox environment

Test your integration in a safe and realistic sandbox environment.

API documentation

Explore detailed guides, endpoints, parameters and example responses.

SDKs and libraries

Speed up development with our official SDKs and code libraries.

Developer support

Our developer success team is here to help you at every step.

Ready to build with Rbcpay?

Start building secure and reliable transaction workflows with our API.

Have questions? Contact our developer support team.