Card Status Changed Webhook
data Object (event payload)
Field | Value | Is Required | Description |
---|---|---|---|
account | object | Yes | IDs and identifiers associated with the account of an event (see below) |
timestamp | Date | Yes | Date and time the event is received by Berkeley |
new_raw_status | string | No | Most recent raw status of a card |
suspended | boolean | No | True if card was suspended. False if card was un-suspended. |
cad | string | No | Generated card ID |
account Object
Field | Value | Is Required | Description |
---|---|---|---|
id | integer | Yes | id of cardholder account |
cardholder_id | integer | Yes | id of cardholder |
processor_reference | string | Yes | Reference to the account on the processor's system |
Possible Status Codes (new_raw_status)
Code | Description |
---|---|
active | Active |
closed | Closed |
lost | Marked As Lost |
stolen | Marked As Stolen |
shipping | Card is getting prepared for shipping |
Sample Request
// Card raw status modified to active using modify card status endpoint
{
"program_id": 2,
"event": "card_status_changed",
"event_time": "2021-09-28T10:23:17.560200822-04:00",
"data": {
"account": {
"id": 1,
"cardholder_id": 1,
"processor_reference": "129201097356"
},
"timestamp": "2021-09-28T10:23:17Z",
"new_raw_status": "active"
}
}
// Card suspended using modify card status endpoint
{
"program_id": 2,
"event": "card_status_changed",
"event_time": "2021-09-28T10:23:17.560200822-04:00",
"data": {
"account": {
"id": 1,
"cardholder_id": 1,
"processor_reference": "129201097356"
},
"timestamp": "2021-09-28T10:23:17Z",
"suspended": true
"cad":"12345"
}
}
JSON Schema
{
"$id": "https://api.pungle.io/schemas/event/card_status_changed",
"title": "Card Status Changed Event payload",
"type": "object",
"properties": {
"account": {
"title": "Account Information",
"type": "object",
"properties": {
"id": {
"description": "ID of cardholder account",
"type": "number",
"minimum": 0
},
"cardholder_id": {
"description": "ID of cardholder",
"type": "number",
"minimum": 0
},
"processor_reference": {
"description": "Reference to the account on the processor's system",
"type": "string"
}
}
},
"timestamp": {
"description": "Date and time Berkeley receives the event",
"type": "string"
},
"new_raw_status": {
"description": "Most recent status of an account",
"type": "string",
"enum": [
"active",
"closed",
"lost",
"stolen"
]
},
"suspended": {
"description": "true if card was suspended, false if card was unsuspended",
"type": "boolean"
}
}
}
Updated almost 2 years ago