Event Bridge Webhook Subscription(asynchronous API process)
Once the Vault is deleted, a deletion notification will be sent to the webstore via the topic or webhook.
Radial will either provide the topic or collect the webhook URL from the customer. The customer can then choose to subscribe to the topic or register their webhook URL with Radial.
The Vault can be deleted either through the Webstore or the PayPal Platform. If the Vault is created through the Webstore, a notification will be sent to the Webstore upon deletion. If the Vault has already been deleted, but there is still an active Vault in the Payment Service, the Webstore will receive a notification accordingly.
1. Topic name format:
Copy
NA.${dc}.{env}.Payments.PaymentMethod.Status.{Store_id}
2. Webhook url:
It must be a http url, webstore team share with Radial.
3. Webhook message
This is the message is passed to the webstore.
Copy
{
"id": "0194894b-70be-7bac-bc9e-32488614bc0f",
"createTimestamp": "2018-12-11T21:21:49.000Z",
"type": {
"class": "PAYMENT_METHOD",
"action": "DELETE"
},
"details": {
"paymentMethodType": "PAYPAL_VAULT",
"tender": "PY",
"payPalVaultData": {
"id": "3cb2bd0b2210"
}
}
}
4. Payload
Element | Required | Description | Type | Restriction |
---|---|---|---|---|
createTimestamp | Required | Timestamp when the request is sent | String | dateTime |
id | Yes | ID is used to uniquely identify a request. The value must be unique. It is recommended to use a variant 4 UUID for the request ID. | String | 40 Characters |
Type/ Class |
Yes | Context of the event. | Enum | Event context, PAYMENT_METHOD. |
Type/ Action |
Yes | Action of the event. | Enum | Action name, DELETE_VAULT |
Details/ paymentMethodType |
Yes | Payment method type. | Enum | Payment method type, PAYPAL_VAULT |
Details/ Tender |
Yes | Tender type. | String | Tender type, PY |
paymentMethod/ payPalVaultData/ id |
Required | ID of Grant that is used to create a payment. | String | Min 4 characters |