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.
- 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_code
- Indicates the reason that the refund failed. See Card Network Errors.
- 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.

REFUND_COMPLETED Webhook

{
  "id": "c73cd65e-988c-473a-8d03-06a15d52a3e7",
  "token": "wh_1abe7fd19f96fe553fc613a1f3ff20ca",
  "organization_id": "df301b60-8a9d-4a5a-a315-39b699230cb1",
  "org_pk": 0,
  "type": "REFUND_COMPLETED",
  "data": {
    "id": "refund_102ae6d1286b07ce8b3768b93eab9a24",
    "amount": 87.36,
    "payment": "payment_ccc04715a1021b821025b8d8c0a0eed8",
    "currency": "ILS",
    "failure_reason": "",
    "failure_code": "",
    "metadata": {},
    "reason": "Direct Refund",
    "status": "Completed",
    "receipt_number": 0,
    "created_at": 1768959,
    "updated_at": 1768960,
    "merchant_ewallet": null,
    "merchant_reference_id": "030016",
    "payment_created_at": 1768958,
    "payment_method_type": "il_mastercard_card",
    "ewallets": [
      {
        "ewallet": "ewallet_cd59fae56ce5b9564ecb52d7f9eb0c37",
        "amount": 87.36
      }
    ],
    "proportional_refund": true,
    "merchant_debited_amount": null,
    "merchant_debited_currency": null,
    "fx_rate": null,
    "fixed_side": null
  },
  "attempts": [],
  "trigger_operation_id": "3567b315-a73c-4415-8206-c598d70ac665",
  "first_attempt_at": 0,
  "last_attempt_at": 0,
  "status": "",
  "created_at": 0,
  "next_attempt_at": 0,
  "uri": ""
}

In this section:

Documentation

Refund Completed Webhook

Parameters

Webhook Header Parameters

Webhook Root Parameters

Note

Note

Note

Webhook Data Parameters

Search results