Refund Updated Webhook

The PAYMENT_REFUND_UPDATED webhook is sent when there is an update to a refund.

Parameters

Webhook Header Parameters

Webhook Root Parameters

- created_at
- Time that the webhook was created, in Unix time.
  Nota
  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.
- 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.
  Nota
  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.
  Nota
  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
  - Empty string
- 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.
- 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.
- merchant_ewallet
- As a Payment Facilitator (PayFac), you can create a card payment and direct the funds that the sub-merchant collects to your client wallet.
  Relevant to a PayFac.
- metadata
- A JSON object defined by the client. See Metadata.
- 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 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.

PAYMENT_REFUND_UPDATED Webhook

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "d64555ae-0047-488c-8576-886774859801"
    },
    "data": {
        "token": "wh_2a4c48b11bc3bde18ff3cd8c042e938e",
        "type": "PAYMENT_REFUND_UPDATED",
        "data": {
            "id": "refund_0f28306bcfb86b2ffdd2951fd754de29",
            "amount": 10,
            "payment": "payment_fdfba86046b46c9a60fa211c6adc9520",
            "currency": "PLN",
            "failure_reason": "",
            "failure_code": "",
            "metadata": {},
            "reason": "Returned",
            "status": "Rejected",
            "receipt_number": 0,
            "created_at": 1764586185,
            "updated_at": 1764587420,
            "merchant_ewallet": null,
            "merchant_reference_id": "",
            "payment_created_at": 1764586120,
            "payment_method_type": "cee_visa_card",
            "ewallets": [
                {
                    "ewallet": "ewallet_6f288d7c178f545ebb56be8990ff0ff2",
                    "amount": 10
                }
            ],
            "proportional_refund": true,
            "merchant_debited_amount": null,
            "merchant_debited_currency": null,
            "fx_rate": null,
            "fixed_side": null
        },
        "attempts": [],
        "status": "CLO",
        "last_attempt_at": 1764587420,
        "created_at": 1764587420,
        "next_attempt_at": 0
    }
}

En esta sección:

Documentación

Refund Updated Webhook

Parameters

Webhook Header Parameters

Webhook Root Parameters

Nota

Nota

Nota

Webhook Data Parameters

Resultados de la búsqueda