Nothing Found

Balance transfer

Execute one or more individual balance transfers between wallets. The Idempotency-Key header is optional for this endpoint.

Successful completion triggers these notifications
Balance transfer completed
Invoice complete

For more information about event notifications, visit Webhooks.

Securitytilia_auth
Request
Request Body schema: application/json
required

Balance transfer request

account_id
required
string <= 36 characters

The primary account ID.

balance_transfer_type
required
string

The balance transfer type. Only types defined in the global or per-integrator balance-transfer-types setting are allowed here.

required
Array of objects (TransferItemRequest)

The individual transfer items to be executed.

reference_type
string

A type for your reference_id.

reference_id
string

Your own reference ID for this balance transfer.

description
string

A user-facing description for this balance transfer.

metadata
string

An arbitrary data structure associated with this balance transfer.

Responses
200

Successfully transfered balance(s).

400

Invalid request.

401

Unauthorized access.

500

Service unavailable or server error.

post/v1/transfer
Request samples
application/json
{
  • "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
  • "balance_transfer_type": "payout_token_conversion_reversal",
  • "transfer_items": [
    ],
  • "reference_type": "invoicing.token_exchange.id",
  • "reference_id": "vtok_2Acn1Y46LaM9csSoEWYqUyESwi7",
  • "description": "Payout token conversion reversal",
  • "metadata": {
    }
}
Response samples
application/json
{
  • "status": "Success",
  • "message": [ ],
  • "codes": [ ],
  • "payload": {
    }
}