DOCUMENTATION API REFERENCE
Home
Getting started with the API
API Workflow Diagrams
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)
Confirmation of Payee Outbound (UK)
SCA for API Payments
Rate Limiting
Push Notifications / Webhooks
Deprecation Policy
Maintenance Windows
Preserving Beneficiary Details
Integration FAQ
GitHub
SDK
Request a demo
Glossary
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)
Confirmation of Payee Outbound (UK)
SCA for API Payments
PLATFORM SPECIFICS
Rate Limiting
Push Notifications / Webhooks
Deprecation Policy
Maintenance Windows
Preserving Beneficiary Details
Integration FAQ
USEFUL LINKS
GitHub
SDK
Request a demo
Glossary
COLLECT
Funding
Find Funding AccountsGET
Sender
Get Sender DetailsGET
Demo
Emulate inbound fundsPOST
Transaction Approval
Accept or Reject Inbound TransactionPUT
CONVERT
Conversions
Create ConversionPOST
Get ConversionGET
Find ConversionsGET
Quote Conversion CancellationGET
Cancel a ConversionPOST
Quote Conversion Date ChangeGET
Conversion Date ChangePOST
Retrieve Profit / LossGET
Split PreviewGET
Conversion SplitPOST
Conversion Split HistoryGET
Rates
Get Basic RatesGET
Get Detailed RatesGET
MANAGE
Authenticate
LoginPOST
LogoutPOST
Accounts
Create AccountPOST
Get AccountGET
Update AccountPOST
Get Authenticating AccountGET
Find AccountsPOST
Get Payment Charges SettingsGET
Manage Account Payment Charges SettingsPOST
Accept Terms of UsePOST
Balances
Get BalanceGET
Find BalancesGET
Top Up Margin BalancePOST
Contacts
Get Authenticating ContactGET
Find ContactsPOST
Get ContactGET
Update ContactPOST
Create ContactPOST
Generate HMAC Key for ContactPOST
Reference
Find Bank DetailsPOST
Get Beneficiary RequirementsGET
Get Conversion DatesGET
Get Available CurrenciesGET
Get Payer RequirementsGET
Get Payment DatesGET
Get Payment Fee RulesGET
Get Payment Purpose CodesGET
Get Settlement AccountsGET
Reporting
Generate Conversion ReportPOST
Generate Payment ReportPOST
Find Report RequestsGET
Retrieves a Report Request with the given IDGET
Transactions
Find TransactionsGET
Get TransactionGET
Withdrawal Accounts
Find Withdrawal AccountGET
Pull Funds From Withdrawal AccountPOST
PAY
Beneficiaries
Find BeneficiariesPOST
Get BeneficiaryGET
Update BeneficiaryPOST
Create BeneficiaryPOST
Delete BeneficiaryPOST
Validate BeneficiaryPOST
Verify Beneficiary AccountPOST
Payments
Create PaymentPOST
Find PaymentsGET
Get PaymentGET
Update PaymentPOST
Get Payment ConfirmationGET
Get Payment SubmissionGET
Get Payment Submission InformationGET
Authorise PaymentPOST
Delete PaymentPOST
Get Payment Tracking InformationGET
Assign Payment FeePOST
Get Payment Delivery DateGET
Get Payment FeesGET
Get Quote Payment FeeGET
Unassign Payment FeePOST
Validate PaymentPOST
Payers
Get PayerGET
Transfers
Create TransferPOST
Get TransferGET
Find TransfersGET
Cancel TransferPOST
Help CenterRegister for API key
Register to get a demo API key
Use the form below to register for a developer account. Once submitted, you will receive an email with instructions for generating an API key. An API key will enable you to login to make live API requests in our demo environment, please note that the demo environment will not always reflect the live environment.
I've lost my API key
*Mandatory
First name
*
Last name
*
Company name
*
Company Email
*
Password
*
Confirm password
*
I accept the terms and conditions, privacy policy and cookie policy.
I would like to hear from Currencycloud with its latest news, products and offers.
Currencycloud will collect and use your personal information in accordance with its Privacy Policy. Please take a moment to read and understand what it says.