Initiate Entity Transfer (Banking Connectivity)

post

https://api-sandbox.y.uno/v1/banking/transfers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Initiate an outgoing transfer from a Banking Connectivity account. For external transfers, provide the destination_account details. For internal (book) transfers between accounts on the same provider, set destination_account_id to the target account.

The required fields in destination_account depend on the region. See Payment rails and Account identifiers by region for details.

The response returns 202 Accepted with a PENDING status. Monitor progress via Get Entity Transfer Status or webhook events. See Transfer statuses for the full status lifecycle.

Body Params

account_id

string

required

The unique identifier of the merchant's Yuno account (UUID, 36 characters).

source_account_id

string

required

The id of the source Banking Connectivity account obtained from Create Account.

destination_account_id

string | null

The id of the destination Banking Connectivity account for internal (book) transfers. Set to null for external transfers.

direction

string

enum

required

The transfer direction.

Allowed:

amount

object

required

The transfer amount. Currency must match the source account currency.

payment_rail

string

enum

required

The payment rail to use for the transfer. Available rails depend on the provider region.

description

string

A description for the transfer.

merchant_transfer_id

string

The merchant's own reference ID for reconciliation.

destination_account

object

required

The external destination account details. Required fields depend on the region: US requires account_number and routing_number; UK requires iban or account_number with sort_code; Australia requires account_number with bsb.

Headers

x-idempotency-key

string

required

Unique identifier used in HTTP headers to ensure that a request is processed only once, even if it is retried due to network issues or timeouts. See authentication for details (UUID).

Responses

Language

Credentials

Loading…

Response

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

application/json

202Accepted

400Bad Request

404Not Found