API Workflow Diagrams

The workflow diagrams below demonstrate using our APIs for common use cases.

Useful Definitions

House Account

This refers to your Currencycloud Account or Master Account – a multi-currency eWallet available in all currencies supported by Currencycloud.

Sub-account

This refers to the capability of creating multi-currency eWallets for your customers, which sit within your House Account.

On behalf of

This refers to the capability to execute transactions on behalf of your customers. A contact needs to be created before any activity is undertaken on the sub-account. Once a contact is created, the on_behalf_of parameter should be used in the transactional events (conversion, payment, transactions, searching) at the sub-account level. 

 

The following diagrams show API workflows for common convert and pay use cases for house account or payment aggregators.

Authentication

 

 

 


Rates and conversions – house account level

 

 

 


Beneficiaries and payments

when creating a new beneficiary

 

 


Beneficiaries and payments

when using a beneficiary that already exists

 

 


Balances

 

 

The diagrams below show the API workflows for common collect, convert and pay use cases for sub-accounts.

Authentication

 


Sub-account and contact creation

 

 


Find funding account (collections and settlements)

 


Rates and conversions – on behalf of

 


Beneficiaries and payments – on behalf of

when creating a new beneficiary

 

 


Beneficiaries and payments – on behalf of

when using a beneficiary that already exists

Balances