Home / API Guide
API guide
A practical walkthrough of how a transaction is created, funded, approved and released through the Rbcpay API.
Before you begin
Get sandbox access
Sandbox credentials let you build and test complete transactions without moving any real money.
Authentication
Every request is authenticated with the credentials issued to your integration and sent over HTTPS.
Base URL and version
Requests are sent to the base URL for the API version your integration is built against.
Webhooks
Point a webhook endpoint at your platform so you receive every transaction state change as it happens.
Creating a transaction
Define the terms
Set out the amount, currency, description, inspection period and who pays the fee.
Invite both parties
The buyer and the seller are both added to the transaction and each must accept the terms.
Funding
The buyer funds the transaction and the funds are held until the agreed conditions are met.
Release
Once the buyer approves, the funds are released to the seller according to the agreed terms.
Milestone and brokered transactions
Milestone transactions
Split a larger piece of work into stages, each with its own amount and its own approval, so payment follows delivery.
Brokered transactions add a third party to the agreement. The broker commission is agreed up front and released alongside the seller payment when the transaction completes.
Transaction states
Every transaction moves through a defined sequence of states, and each change is sent to your webhook endpoint.
Testing your integration
Run a full transaction
Create a transaction end to end with both parties accepting the terms.
Fund and record
Fund the transaction and confirm your platform records it correctly.
Approve and release
Approve the transaction and confirm the release step completes.
Check your webhooks
Confirm your webhook endpoint receives every state change.
Ready to build?
Request sandbox access, or contact developer support at escrow@rbcpay.com with any integration questions.