All endpoints on our API require authentication via an API token with one or more specific roles assigned to it.
The following list shows all available API roles and which endpoints they grant access to:
| Role | Description | Endpoint(s) |
|---|---|---|
Accounts.Lookup | Retrieve accounts, account balances, account entries, funding panels, and funding maps. | List accounts, Retrieve account balance, List account balances, List account entries, List account funding panel, Retrieve account funding map |
AccountMovements.Create | Create, validate, approve, or cancel account movements. | Create account movement, Validate account movement, Approve or cancel account movement |
AccountMovements.Lookup | Retrieve existing account movements. | List account movements, Retrieve account movement |
ChequeVoid.Create | Create cheque void requests. | Void a cheque |
ChequeVoid.Lookup | Retrieve cheque void requests and cheque file copies. | Retrieve voided cheque, Retrieve postal cheque file copy, Retrieve eCheck file copy |
Forex.Create | Create foreign exchange rate groups. | Create foreign exchange rate group |
Forex.Lookup | Retrieve foreign exchange rate groups and indicative rates. | Retrieve foreign exchange rate group, List foreign exchange rate groups, List indicative foreign exchange rates, List foreign exchange rates for a send account |
Recipients.Create | Create stored recipients. | Create stored recipient |
Recipients.Delete | Delete stored recipients. | Delete stored recipient |
Recipients.Lookup | Retrieve stored recipients. | List stored recipients, Retrieve stored recipient |
Recipients.Update | Update stored recipients. | Update stored recipient |
Rules.Lookup | Retrieve rules for a destination country, currency, and route type. | List rules |
TransactionRequests.Create | Create or validate transaction requests. | Create transaction request, Validate transaction request |
TransactionRequests.Lookup | Retrieve or cancel transaction requests. | Retrieve transaction request, Cancel transaction request |
Transactions.Lookup | Retrieve and search transactions. | Retrieve transaction, Search transactions |