Skip to main content
Consul home page
Search...
⌘K
Support
Dashboard
Dashboard
Search...
Navigation
API Reference
Overview
Guides
API Reference
Changelog
API Reference
Overview
Authorization
Pagination
Errors
Accounts
GET
Get Consul Balance
Bank Accounts
External Wallets
Recipients
GET
List Recipients
POST
Create a Recipient
GET
Get a Recipient
PATCH
Update a Recipient
DEL
Delete a Recipient
Transactions
GET
List Transactions
GET
Get a Transaction
Deposits
POST
Create a Deposit Quote
POST
Execute a Deposit
GET
Get a Deposit
Payouts
POST
Create a Payout
GET
Get a Payout
GET
List Payout Items
OAuth
GET
Authorize
POST
Exchange Token
POST
Revoke Token
Webhooks
GET
List Webhooks
POST
Create a Webhook
GET
Get a Webhook
PATCH
Update a Webhook
DEL
Delete a Webhook
App
GET
Get App
API Reference
Overview
The Consul API is organized around REST principles and returns responses in JSON format. All endpoints live under the
/v1
base path.
Base URLs:
Environment
URL
Production
https://api.onconsul.com/v1
Sandbox
https://sandbox.onconsul.com/v1
All requests must be authenticated. See
Authorization
for details.
Authorization
⌘I