---
title: "Create return"
method: POST
path: "/v1/returns"
tags: ["Returns"]
---

# Create return

`POST /v1/returns`

## Request

- Base URL: `https://api.augustus.com`
- URL: `https://api.augustus.com/v1/returns`
- Auth: HTTP bearer

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

## Headers

- `Idempotency-Key` string, required

## Request body

- CreateReturnBodyDto
  - `deposit_id` string, uuid, required: Deposit to return funds from.
  - `metadata` object, nullable: Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.

## Response `200`

Success

- ReturnResourceDto
  - `id` string, uuid, required: Unique identifier of the return.
  - `type` 'return', required: Resource type discriminator.
  - `status` 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned', required: Current status of the return.
  - `deposit_id` string, uuid, required: ID of the parent deposit.
  - `amount` string, required: Amount as a string decimal (e.g. "100.50").
  - `currency` 'EUR' | 'GBP' | 'USD' | 'USDC', required: Currency code (ISO 4217 or crypto).
  - `failure` object, nullable, required: Failure details when status is failed, otherwise null.
    - `code` 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown', required: Failure code.
    - `message` string, required: Human-readable description of the failure.
    - `retry` boolean, required: Whether the return can be retried.
  - `initiated_at` string, date-time, required: ISO 8601 UTC timestamp when the return was initiated.
  - `sent_at` string, date-time, nullable, required: ISO 8601 UTC timestamp when the return was sent.
  - `tx_hash` string, nullable, required: Transaction hash for crypto returns, or null when not known. Only blockchain rails support this field.
  - `rail` 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | 'null', nullable, required: Payment scheme or blockchain used for the return, or null when unknown.
  - `metadata` object, required: Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.

## Changes

- **2026-10-16** `f7ded6c181ab`: 1 info
  - endpoint added
- **2026-08-26** `ca35cff0b637`: 2 warning
  - removed the request property `rail`
  - added the new `submitted` enum value to the `status` response property for the response status `200`
- **2026-08-21** `79d607871de9`: 3 breaking, 3 warning, 8 info
  - the request property `rail` became required
  - removed the required property `created_at` from the response with the `200` status
  - removed the required property `updated_at` from the response with the `200` status
  - added the new `initiated` enum value to the `status` response property for the response status `200`
  - …10 more
- **2026-08-17** `3ed0a0aba68b`: 4 info
  - removed the `BTC` enum value from the `currency` response property for the response status `200`
  - removed the `ETH` enum value from the `currency` response property for the response status `200`
  - removed the `POL` enum value from the `currency` response property for the response status `200`
  - removed the `SOL` enum value from the `currency` response property for the response status `200`
- **2026-07-27** `1d6de495a31d`: 1 breaking
  - the `header` request parameter `Idempotency-Key` became required

[Operation history](https://skmtc.dev/augustus/apis/ivy-api/changes/v1/returns/post.md)

---

[API](https://skmtc.dev/augustus/apis/ivy-api.md) - [All operations](https://skmtc.dev/augustus/apis/ivy-api/llms.txt) - [OpenAPI document](https://skmtc.dev/augustus/apis/ivy-api/revisions/e87bdcac11cc?raw)