Jump to Content
Home
Guides
Recipes
API Reference
Changelog
Discussions
v1.0
Home
Guides
API Reference
Guides
Moon (Dark Mode)
Sun (Light Mode)
v1.0
API Reference
Request body fields
Search
All
Pages
Start typing to search…
JUMP TO
THE BASICS
INTRODUCTION
API Basics and Restrictions
Currency Exchanging Basics
Get started
Partner Workflow
Test Application/Sandbox
FEATURES
Email Notifications for Completed Transfers
Real-Time Exchange Rates
Payment Types & Payment Instructions
Other Functionality
STATUSES
PAYMENT STATUSES
APPROVAL STATUSES
INITIATION STATUSES
ONBOARDING STATUS
Request body fields
Local Payment body fields
International Payment body fields
AUTHENTICATION
Authentication and Tokens
Token management for a Partner Integration
Errors
Payment Validation Errors
Webhooks
Token webhook
Payment webhook
ENDPOINTS
Approval
/v2/approvals/{paymentReference}/reject
patch
/v1/approvals/{paymentReference}/reject
patch
Auth
/token
post
/v1/token
post
Banks
/v2/bankaccounts
get
/v2/bankaccounts
post
/v2/banks/{countryCode}
get
/v1/bankaccounts
get
/v1/bankaccounts
post
/v1/banks/{countryCode}
get
Batch
/v2/batches
post
/v2/batches/{batchId}
get
/v1/batches
post
/v1/batches/{batchId}
get
Connect
/api/connect/token
post
/api/connect/refresh-token
post
Customer
/v2/customers/{customerNumber}/payments
get
/v2/customers/{customerNumber}/payments/{paymentReference}
get
/v1/customers/{customerNumber}/payments
get
/v1/customers/{customerNumber}/payments/{paymentReference}
get
EconomicSettings
/v2/economic/settings
post
/v2/economic/settings
get
/v1/economic/settings
post
/v1/economic/settings
get
InternationalPayments
/v2/payments
post
/v2/payments/{reference}
get
/v2/payments/status/{status}
get
/v2/payments/approval/{status}
get
/v1/payments
post
/v1/payments/{reference}
get
/v1/payments/status/{status}
get
/v1/payments/approval/{status}
get
LocalPayments
/v2/local/payments
post
/v1/local/payments
post
Onboarding
/v2/signup
post
/v2/customers/registrations/{registrationNumber}
get
/v1/signup
post
/v1/customers/registrations/{registrationNumber}
get
Quotes
/v2/allowedCurrencies
get
/v1/allowedCurrencies
get
Scheduled
/v2/local/payments/scheduled/delete
put
/v2/payments/scheduled/delete
put
/v1/local/payments/scheduled/delete
put
/v1/payments/scheduled/delete
put
ValidatePayments
/v2/payments/validate
post
/v1/payments/validate
post
Powered by
Request body fields
