Payment Method Canceled Webhook

The PAYMENT_METHOD_CANCELED webhook is sent when a customer’s payment method is deleted by the client.

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

- account_last4
- Last four digits of the bank account number or IBAN (International Bank Account Number).
- account_number
- Bank account number.
- acs_check
- Results of the Access Control Server (ACS) check. Possible values:
  - pass
  - fail
  - unavailable
  - unchecked
  Relevant to cards.
- address
- Describes a physical address. For details about the fields of the 'address' object, see Create Address.
- bic_swift
- BIC or SWIFT code.
- bin_details
- Bank identification details. Includes the following fields:
  bin_number
  BIN number of the bank.
  brand
  The brand of the card. For example, Visa.
  country
  Country of the bank that issued the card.
  type
  The type of the card:
  credit
  debit
  prepaid
- category
- Category of payment method. One of the following:
  bank_redirect
  bank_transfer
  card
  card_to_card
  cash
  ewallet
  rapyd_ewallet
- company_name
- Name of the customer's company.
- cvv_check
- Verification of the card’s CVV. Valid values:
  - pass
  - fail
  - unavailable
  - unchecked
- expiration_month
- Month of expiration.
  Relevant to cards.
- expiration_year
- Year of expiration.
  Relevant to cards.
- fingerprint_token
- Hash of the card number, expiration date and CVV.
  Relevant to cards.
- first_name
- Customer's first name.
- id
- ID of the payment method. String starting with card_ or other_.
- image
- A URL to the image of the icon for the type of payment method.
- language
- Determines the default language of the hosted page. For a list of values, see List Supported Languages.
  When this parameter is null, the language of the user's browser is used.
  If the language of the user's browser cannot be determined, the default language is English.
- last4
- Last four digits of the card or IBAN (International Bank Account Number).
- metadata
- A JSON object defined by the client. See Metadata.
- name
- Full name of the customer.
- next_action
- Indicates the next action for completing the payment. One of the following values:
  3d_verification - The next action is 3DS authentication. Relevant only to card payments.
  pending_capture - The next action is pending the capture of the amount. Relevant only to card payments when the amount is not zero.
  pending_confirmation - The next action is pending the confirmation for the payment. Relevant to all payment methods excluding card payment.
  not_applicable - The payment has completed or the next action is not relevant.
- payment_purpose
- Purpose of the transfer, as reported by the payer's bank.
- proof_of_authorization
- Proof of authorization for the bank transfer.
- redirect_url
- URL of the hosted page that is shown to the customer.
- routing_number
- Routing number for the bank transfer.
- supporting_documentation
- Reserved.
- type
- Name of the payment method type. For example, us_mastercard_card.
  To get a list of payment methods for a country, use List Payment Methods by Country.
- webhook_url
- Reserved.

PAYMENT_METHOD_CANCELED Webhook

{
    "id": "wh_456ced2d410245270d2024a388b03c5c",
    "type": "PAYMENT_METHOD_CANCELED",
    "data": {
        "id": "card_0ef22c3b9fa5991a4da957d3dcee2e7b",
        "name": "John Doe",
        "type": "us_visa_card",
        "image": "",
        "last4": "1111",
        "category": "card",
        "metadata": {},
        "acs_check": "unchecked",
        "cvv_check": "unchecked",
        "bin_details": {
            "type": null,
            "brand": null,
            "country": null,
            "bin_number": "411111"
        },
        "next_action": "3d_verification",
        "webhook_url": "",
        "expiration_year": "25",
        "expiration_month": "12",
        "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
        "supporting_documentation": ""
    },
    "trigger_operation_id": "9499efd0-c818-478d-8d44-f96d0a1de2d5",
    "status": "NEW",
    "created_at": 1639052456,
    "extended_timestamp": 1639052456834
}

In this section:

Documentation

Payment Method Canceled Webhook

Note

Parameters

Webhook Header Parameters

Webhook Root Parameters

Note

Note

Note

Webhook Data Parameters

Search results