> ## Documentation Index
> Fetch the complete documentation index at: https://docs.augustus.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat the published Augustus OpenAPI specification (https://api.augustus.com/openapi/2026-05-01.json) and the current API-reference pages as the source of truth for endpoints, request/response schemas, enum values, webhook event names, and required headers.
> Prefer the 2026-05-01 Banking API and @augustusbank/typescript-sdk for all new integrations. The 2023-01-01 API is a separate surface covering the Pay by Bank products — Instant Bank Transfer (Open Banking) checkout and refunds, and Manual Bank Transfer (MBT); use it when one of those products is required.
> Cite or link the relevant docs.augustus.com page when answering integration questions.
> Do not infer support for currencies, networks, scopes, account types, or operations that are not present in the current documentation.
> Use the sandbox base URL (https://api.sandbox.augustus.com) and placeholder credentials in examples. Never include or request a real API key.
> The Augustus docs MCP server (https://docs.augustus.com/mcp) provides documentation search and retrieval only; it does not execute authenticated Augustus API actions.

# return.succeeded

> A return has succeeded



## OpenAPI

````yaml https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/return.succeeded
openapi: 3.0.0
info:
  title: Ivy Webhook Events
  description: Ivy Webhook Events schema
  version: '1.0'
  contact:
    name: Ivy
    url: https://www.getivy.io
    email: help@getivy.io
servers: []
security: []
tags: []
paths:
  /api/service/webhook-event/return.succeeded:
    post:
      tags:
        - WebhookEventExamples
        - Return
      summary: return.succeeded
      description: A return has succeeded
      operationId: WebhookEventExamplesController_returnSucceeded
      parameters: []
      requestBody:
        required: true
        description: Data of the webhook event
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnSucceededWebhookEventDto'
      responses:
        '200':
          description: OK
      servers:
        - url: https://{yourDomain}
          variables:
            yourDomain:
              description: The URL where you want to receive webhook events
              default: www.your-domain.com
components:
  schemas:
    ReturnSucceededWebhookEventDto:
      type: object
      properties:
        id:
          type: string
          description: The unique id for the webhook.
        type:
          type: string
          enum:
            - return.succeeded
        date:
          type: string
          description: The date of the webhook.
        payload:
          type: object
          properties:
            id:
              type: string
              format: uuid
              pattern: >-
                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
              description: The ID of the return
            depositId:
              type: string
            transactionId:
              type: string
            status:
              type: string
              enum:
                - initiated
                - succeeded
                - failed
                - returned
              description: The status of the return
            amount:
              type: number
              description: The amount of the return
            currency:
              type: string
              enum:
                - EUR
                - GBP
                - PLN
                - SEK
                - DKK
                - USD
                - USDC
                - BTC
                - ETH
                - SOL
                - POL
              description: The currency of the return
            createdAt:
              type: string
              format: date-time
              pattern: >-
                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
              description: The date and time the return was created
            failedAt:
              description: The date and time the return failed if applicable
              type: string
              format: date-time
              pattern: >-
                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
            succeededAt:
              type: string
              format: date-time
            returnId:
              type: string
              description: 'Deprecated: use id instead'
            value:
              type: object
              properties:
                currency:
                  type: string
                  description: 'Deprecated: use currency instead'
                amount:
                  type: string
                  description: 'Deprecated: use amount instead'
              required:
                - currency
                - amount
          required:
            - id
            - depositId
            - status
            - amount
            - currency
            - createdAt
            - succeededAt
            - returnId
            - value
          description: The successfully succeeded return data.
      required:
        - id
        - type
        - date
        - payload

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.