White-label notification delegation mode

Under the delegation model for white-label issuing notifications, Airwallex sends your platform a webhook each time a cardholder notification is required. Your platform is then responsible for delivering the notification to the cardholder using your own notification infrastructure. Airwallex branding is not present in any notifications your cardholders receive.

This model gives your platform complete control over notification branding and delivery, but requires you to build and operate the full notification delivery flow.

How delegation mode works

When an event occurs in the Airwallex issuing platform that requires a cardholder notification, Airwallex sends a webhook to your platform containing the event data. Your platform receives the webhook, generates the notification content, and delivers the notification to the cardholder.

Your platform is responsible for all three stages of the notification flow:

1. Receiving the webhook — subscribing to and receiving the Airwallex webhook events that signal a notification is required.
2. Generating the notification — creating the notification content, including branding, copy, and any required data (for example, a one-time passcode).
3. Delivering the notification — sending the notification to the cardholder via email or SMS using your own infrastructure.

For general documentation on integrating with Airwallex webhooks, see Listen for webhook events.

Notification types

The following issuing events trigger delegation model webhooks.

Webhook structure

Each delegation model webhook has two parts: a top-level header containing event metadata, and a data object containing notification-specific information. The header structure is described below; see Data payloads for the data object.

Header

1{
2  "account_id": "acct_TOslkS7-MnyXlQuV8Lb4og",
3  "created_at": "2022-01-01T00:00:00+0000",
4  "data": {},
5  "id": "86b69f91-06f0-3fe8-8faf-4de58954ca8e",
6  "name": "issuing.card_notification.created",
7  "source_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea",
8  "version": "2019-09-09"
9}

Data payloads

Each notification type has a unique data payload.

Card created and physical card activated

Applies to: issuing.card_notification.created, issuing.card_notification.physical_activated

1{
2  "card_id": "599196f6-8d5f-4daf-bfad-083b5e052e85"
3}

3DS OTP

Applies to: issuing.3ds_notification.stepup_otp

The payload varies depending on whether the cardholder selected email or SMS delivery.

Email delivery:

1{
2  "card_id": "599196f6-8d5f-4daf-bfad-083b5e052e85",
3  "contact_method": "EMAIL",
4  "contact_method_details": {
5    "email": "[email protected]"
6  },
7  "expiry_time": "2022-01-01T00:00:00.000+0000",
8  "masked_card_number": "8888",
9  "transaction_amount": 12.34,
10  "transaction_currency": "AUD",
11  "verification_code": "123456"
12}

SMS delivery (only the contact method fields differ):

1{
2  "contact_method": "SMS",
3  "contact_method_details": {
4    "dial_code": "1",
5    "phone_number": "0123456789"
6  }
7}

Digital wallet available

Applies to: issuing.digital_wallet_notification.wallet_available

1{
2  "card_id": "599196f6-8d5f-4daf-bfad-083b5e052e85"
3}

Digital wallet activated, abandoned provisioning, and payment reminder

Applies to: issuing.digital_wallet_notification.token_activated, issuing.digital_wallet_notification.abandoned_provisioning, issuing.digital_wallet_notification.payment_reminder

1{
2  "card_id": "599196f6-8d5f-4daf-bfad-083b5e052e85",
3  "token_reference_id": "DNITHE301616178439057312"
4}

Digital wallet token provisioning OTP

Applies to: issuing.digital_wallet_notification.token_provisioning_otp

The payload varies depending on whether the cardholder selected email or SMS delivery.

Email delivery:

1{
2  "card_id": "599196f6-8d5f-4daf-bfad-083b5e052e85",
3  "contact_method": "EMAIL",
4  "contact_method_details": {
5    "email": "[email protected]"
6  },
7  "expiry_time": "2022-01-01T00:00:00.000+0000",
8  "token_reference_id": "DNITHE301616178439057312",
9  "verification_code": "123456"
10}

SMS delivery (only the contact method fields differ):

1{
2  "contact_method": "SMS",
3  "contact_method_details": {
4    "dial_code": "1",
5    "phone_number": "0123456789"
6  }
7}

See also

• Concepts:
  • Card branding programs
  • Digital wallets
• How-to:
  • Listen for webhook events