---
title: "Card Added Successfully Webhook"
source_url: https://docs.rapyd.net/en/card-added-successfully-webhook.html
lang: en
---

# Card Added Successfully Webhook

The **CARD_ADDED_SUCCESSFULLY** webhook is sent when adding a card payment method to a customer succeeds.

> **Note:**
>
> The endpoint for webhooks is unique for each client. To set up a webhook endpoint, see [Defining a Webhook Endpoint](https://docs.rapyd.net/en/defining-a-webhook-endpoint.md "Defining a Webhook Endpoint").

### Parameters

### Webhook Header Parameters

- - Content-Type
  - Indicates that the data appears in JSON format. Set to **application/json**.
- - salt
  - Random string.
- - signature
  - Signature calculated for each webhook individually.

    See [Webhook Authentication](https://docs.rapyd.net/en/webhook-authentication.md "Webhook Authentication").
- - timestamp
  - Timestamp for the webhook, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") (seconds).

### Webhook Root Parameters

- - created_at
  - Time that the webhook was created, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "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](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "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_name_inquiry
  - Data about the account name inquiry (ANI).

    - - account_name_inquiry_result
      - Result of the account name inquiry. One of the following values:

        - **match** - Indicates that the name provided in the request fully matched the issuing bank's records.
        - **partial match** - Indicates that the name provided in the request partially matched the issuing bank's records.
        - **no match** - Indicates that the name provided in the request did not match the issuing bank's records.
        - **not performed** - Indicates that the account name inquiry was not performed.
        - **not supported** - Indicates that the payment method does not support account name inquiries.
    - - account_name_inquiry_details
      - Indicates the degree that the name provided in the request matched the issuing bank's records.

        - - first_name
          - Indicates the result of matching the cardholder's given name. One of the following values:

            - **match** - Indicates that the first name provided in the request fully matched the first name in the issuing bank's records.
            - **partial match** - Indicates that the first name provided in the request partially matched the first name in the issuing bank's records.
            - **no match** - Indicates that first the name provided in the request did not match the first name in the issuing bank's records.
        - - middle_name
          - indicates the result of matching the cardholder's middle name. One of the following values:

            - **match** - Indicates that the middle name provided in the request fully matched the middle name in the issuing bank's records.
            - **partial match** - Indicates that the middle name provided in the request partially middle the first name in the issuing bank's records.
            - **no match** - Indicates that the middle name provided in the request did not match the middle name in the issuing bank's records.
        - - last_name
          - indicates the result of matching the cardholder's family name. One of the following values:

            - **match** - Indicates that the last name provided in the request fully matched the family name in the issuing bank's records.
            - **partial match** - Indicates that the last name provided in the request partially matched the family name in the issuing bank's records.
            - **no match** - Indicates that the last name provided in the request did not match the family name in the issuing bank's records.
- - acs_check
  - Results of the [Access Control Server (ACS)](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_acs "Access Control Server") check. Possible values:

    - **pass**
    - **fail**
    - **unavailable**
    - **unchecked**

    Relevant to cards.
- - 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.
    - - issuer
      - Business name of the bank that issued the card.
    - - level
      - Type of card as categorized by the issuer.
    - - type
      - The type of the card:

        - **credit**
        - **debit**
        - **prepaid**
- - category
  - Category of payment method. One of the following:

    - **bank_redirect**
    - **bank_transfer**
    - **card**
    - **card_redirect**
    - **cash**
    - **ewallet**
    - **ewallet_redirect**
- - cvv_check
  - Verification of the card’s CVV. Valid values:

    - **pass**
    - **fail**
    - **unavailable**
    - **unchecked**
- - error_code
  - Error reported by the Rapyd platform.

    Relevant to **Card Added Failure** webhook.
- - 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.
- - full_name
  - Full name of the cardholder, as submitted for account name inquiry (ANI).

    - - first_name
      - The cardholder's given name.
    - - middle_name
      - The cardholder's middle name.
    - - last_name
      - The cardholder's family 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.
- - last4
  - Last four digits of the card or IBAN (International Bank Account Number).
- - metadata
  - A JSON object defined by the client. See [Metadata](https://docs.rapyd.net/en/metadata.md "Metadata").
- - name
  - Full name of the customer.
- - network_reference_id
  - Identifier for use in a recurring card payment.
- - 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.
    - **pending_offline_capture** - The next action is pending an offline capture, where the payment settles to a **closed** (**CLO**) status via the clearing process. A payment in this state can be successfully refunded, **but cannot be canceled**. Currently, relevant only to Shva Arena card payments.
    - **not_applicable** - The payment has completed or the next action is not relevant.
- - payment_account_reference
  - [Payment account reference (PAR)](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_par "Payment Account Reference"). A unique identifier for a payment account. Each [primary account number (PAN)](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_pan "Primary Account Number") associated with the same payment account has the same PAR.

    For example, when a card is renewed or replaced, it gets a new PAN but the PAR remains the same.
- - 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](https://docs.rapyd.net/en/list-payment-methods-by-country.md "List Payment Methods by Country").
- - webhook_url
  - Reserved.

- CARD_ADDED_SUCCESSFULLY
- ```json
  {
      "token": "wh_641d85ccab0dc07cb0cd3597aa25df05",
      "type": "CARD_ADDED_SUCCESSFULLY",
      "data": {
          "id": null,
          "type": "gb_amex_card",
          "category": "card",
          "metadata": {},
          "image": "",
          "webhook_url": "",
          "supporting_documentation": "",
          "next_action": "3d_verification",
          "full_name": {
              "first_name": "John",
              "middle_name": "Johnson",
              "last_name": "Doe"
          },
          "account_name_inquiry": {
              "account_name_inquiry_result": "not_performed",
              "account_name_inquiry_details": {
                  "last_name": null,
                  "first_name": null,
                  "middle_name": null
              }
          },
          "name": "John Doe",
          "last4": "1111",
          "acs_check": "unchecked",
          "cvv_check": "unchecked",
          "bin_details": {
              "type": "DEBIT",
              "brand": "VISA",
              "level": "CLASSIC",
              "issuer": "CONOTOXIA SP. Z O.O",
              "country": "PL",
              "bin_number": "411111"
          },
          "expiration_year": "30",
          "expiration_month": "12",
          "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
          "network_reference_id": 941438,
          "payment_account_reference": "V0012EE8QZTYHJVNHT4L2FOZXDHJS"
      },
      "attempts": [],
      "status": "ERR",
      "last_attempt_at": 1763019227,
      "created_at": 1763019075,
      "next_attempt_at": 1763019226000
  }
  ```
