Sign in

v47

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-013871777.1 KB
Return

Create a return

Creates a return for a deposit.

post/api/service/return/create

Request body

depositIdstring uuid required

The ID of the associated deposit

Response

Return created successfully

idstring uuid required

The ID of the return

depositIdstring uuid required

The ID of the associated deposit

transactionIdstring uuid

The ID of the resulting return transaction

status'initiated' | 'succeeded' | 'failed' | 'returned' required

The status of the return

amountnumber required

The amount of the return

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

The currency of the return

createdAtstring date-time required

The date and time the return was created

failedAtstring date-time

The date and time the return failed if applicable

succeededAtstring date-time

The date and time the return succeeded if applicable