Payment instrument event
You can subscribe to the Payment Instrument Webhook to receive all events that occur in Payment Instruments.
The returned object will contain the Payment Instrument in the state at the moment of the event creation. For example, if there's a status
change, you'll receive an event with the new status.
Payloads for PAYMENT_INSTRUMENT
Subscription Type
{
"entity": {
"payment_instrument_uuid": "string",
"external_id": "string",
"account_uuid": "string",
"status": "ACTIVE",
"status_reason": "string",
"payment_instrument_type": "CARD",
"payment_instrument_details": {
"card": {
"pan_last_4": "string",
"expiration_month": "string",
"expiration_year": "string",
"brand": "string",
"type": "CREDIT",
"name_on_card": "string",
"phone_number": "string",
"email_address": "string",
"validations": {
"avs_result": "string",
"cvv_result": "string"
}
}
},
"metadata": "string",
"created_at": "string",
"updated_at": "string"
},
"event_date": "2022-11-04T16:44:10.332Z",
"event_retry": 0,
"event_type": "PAYMENT_INSTRUMENT",
"event_uuid": "f4863f42-061d-5f0a-ab8a-e8f25a35c4dd",
"event_version": "2021-11-18.1",
"program_uuid": "f874b26c-2dbd-487f-8994-f38605cfb0a5"
}