Skip to main content
POST
Initiate a transfer

Authorizations

X-Yara-API-Key
string
header
required

Your Yara API key. Send it in the X-Yara-API-Key header.

Headers

X-Idempotency-Key
string
required

Idempotency key

Body

application/json

Transfer creation request

quote_id
string
Example:

"0e0f7b9c-f47b-4f42-b56e-991b8f7a1cb3"

reference
string
Example:

"merchant-transfer-001"

Response

Accepted

data
object
required
error
string
required
message
string
required
Example:

"resource retrieved"

status
enum<string>
required
Available options:
success
Example:

"success"