DOCUMENTATION
API REFERENCE
GETTING STARTED
Home
Getting started with the API
API Workflow Diagrams
INTEGRATION GUIDES
Overview
Authenticating
Checking your balances
Transferring funds between balances
Making simple payments to beneficiaries
Checking foreign exchange rates
Converting funds from one currency to another
Paying a beneficiary using funds in a different currency
Inbound Funds / Collections
Sub-Account Activity (on_behalf_of)
PLATFORM SPECIFICS
Rate Limiting
Push Notifications / Webhooks
Deprecation Policy
Maintenance Windows
Preserving Beneficiary Details
Integration FAQ
USEFUL LINKS
GitHub
SDK
Request a demo
Glossary
⌘k
INTEGRATION GUIDES
Getting started with the API
Authenticating
Checking your balances
Transferring funds between balances
Making simple payments to beneficiaries
Checking foreign exchange rates
Converting funds from one currency to another
Adding an FX spread
Paying a beneficiary using funds in a different currency
Inbound funds / Collections
Sub-Account Activity (on_behalf_of)
Help Center
Register for API key
LOG IN
DOCUMENTATION
GETTING STARTED
Home
Getting started with the API
API Workflow Diagrams
INTEGRATION GUIDES
Overview
Authenticating
Checking your balances
Transferring funds between balances
Making simple payments to beneficiaries
Checking foreign exchange rates
Converting funds from one currency to another
Paying a beneficiary using funds in a different currency
Inbound Funds / Collections
Sub-Account Activity (on_behalf_of)
PLATFORM SPECIFICS
Rate Limiting
Push Notifications / Webhooks
Deprecation Policy
Maintenance Windows
Preserving Beneficiary Details
Integration FAQ
USEFUL LINKS
GitHub
SDK
Request a demo
Glossary
DOCUMENTATION
GETTING STARTED
Home
Getting started with the API
API Workflow Diagrams
INTEGRATION GUIDES
Overview
Authenticating
Checking your balances
Transferring funds between balances
Making simple payments to beneficiaries
Checking foreign exchange rates
Converting funds from one currency to another
Paying a beneficiary using funds in a different currency
Inbound Funds / Collections
Sub-Account Activity (on_behalf_of)
PLATFORM SPECIFICS
Rate Limiting
Push Notifications / Webhooks
Deprecation Policy
Maintenance Windows
Preserving Beneficiary Details
Integration FAQ
USEFUL LINKS
GitHub
SDK
Request a demo
Glossary
API REFERENCE
COLLECT
Funding
Find Funding Accounts
GET
Sender
Get Sender Details
GET
Demo
Emulate inbound funds
POST
CONVERT
Conversions
Create Conversion
POST
Get Conversion
GET
Find Conversions
GET
Quote Conversion Cancellation
GET
Cancel a Conversion
POST
Quote Conversion Date Change
GET
Conversion Date Change
POST
Retrieve Profit / Loss
GET
Split Preview
GET
Conversion Split
POST
Conversion Split History
GET
Rates
Get Basic Rates
GET
Get Detailed Rates
GET
MANAGE
Authenticate
Login
POST
Logout
POST
Accounts
Create Account
POST
Get Account
GET
Update Account
POST
Get Authenticating Account
GET
Find Accounts
GET
Find Accounts
POST
Get the Payment Charges Settings for a given account
GET
Manage Account Payment Charges Settings
POST
Balances
Get Balance
GET
Find Balances
GET
Top Up Margin Balance
POST
Contacts
Get Authenticating Contact
GET
Find Contacts
GET
Find Contacts
POST
Get Contact
GET
Update Contact
POST
Create Contact
POST
Generate HMAC Key for Contact
POST
Reference
Get Bank Details
GET
Find Bank Details
POST
Get Beneficiary Requirements
GET
Get Conversion Dates
GET
Get Available Currencies
GET
Get Payer Requirements
GET
Get Payment Dates
GET
Get Payment Fee Rules
GET
Get Payment Purpose Codes
GET
Get Settlement Accounts
GET
Reporting
Generate Conversion Report
POST
Generate Payment Report
POST
Find Report Requests
GET
Retrieves a Report Request with the given ID
GET
Transactions
Find Transactions
GET
Get Transaction
GET
Withdrawal Accounts
Find Withdrawal Account
GET
Pull Funds From Withdrawal Account
POST
PAY
Beneficiaries
Find Beneficiaries
GET
Find Beneficiaries
POST
Get Beneficiary
GET
Update Beneficiary
POST
Create Beneficiary
POST
Delete Beneficiary
POST
Validate Beneficiary
POST
Payments
Create Payment
POST
Find Payments
GET
Get Payment
GET
Update Payment
POST
Get Payment Confirmation
GET
Get Payment Submission
GET
Authorise Payment
POST
Delete Payment
POST
Get Payment Tracking Information
GET
Assign Payment Fee
POST
Get Payment Delivery Date
GET
Get Payment Fees
GET
Get Quote Payment Fee
GET
Unassign Payment Fee
POST
Validate Payment
POST
Payers
Get Payer
GET
Transfers
Create Transfer
POST
Get Transfer
GET
Find Transfers
GET
Cancel Transfer
POST
Help Center
Register for API key