Getting started with payouts
Initiate payouts effortlessly with our straightforward setup for seamless payment processing.
Payouts can be initiated a variety of ways:
- through the portal,
- using the API,
- file upload (this is covered in https://docs.fuse.me/docs/batch-payments).
APIs
The Fuse product can be used to support several use cases. Here is a summary of APIs that are used to support the payout use case.
- Viewing and creating accounts
- Creating payouts
- Getting transaction data
- Transferring funds between Fuse accounts
In sandbox we provide simulation APIs for simulating scheme actions. See our simulation guide for further details.
Accounts
Primary Accounts
Fuse will provision a primary account for your organisation. This is where funds are sent to cover any payouts that will be made. This account can also be used to make payouts.
The primary account can be viewed in the portal under the accounts section.
The primary account can be retrieved by API by calling list all accounts for an organisation. The account_type will be set to primary.
[
{
"id": "018c584f-158d-71ed-abe2-9895ea3e6544",
"customer_id": null,
"external_id": null,
"account_name": "AED Payouts",
"status": "open",
"current_balance": 0,
"available_balance": 0,
"default_details": {
"iban": "AE080037164338245868134"
},
"currency": "AED",
"account_type": "primary"
}
]
Payment Accounts
If payouts are being made on behalf of other entities then payment accounts can be used to make a payout on behalf of another entity. Funds will be sent to the primary account and then the required payout amount for each entity can be transferred from the primary account to the entity payment account.
Creating payment accounts
A payment account can be created in the portal. This is available in the accounts section or from the command bar.
A payment account can be created via API using the create a payment account API. Here is a walkthrough on creating a payment account with this API.
Viewing payment accounts
Payment accounts can be viewed in the account section of the portal.
The accounts can be retrieved by API by calling list all accounts for an organisation. The account_type will be set to payment for payment accounts.
[
{
"id": "018c584f-158d-71ed-abe2-9895ea3e6544",
"customer_id": null,
"external_id": null,
"account_name": "AED Payouts",
"status": "open",
"current_balance": 0,
"available_balance": 0,
"default_details": {
"iban": "AE080037164338245868134"
},
"currency": "AED",
"account_type": "primary"
},
{
"id": "018c585a-d11f-77f5-8b81-551d4bb696db",
"customer_id": null,
"external_id": "06576dfc-c509-795c-8000-c73397dcd44c",
"account_name": "Contractors Ltd.",
"status": "open",
"current_balance": 0,
"available_balance": 0,
"default_details": {
"iban": "AE760300000000179520462"
},
"currency": "AED",
"account_type": "payment"
},
{
"id": "018c5894-597c-7ca8-9978-e6f20e044fab",
"customer_id": null,
"external_id": "018c5893-912c-7a2d-8441-c88f25d1d281",
"account_name": "Payments Inc.",
"status": "open",
"current_balance": 0,
"available_balance": 0,
"default_details": {
"iban": "AE600940000000625805149"
},
"currency": "AED",
"account_type": "payment"
}
]
Funding
Funding a primary account
Funding is sent to the IBAN of the primary account. In production this is initiated outside of the system. An inbound local payment settled webhook will be sent when then funds have settled into the primary account. The transaction will available in the transaction area of the portal.
The transaction will be available on the list transactions for an account API.
[
{
"type": "local_payment",
"id": "018c589d-b0ce-76e4-a96f-bd5d683cf886",
"account_id": "018c584f-158d-71ed-abe2-9895ea3e6544",
"remitter": {
"name": "Topup",
"identifier": {
"iban": "AE160040000000010865762"
}
},
"currency": "AED",
"external_reference": "fund-10000",
"state": "Settled",
"direction": "Inbound",
"instructed_amount": 1000000,
"amount_with_fee": 1000000,
"fee_amount": 0,
"beneficiary": {
"name": "AED Payouts",
"identifier": {
"iban": "AE080037164338245868134"
}
},
"created_at": "2023-12-11T11:22:58.638384Z",
"authorised_at": null,
"submitted_at": null,
"executed_at": null,
"failed_at": null,
"failure_reason": null,
"purpose": "none",
"batch": null
}
]
In the Sandbox environment funding can be simulated. See simulate inbound payment for details.
Funding a payments account
If payments accounts are being used then they will need to be funded before making payouts for that entity. That can be done by doing an internal transfer from the primary account to the payments account. Internal transfers can be created in the portal and over API.
Webhooks will be sent for various statuses as the Fuse system processes the internal transfer. See the webhooks guide for further details.
Create internal transfer can be accessed from the create payment action menu.
Create an internal transfer by calling the internal transfer between two accounts API. Here is a step-by-step guide for calling this API.
Payouts
Payouts can be processed from a primary account and payment accounts. Processing payouts from the primary account will set the payout to be on behalf of the organisation. Processing payouts from a payments account will set the payout to be on behalf of the entity named on the payment account. Payouts can be processed both from the portal and via the API.
Webhooks will be sent for various status updates as the payment is processed. Please see the webhooks guide for further details.
Create local payment is available from them create paymentaction menu.
A payout can be created by calling the create outbound payment API. Here is a step by step guide for calling this API.
In the sandbox environment scheme actions can be simulated. See the simulating scheme actions in sandbox guide for details.
Updated 11 months ago