Refund Flow

The end-to-end webhook sequence when a settled transaction is later returned to the cardholder.

A refund returns funds to the cardholder after the original transaction has settled. It is processed as its own, separate transaction event — it does not delete or revert the original approved/cleared transaction. A refund can also arrive without referencing an earlier authorization at all (see Non-Standard Transaction Scenarios); the flow below shows the common, referenced case.

Sequence

sequenceDiagram
    participant Cardholder
    participant Merchant
    participant Altery
    participant Partner as Your System

    Cardholder->>Merchant: Presents card / places order
    Merchant->>Altery: Authorization request
    Altery->>Partner: CardAuthorizationRequest (sync, 2s timeout)
    Partner->>Altery: authorize: "true"
    Altery-)Partner: CardTransactionApproved (notification)
    Note over Merchant,Altery: 1-3 days later, or longer
    Merchant->>Altery: Clearing / settlement received
    Altery-)Partner: CardTransactionCleared (notification)
    Note over Cardholder,Merchant: Cardholder returns goods /<br/>merchant issues a refund
    Merchant->>Altery: Refund
    Altery-)Partner: CardTransactionRefunded (notification)

Webhooks in this flow

StepWebhookTypeDescription
1CardAuthorizationRequestRequestSent in real time; your response approves or declines the transaction
2CardTransactionApprovedNotificationSent once the authorization is approved and the transaction is created
3CardTransactionClearedNotificationSent when the processor confirms settlement
4CardTransactionRefundedNotificationSent when a previously approved (and usually settled) transaction is refunded

Amount in this flow

The amount on CardTransactionRefunded is the amount being returned to the cardholder. It is independent of the original authorization or settlement amount — a refund can be partial, and the original transaction is never deleted or reverted by it. See CardTransactionRefunded for the field-level explanation.

A refund is not a reversal: a refund returns funds after settlement, while a reversal (see Reversal flow) cancels an authorization before it ever settles.

See also