Card on file updated
Event generated when card on file is updated. The Update card on file endpoint generates this event.
Type: object
Domain: cardsonfile
Event: patch-cards
Version: 1
card_uuid required
Title: Card token
Description: Card UUID token
Type: string
Format: uuid
Example:
bbbb9682-06e4-11ea-9d60-52552f8f9999
account_id
Title: Account ID
Description: Pismo account ID
Type: integer
Example:
22222222
acquirer
Title: Acquirer ID
Description: Acquirer ID
Type: integer
Example:
1
2
card_name
Title: Card name
Description: Cardholder name printed or embossed on card.
Type: string
Example:
Forrest Rainger
card_profile
Title: Card profile or color theme
Description: Used to render the color or card image in a payment app. Can be either a hex HTML color or the name of a network profile registered with the network.
Type: string
Example:
0XFF00FF
XX-99-88
card_status
Title: Card status
Description: Card status -ACTIVE
orSUSPENDED
Type: string
Example:
ACTIVE
SUSPENDED
created_at
Title: Created date time
Description: Date/time (RFC3339 format) when card on file was created and added to customer's wallet.
Type: string
Format: date-time
Example:
2020-03-03T12:03:00.000Z
default_card
Title: Default card flag
Description: Is this the cardholder's default card flag.
Type: boolean
Example:
true
false
issuer_card
Title: Issuer card flag
Description: Is this the issuer's card flag.
Type: boolean
Example:
true
false
last_4_digits
Title: Last 4 PAN digits
Description: Last four PAN (primary account number) digits
Type: string
Example:
1200
metadata
Title: Metadata
Description: Card metadata. Client-created - no business rule validation is done.
Type: object
org
Title: Org ID
Description: Organization ID, also known as the Tenant ID.
Type: string
Example:
TN-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
printed_name
Title: Card name
Description: Card name printed or embossed on card.
Type: string
Example:
Justin Thyme
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Card on file updated",
"description": "Event generated when card on file is updated. The <a href='https://developers.pismo.io/pismo-docs/reference/updates-a-cardsonfile' target='_blank'>Update card on file</a> endpoint generates this event.",
"required": [
"card_uuid"
],
"properties": {
"card_uuid": {
"type": "string",
"format": "uuid",
"title": "Card token",
"description": "Card UUID token",
"examples": [
"bbbb9682-06e4-11ea-9d60-52552f8f9999"
]
},
"account_id": {
"type": "integer",
"title": "Account ID",
"description": "Pismo account ID",
"examples": [
22222222
]
},
"acquirer": {
"type": "integer",
"title": "Acquirer ID",
"description": "Acquirer ID",
"examples": [
1,
2
]
},
"card_name": {
"type": "string",
"title": "Card name",
"description": "Cardholder name printed or embossed on card.",
"examples": [
"Forrest Rainger"
]
},
"card_profile": {
"type": "string",
"title": "Card profile or color theme",
"description": "Used to render the color or card image in a payment app. Can be either a hex HTML color or the name of a network profile registered with the network.",
"examples": [
"0XFF00FF",
"XX-99-88"
]
},
"card_status": {
"type": "string",
"title": "Card status",
"description": "Card status - `ACTIVE` or `SUSPENDED`",
"examples": [
"ACTIVE",
"SUSPENDED"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created date time",
"description": "Date/time (RFC3339 format) when card on file was created and added to customer's wallet.",
"examples": [
"2020-03-03T12:03:00.000Z"
]
},
"default_card": {
"type": "boolean",
"title": "Default card flag",
"description": "Is this the cardholder's default card flag.",
"examples": [
true,
false
]
},
"issuer_card": {
"type": "boolean",
"title": "Issuer card flag",
"description": "Is this the issuer's card flag.",
"examples": [
true,
false
]
},
"last_4_digits": {
"type": "string",
"title": "Last 4 PAN digits",
"description": "Last four PAN (primary account number) digits",
"examples": [
"1200"
]
},
"metadata": {
"type": "object",
"title": "Metadata",
"description": "Card metadata. Client-created - no business rule validation is done."
},
"org": {
"type": "string",
"title": "Org ID",
"description": "Organization ID, also known as the Tenant ID.",
"examples": [
"TN-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
]
},
"printed_name": {
"type": "string",
"title": "Card name",
"description": "Card name printed or embossed on card.",
"examples": [
"Justin Thyme"
]
}
}
}
Updated 3 days ago