v25

OpenAPI 3.1.0raw.githubusercontent.com2026-08-014254240.1 KB

Returns

Create return

Initiates a return of funds from a deposit to the source.

post/v1/returns

Headers

Idempotency-Keystring

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Request body

deposit_idstring uuid required

Deposit to return funds from.

rail'sepa_instant' | 'sepa' | 'faster_payments'

Payment rail when the deposit allows multiple schemes.

Response

Success

idstring uuid required

Unique identifier of the return.

type'return' required

Type of the resource.

status'pending' | 'paid' | 'failed' | 'returned' required

Current status of the return.

deposit_idstring uuid required

ID of the parent deposit.

amountstring required

Amount as a string decimal (e.g. "100.50").

currency'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL' required

Currency code (ISO 4217 currency code or crypto currency code).

created_atstring date-time required

ISO 8601 UTC timestamp when the return was created.

updated_atstring date-time required

ISO 8601 UTC timestamp when the return was last updated.