Customer Payment Method Created Webhook

The CUSTOMER_PAYMENT_METHOD_CREATED webhook is sent when a payment method is added to a customer.

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 or IBAN (International Bank Account Number).
- address
- Describes the address associated with this payment method.
  canton
  Name of the canton administrative subdivision, as used in banking.
  city
  City portion of the address.
  country
  The two-letter ISO 3166-1 ALPHA-2 code for the country.
  created_at
  Time of creation of the object, in Unix time.
  district
  Name of the district administrative subdivision, as used in banking.
  id
  ID of the address object.
  line_1
  Line 1 of the address, such as a building number and street name.
  line_2
  Line 2 of the address, such as a suite or apartment number, or the name of a named building.
  line_3
  Line 3 of the address.
  metadata
  A JSON object defined by the client. See Metadata.
  name
  The name of a contact person or an "in care of" person at this address. For a personal wallet contact, alphabetic characters and spaces.
  phone_number
  Phone number associated with this specific address in E.164 format. Must be unique.
  state
  State or province portion of the address.
  zip
  Postal code portion of the address.
- bic_swift
- BIC (Bank Identifier Code)/SWIFT code.
- category
- Category of payment method. One of the following:
  bank_redirect
  bank_transfer
  card
  card_to_card
  cash
  ewallet
  rapyd_ewallet
- id
- ID of the Payment Method object. String starting with card_ or other_.
- image
- A URL to the image of the icon for the type of payment method.
- metadata
- A JSON object defined by the client. See Metadata.
- 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.
- 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.

CUSTOMER_PAYMENT_METHOD_CREATED Webhook

{
  "id": "wh_90957fbb254942810b1dd7061ff0efe5",
  "type": "CUSTOMER_PAYMENT_METHOD_CREATED",
  "data": {
    "id": "other_237dbb04acfa1f11e81d721f4d3d11ce",
    "type": "gb_trustly_bank",
    "image": "",
    "category": "bank_redirect",
    "metadata": {
      "merchant_defined": true
    },
    "bic_swift": "",
    "next_action": "not_applicable",
    "webhook_url": "",
    "account_last4": "",
    "supporting_documentation": ""
  },
  "trigger_operation_id": "c7d2b425-8fe8-4dc7-b6e0-52e1be0dede9",
  "status": "NEW",
  "created_at": 1655293386,
  "extended_timestamp": 1655293386305
}

In this section:

Documentation

Customer Payment Method Created Webhook

Note

Parameters

Webhook Header Parameters

Webhook Root Parameters

Note

Note

Note

Webhook Data Parameters

Search results