Each of the below transaction types can be created through the User Interface or through an API integration.

If you are using our User Interface you can choose to use this account Float by selecting which account to use when creating the transaction. If you are creating a Payment Request the dropbox will be labelled To Account, if you are creating a Payment or Refund, the dropbox will be labelled From Account.

Send Payouts from your Account Float

You can send payouts from your Account Float to substantially speed up settlement time to the recipient. If your account float is configured for NPP, this settlement time can be as low as three minutes 24/7/365.

Example User Interface when creating as Payment

To do this through the API, simply include the your_bank_account_id field in the API payload when calling the Payment API endpoint, setting it to the account ID of your Account Float. You can even add multiple Payments to the one API request to reduce the amount of requests your system needs to send.

Example payload for a Payment using the your_bank_account_id field

payload = {
"description": "Cloud test payment",
"matures_at": str(datetime.datetime.utcnow()),
"your_bank_account_id": "01b01b35-08d1-4ef9-a82c-040a0070fb2e",
"payouts": [
{
"amount": 3000,
"description": "NPP Payout",
"recipient_contact_id": {contact_id},
"metadata": {
"custom_key": "Custom string",
"another_custom_key": "Maybe a URL",
"remitter": "Your remitter"}
},
{
"amount": 3500,
"description": "Second NPP Payout",
"recipient_contact_id": {contact_id},
}
]
}

Documentation of this endpoint

Receive funds into your Account Float via Payment Requests

To receive funds from a third party into your Account Float when using our User Interface, simply create a new Payment Request and choose the relevant account float before submitting this for processing.

To receive funds from a third party into your Account Float through the API, simply include the your_bank_account_id field in the payload when calling the Payment Request endpoint, setting it to the account ID of your Account Float.

Note that this occurs via the BECS network even if your Account Float is configured for NPP payments. Therefore the availability of funds from direct debits in your Account Float will be on the second business day.

Example payload for a Payment Request using the your_bank_account_id field

payload = {
"description": "Visible to both initiator and authoriser",
"matures_at": str(datetime.datetime.utcnow()),
"amount": 1000,
"authoriser_contact_id": {contact_id},
"your_bank_account_id": "01b01b35-08d1-4ef9-a82c-040a0070fb2e",
"metadata": {
"custom_key": "Custom string",
"another_custom_key": "Maybe a URL",
"remitter": "Your remitter"
}
}

Documentation of the above endpoint

Refund a Payment Request from your Account Float

You can refund a Payment Request with funds from your Account Float. To do this simply include the your_bank_account_id field in the payload when calling the Refund endpoint, setting it to the account ID of your Account Float. If using the User Interface, choose which account float should be used to facilitate this refund when creating the refund by selecting the relevant account in the From Account dropdown.

Example payload for a Refund using the your_bank_account_id field

payload = {
"amount": {amount_in_cents},
"reason": "Custom Reason",
"your_bank_account_id": "01b01b35-08d1-4ef9-a82c-040a0070fb2e",
"metadata": {
"custom_key": "Custom string",
"another_custom_key": "Maybe a URL"
}
}

Documentation of the above endpoint

The refund will take place via Direct Credit, and is subject to the standard DE clearance times.

Did this answer your question?