Create Balance Transfer

post

https://api.getorbital.io/balance/transfer

Initiates a transfer of funds from between two eCommerce Accounts (merchant Ids).

Body Params

sourceMerchantId

string

required

The source account where funds will be deducted.

targetMerchantId

string

required

The destination account where funds will be credited.

amount

string

required

The amount to transfer (represented as a string to maintain precision).

remittanceInformation

string

A custom note or reference for the transfer.

Headers

x-idempotency-key

string

required

A unique UUID to prevent duplicate transfers. Keys expire after 1 hour, after which the same ID can be reused for a new request.

If the server receives two requests with the same x-idempotency-key, it will execute the transfer only once.

First Request: Processed normally; returns the success object.
Second Request (Same Key): Returns the cached result of the first request without moving any extra funds.

Responses

Updated 2 months ago

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 2 months ago

200Ok