Customer Deleted Webhook
The CUSTOMER_DELETED webhook is sent when a customer is deleted.
Note
The endpoint for webhooks is unique for each client. To set up a webhook endpoint, see Defining a Webhook Endpoint.
Content-Type
Indicates that the data appears in JSON format. Set to application/json.
salt
Random string.
signature
Signature calculated for each webhook individually.
timestamp
Timestamp for the webhook, in Unix time (seconds).
created_at
Time that the webhook was created, in Unix time.
Note
Inside the
dataobject, some webhooks have anothercreated_atfield 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
dataobject, some webhooks have anotherstatusfield 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.
addresses
Describes the addresses associated with this customer. For details of the fields in the 'address' object, see Create Address.
business_vat_id
The tax ID number of the customer. Relevant when the customer is a business.
category
Category of payment method. One of the following:
bank_redirect
bank_transfer
card
card_to_card
cash
ewallet
rapyd_ewallet
coupon
The ID of a discount coupon that is assigned to this customer. The coupon must use the same currency as the customer's default payment method.
created_at
Time of creation of this customer, in Unix time.
customer
ID of the customer profile, a string starting with cus_.
default_payment_method
The payment method that is used when the
paymentobject or subscription does not specify a payment method. The value must also appear in thepayment_methodslist. The payment method is referenced by itsnamefield.
delinquent
Indicates whether there is currently a failure of an automatic payment that is part of a subscription, or an invoice that was not paid when due.
description
A text description of the customer.
discount
Contains information about the coupon that applies to the customer.
To add a discount to a customer, see Update Customer.
email
Customer's email address. Maximum 512 characters.
ewallet
ID of the wallet that is linked to the customer. String starting with ewallet_.
Each wallet can be associated with only one customer.
fields
Contains the fields that are for the specific payment method.
To determine what fields are required for the payment method, see Get Payment Method Required Fields.
id
ID of the customer profile. String starting with cus_.
invoice_prefix
A custom string that is prefixed to all invoices for this customer.
metadata
A JSON object defined by the client. See Metadata.
name
The 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_methods
An object containing the following fields:
data
A list of up to three payment methods.
acs_check
Results of the Access Control Server (ACS) check. Possible values:
pass
fail
unavailable
unchecked
Relevant to cards.
address
Address of the customer.
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
addressobject.
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.
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
cvv_check
Verification of the card’s CVV. Valid values:
pass
fail
unavailable
unchecked
fingerprint_token
Hash of the card number, expiration date and CVV.
Relevant to cards.
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.
last4
Last 4 digits of the card.
Relevant to card payment methods.
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.
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.
has_more
Indicates whether there are more than three payment methods for this customer.
total_count
Total number of payment methods for this customer.
url
URL for requesting all of the payment methods for this customer.
phone_number
Customer's primary phone number in E.164 format. The merchant is responsible for verifying that the number is correct.
subscriptions
Describes the subscriptions associated with this customer. Array of objects. For details of the fields in the 'subscriptions' object, see Create Subscription.
CUSTOMER_DELETED Webhook
{ "id": "wh_73d5ba19ba7247bec9a68ff7d1990bca", "type": "CUSTOMER_DELETED", "data": { "id": "cus_835ae95c59498e6e94731ae80bc73558", "deleted": true }, "trigger_operation_id": "18b48386-eeb8-4947-8ff9-4acb09a14ee2", "status": "NEW", "created_at": 1640534885, "extended_timestamp": 1640534885394 }
The number of seconds elapsed since the beginning of the Unix epoch, which was 00:00:00 GMT on January 1, 1970. 10-digit integer.