Skip to main content
POST
Reverse Standalone Transfer
Fully or partially reverse a PLATFORM_TO_RECIPIENT transfer, subject to its status and remaining reversible amount. A RECIPIENT_TO_PLATFORM parent cannot be reversed: both full and partial reversal requests return 400 INVALID_PARAMETERS. To return a separately collected fee, create a new transfer with direction: PLATFORM_TO_RECIPIENT. The reversal HTTP response describes the parent after the reversal and does not include direction. Use GET to read the unchanged parent direction. The reversal notification includes the parent’s PLATFORM_TO_RECIPIENT direction.

Authorizations

PUBLIC-API-KEY
string
header
required
PRIVATE-SECRET-KEY
string
header
required

Headers

X-Idempotency-Key
string
required

Unique key for request idempotency.

Path Parameters

transfer_id
string
required

The unique ID of the transfer flow to reverse.

Body

application/json
account_id
string
required

The unique identifier of the account.

amount
object
reason
string

The reason for the reversal.

description
string

A human-readable description for the reversal.

merchant_reference
string

Merchant's unique identifier for tracking this reversal.

Response

Reversal processed

The parent transfer after a reversal. Direction is available through GET, not this response.

id
string
Example:

"550e8400-e29b-41d4-a716-446655440000"

recipient_id
any
amount
any
status
string
Example:

"REVERSED_PARTIAL"

reason
any
description
any
merchant_reference
any
provider_data
object | null
created_at
any
updated_at
any
transactions
any