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

# Check Returned

> Fired when an issued check is returned.



## AsyncAPI

````yaml specs/asyncapi-notify-v3.yaml TransactionRecipientPaymentStatusCheckReturned
id: TransactionRecipientPaymentStatusCheckReturned
title: Check Returned
description: Fired when an issued check is returned.
servers:
  - id: webhook
    protocol: https
    host: your-webhook-endpoint.example.com
    bindings: []
    variables: []
address: transaction.recipient.payment.status.check.returned
parameters: []
bindings: []
operations:
  - &ref_0
    id: receiveTransactionRecipientPaymentStatusCheckReturned
    title: Receive transaction recipient payment status check returned
    description: Check Returned
    type: receive
    messages:
      - &ref_1
        id: TransactionRecipientPaymentStatusCheckReturnedMessage
        contentType: application/json
        payload:
          - name: Check Returned
            type: object
            properties:
              - name: metadata
                type: object
                description: Delivery metadata present on every webhook event.
                required: true
                properties:
                  - name: id
                    type: string
                    description: >-
                      Ingo-assigned unique ID for this delivery. Use as your
                      idempotency key to deduplicate retries.
                    required: true
                  - name: topic
                    type: string
                    description: Topic name identifying the event type.
                    required: true
                  - name: topic_description
                    type: string
                    description: Human-readable description of the event.
                    required: true
                  - name: timestamp
                    type: integer
                    description: Unix timestamp of the webhook delivery.
                    required: true
                  - name: version
                    type: string
                    description: Payload contract version.
                    required: true
              - name: data
                type: object
                required: true
                properties:
                  - name: ancillary
                    type: object
                    description: >-
                      Transaction correlation identifiers for Notify webhook
                      events. Use these fields to match the event to a
                      transaction in your system.
                    required: true
                    properties:
                      - name: notification_id
                        type: string
                        description: >-
                          Ingo-assigned unique identifier for the staged
                          notification.
                        required: true
                      - name: session_id
                        type: string
                        description: Ingo-assigned session identifier, when applicable.
                        required: false
                      - name: participant_unique_id1
                        type: string
                        description: >-
                          Your primary correlation ID from the original Notify
                          request.
                        required: true
                      - name: participant_unique_id2
                        type: string
                        description: Your optional secondary correlation ID.
                        required: false
                      - name: party_id
                        type: string
                        description: >-
                          Ingo-assigned ID for the specific party this event
                          relates to. Present on multi-party (Notify v4) events.
                        required: false
                  - name: event
                    type: object
                    required: true
                    properties:
                      - name: status
                        type: string
                        description: Numeric status code for the event outcome.
                        required: true
                      - name: client_message
                        type: string
                        description: Human-readable description of the event outcome.
                        required: true
                      - name: attempt_count
                        type: integer
                        description: >-
                          Current delivery attempt number. Present when the
                          event type has a configurable attempt counter.
                        required: false
                      - name: max_attempts
                        type: integer
                        description: >-
                          Maximum allowed attempts. Present when the event type
                          has a configurable attempt counter.
                        required: false
                      - name: check_number
                        type: string
                        description: Check serial number.
                        required: true
                      - name: check_amount
                        type: string
                        description: Check amount.
                        required: true
                      - name: reason_code
                        type: string
                        description: Reason code for the check action.
                        required: true
                      - name: reason_description
                        type: string
                        description: Description of the reason code.
                        required: false
        headers: []
        jsonPayloadSchema:
          type: object
          required:
            - metadata
            - data
          properties:
            metadata:
              type: object
              required:
                - id
                - topic
                - topic_description
                - timestamp
                - version
              description: Delivery metadata present on every webhook event.
              properties:
                id:
                  type: string
                  maxLength: 50
                  description: >-
                    Ingo-assigned unique ID for this delivery. Use as your
                    idempotency key to deduplicate retries.
                  example: prod01-6aaa3079-c1ff-4cae-b77a-4b76026fc846
                  x-parser-schema-id: <anonymous-schema-2>
                topic:
                  type: string
                  maxLength: 150
                  description: Topic name identifying the event type.
                  x-parser-schema-id: <anonymous-schema-3>
                topic_description:
                  type: string
                  maxLength: 250
                  description: Human-readable description of the event.
                  x-parser-schema-id: <anonymous-schema-4>
                timestamp:
                  type: integer
                  description: Unix timestamp of the webhook delivery.
                  example: 1777509495
                  x-parser-schema-id: <anonymous-schema-5>
                version:
                  type: string
                  maxLength: 5
                  description: Payload contract version.
                  example: '1'
                  x-parser-schema-id: <anonymous-schema-6>
              x-parser-schema-id: WebhookMetadata
            data:
              type: object
              required:
                - ancillary
                - event
              properties:
                ancillary:
                  type: object
                  required:
                    - notification_id
                    - participant_unique_id1
                  description: >-
                    Transaction correlation identifiers for Notify webhook
                    events. Use these fields to match the event to a transaction
                    in your system.
                  properties:
                    notification_id:
                      type: string
                      maxLength: 15
                      description: >-
                        Ingo-assigned unique identifier for the staged
                        notification.
                      example: '10042781'
                      x-parser-schema-id: <anonymous-schema-8>
                    session_id:
                      type: string
                      maxLength: 50
                      nullable: true
                      description: Ingo-assigned session identifier, when applicable.
                      x-parser-schema-id: <anonymous-schema-9>
                    participant_unique_id1:
                      type: string
                      maxLength: 100
                      description: >-
                        Your primary correlation ID from the original Notify
                        request.
                      x-parser-schema-id: <anonymous-schema-10>
                    participant_unique_id2:
                      type: string
                      maxLength: 100
                      nullable: true
                      description: Your optional secondary correlation ID.
                      x-parser-schema-id: <anonymous-schema-11>
                    party_id:
                      type: string
                      maxLength: 36
                      nullable: true
                      description: >-
                        Ingo-assigned ID for the specific party this event
                        relates to. Present on multi-party (Notify v4) events.
                      x-parser-schema-id: <anonymous-schema-12>
                  x-parser-schema-id: NotifyCorrelation
                event:
                  allOf:
                    - type: object
                      required:
                        - status
                        - client_message
                      description: >-
                        Core event outcome fields present on every webhook
                        event. Additional event-specific properties may be
                        present — see the individual event documentation for the
                        complete schema.
                      properties:
                        status:
                          type: string
                          maxLength: 10
                          description: Numeric status code for the event outcome.
                          x-parser-schema-id: <anonymous-schema-13>
                        client_message:
                          type: string
                          maxLength: 250
                          description: Human-readable description of the event outcome.
                          x-parser-schema-id: <anonymous-schema-14>
                        attempt_count:
                          type: integer
                          description: >-
                            Current delivery attempt number. Present when the
                            event type has a configurable attempt counter.
                          example: 1
                          x-parser-schema-id: <anonymous-schema-15>
                        max_attempts:
                          type: integer
                          description: >-
                            Maximum allowed attempts. Present when the event
                            type has a configurable attempt counter.
                          example: 3
                          x-parser-schema-id: <anonymous-schema-16>
                      x-parser-schema-id: WebhookEventBase
                    - type: object
                      required:
                        - check_number
                        - check_amount
                        - reason_code
                      description: Check transaction status with reason.
                      properties:
                        check_number:
                          type: string
                          maxLength: 10
                          description: Check serial number.
                          x-parser-schema-id: <anonymous-schema-144>
                        check_amount:
                          type: string
                          maxLength: 10
                          description: Check amount.
                          x-parser-schema-id: <anonymous-schema-145>
                        reason_code:
                          type: string
                          maxLength: 10
                          description: Reason code for the check action.
                          x-parser-schema-id: <anonymous-schema-146>
                        reason_description:
                          type: string
                          maxLength: 250
                          description: Description of the reason code.
                          x-parser-schema-id: <anonymous-schema-147>
                      x-parser-schema-id: EventCheckWithReason
                  x-parser-schema-id: <anonymous-schema-153>
              x-parser-schema-id: <anonymous-schema-152>
          x-parser-schema-id: <anonymous-schema-151>
        title: Check Returned
        example: |-
          {
            "metadata": {
              "version": "1",
              "topic_description": "This event indicates that a check transaction has been returned due to positive pay exception",
              "timestamp": 1748633972,
              "topic": "transaction.recipient.payment.status.check.returned",
              "id": "prod1-123456-abcd-1234-ab12-c123d456e789"
            },
            "data": {
              "ancillary": {
                "participant_unique_id2": "111111111-2222-3333333-4444444444",
                "session_id": "",
                "notification_id": "1000001",
                "participant_unique_id1": "22222222-5555-3333333-4444444444"
              },
              "event": {
                "status": "1114",
                "check_amount": "1500.00",
                "client_message": "Payment Returned by Issuer",
                "check_number": "1010101010",
                "reason_code": "83"
              }
            }
          }
        bindings: []
        extensions:
          - id: x-parser-unique-object-id
            value: TransactionRecipientPaymentStatusCheckReturnedMessage
    bindings: []
    extensions:
      - id: x-parser-unique-object-id
        value: TransactionRecipientPaymentStatusCheckReturned
sendOperations:
  - *ref_0
receiveOperations: []
sendMessages:
  - *ref_1
receiveMessages: []
extensions:
  - id: x-parser-unique-object-id
    value: TransactionRecipientPaymentStatusCheckReturned
securitySchemes: []

````