Skip to main content
POST
cURL
Enables marketplaces using Yuno Split Payments to request a transfer based on an existing payment. Request a transfer for a specified amount to one of the recipients participating in the split. The transaction must carry split_marketplace recipients, because the transfer goes to them. If the transaction has none, the API returns 400 with “Payment has no recipient”. The amount must be less than or equal to the transaction amount and in the payment currency.

Authorizations

public-api-key
string
header
default:<Your public-api-key>
required
private-secret-key
string
header
default:<Your private-secret-key>
required

Headers

X-Idempotency-Key
string

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.

Path Parameters

payment_id
string
required

The unique identifier of the payment (MAX 64; MIN 36).

transaction_id
string
required

The unique identifier of the transaction (MAX 64; MIN 36).

Body

application/json
amount
object
required

The payment amount (multiple of 0.0001).

description
string

The unique identifier of the transaction (MAX 256; MIN 3).

Response

Created

id
string

The unique identifier of the transfer.

recipient_id
string

The unique identifier of the recipient.

amount
object
status
string

The status of the transfer.

description
string
merchant_reference
string
metadata
any[]
provider
object | null
transactions
object[]
created_at
string<date-time>
updated_at
string<date-time>
completed_at
string<date-time>