Refund Completed Webhook

The REFUND_COMPLETED webhook is sent when a refund is completed.

Parameters

Webhook Header Parameters

Webhook Root Parameters

- created_at
- Time that the webhook was created, in Unix time.
  Note
  Inside the data object, some webhooks have another created_at field that refers to a different event.
- data
- Contains the actual data of the webhook.
  For details, see below.
- extended_timestamp
- Time in milliseconds that the webhook was created, in Unix time.
  Note
  Sandbox only.
- id
- ID of the webhook. String starting with wh_.
- status
- Status of the webhook. One of the following:
  - NEW
  - CLO - Closed.
  - ERR - Error.
  - RET - Re-sent.
  Note
  Inside the data object, some webhooks have another status field that refers to a different event.
- trigger_operation_id
- ID of the operation that triggered the webhook. UUID.
- type
- Name of the webhook type.
  Note
  The name in the Client Portal is different.

Webhook Data Parameters

- amount
- Amount of the refund, in units defined by currency in the original payment.
- created_at
- Time of creation of this refund, in Unix time.
- currency
- The currency of the amount received by the original payment source. Three-letter ISO 4217 code.
- ewallets
- Array of objects that define the allocation of the refund to multiple wallets.
  ewallet
  ID of the wallet, a string starting with ewallet_.
  amount
  The amount refunded to this wallet. Relevant when percentage is not set.
  percentage
  The percentage of this payment refunded to this wallet. Relevant when amount is not set.
- failure_reason
- Indicates the reason that the refund failed. One of the following:
  - lost_or_stolen_card
  - expired_or_canceled_card
  - unknown
- fixed_side
- Indicates which side of the transaction the FX rate is fixed for. Relevant for refunds with foreign exchange. One of the following values:
  - buy
  - sell
- fx_rate
- Exchange rate for the transaction.
  - When fixed_side is buy, fx_rate is the buy rate.
  - When fixed_side is sell, fx_rate is the sell rate.
  Decimal number as string. Relevant to refunds with foreign exchange.
- id
- ID of the refund object. String starting with refund_.
- merchant_reference_id
- Identifier defined by the client for reference purposes. Limit: 45 characters.
- metadata
- A JSON object defined by the client. See Metadata.
- merchant_debited_amount
- Amount debited from the merchant. Relevant to refunds with foreign exchange.
- merchant_debited_currency
- Indicates the currency that is debited from the merchant. Three-letter ISO 4217 code. Relevant to refunds with foreign exchange.
- payment
- ID of the payment object that the refund is credited against. String starting with payment_.
- payment_created_at
- Time that the original payment was created, in Unix time.
- payment_method_type
- The original payment payment method type. Use List Payment Methods by Country for a list of supported types for a country.
- proportional_refund
- Indicates whether the refund was returned in proportion to the amounts received by the wallets in the payment. Relevant to a refund for a payment split among multiple wallets.
- reason
- Description of the reason for the refund, provided by the merchant.
- receipt_number
- Number of the receipt for the refund, provided by the merchant.
- status
- Indicates the status of the refund operation. One of the following values:
  - Completed - The refund was complete.
  - Error - The refund failed since the payment object on which the refund is based is not in closed status.
  - Rejected - The refund was rejected by the specific payment processor for this payment.
  - Pending - The request created a refund object on the Rapyd platform, but the refund is not yet complete. For example, the refund is for a payment method that requires a customer action, such as cash, bank redirect or bank transfer.
- - updated_at
  - Time that this refund was last updated, in Unix time.

REFUND_COMPLETED Webhook

{
    "id": "wh_579ce0fff755360a834881dd26f5502a",
    "type": "REFUND_COMPLETED",
    "data": {
        "id": "refund_222febd9394bfe5d55f8586a98974e9c",
        "amount": 1025,
        "reason": "Merchandise returned",
        "status": "Completed",
        "fx_rate": null,
        "payment": "payment_8775855f7a472b3a07c5894d2badb532",
        "currency": "USD",
        "ewallets": [{
                "amount": 1025,
                "ewallet": "ewallet_c1943cfeda5f98247ab117e5d2648861"
            }
        ],
        "metadata": null,
        "created_at": 1641219206,
        "fixed_side": null,
        "updated_at": 1641219206,
        "failure_reason": "",
        "receipt_number": 0,
        "payment_created_at": 1641214597,
        "payment_method_type": "us_visa_card",
        "proportional_refund": true,
        "merchant_reference_id": "refund_222febd9394bfe5d55f8586a98974e9c",
        "merchant_debited_amount": null,
        "merchant_debited_currency": null
    },
    "trigger_operation_id": "571bd6ab-a6ce-446f-8f42-5b2542f140cb",
    "status": "NEW",
    "created_at": 1641219206,
    "extended_timestamp": 1641219206389
}

In this section:

Documentation

Refund Completed Webhook

Parameters

Webhook Header Parameters

Webhook Root Parameters

Note

Note

Note

Note

Webhook Data Parameters

Search results