Card on file created
Event generated after a card has been tokenized, becoming a card on file, and added to a customer's Pismo wallet. The Create card on file endpoint generates this event.
Type: object
Domain: cardsonfile
Event: provision
Version: 1
account_id required
Title: Account ID
Description: Pismo account ID
Type: integer
Example:
9484940
card_name required
Title: Card name
Description: Cardholder name printed or embossed on card.
Type: string
Example:
Veeva Lafrance
card_uuid required
Title: Card token
Description: Card UUID token for use in transactions.
Type: string
Format: uuid
Example:
bbbb9682-06e4-11ea-9d60-52552f8f9999
expiration_date required
Title: Card expiration date
Description: Card expiration date in MMYY format
Type: string
Example:
0121
acquirer
Title: Acquirer ID
Description: ID of acquirer that partners with Pismo.
Type: string
Example:
1hdj859
card_profile
Title: Card profile or color theme
Description: This field can be used to render the color or card image in payment app. This can be either a hex HTML color or the name of a profile that the issuer has registered with the network.
Type: string
Example:
0XFF00FF
99-67-54
created_at
Description: Date and time (RFC3339 format) when the card was added to the customer's wallet.
Type: string
Format: date-time
Example:
2020-03-03T12:03:00.000Z
default_card
Title: Cardholder's default card
Description: Is this the cardholder's default card flag.
Type: boolean
Example:
true
false
document_number
Title: Government document number.
Description: Cardholder's government document number.
Type: string
Example:
41440022209
first_6_digits
Title: First 6 card numbers
Description: First six PAN (primary account number) digits.
Type: string
Example:
456788
issuer_card
Title: Issuer card flag
Description: Is this card issued by the issuer flag.
Type: boolean
Example:
true
false
last_4_digits
Title: Last 4 card numbers
Description: Last four PAN (primary account number) digits.
Type: string
Example:
1200
metadata
Description: Metadata added during card provisioning. Client created - no business rule validation is done.
Type: object
name
Title: Cardholder's name
Description: Cardholder's name
Type: string
Example:
Helen Wheels
skip_acquirer_validation
Title: Skip acquirer validation flag.
Description: Should validation with acquirer be skipped flag.
Type: boolean
Example:
true
false
verified
Title: Issuer verified flag.
Description: Has the issuer already verified the card data flag.
Type: boolean
Example:
true
false
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Card on file created",
"description": "Event generated after a card has been tokenized, becoming a *card on file*, and added to a customer's Pismo wallet. The <a href='https://developers.pismo.io/pismo-docs/reference/create-a-cardsonfile-v3' target='_blank'>Create card on file</a> endpoint generates this event.",
"required": [
"account_id",
"card_uuid",
"expiration_date",
"card_name"
],
"properties": {
"account_id": {
"type": "integer",
"title": "Account ID",
"description": "Pismo account ID",
"examples": [
9484940
]
},
"card_name": {
"type": "string",
"title": "Card name",
"description": "Cardholder name printed or embossed on card.",
"examples": [
"Veeva Lafrance"
]
},
"card_uuid": {
"type": "string",
"format": "uuid",
"title": "Card token",
"description": "Card UUID token for use in transactions.",
"examples": [
"bbbb9682-06e4-11ea-9d60-52552f8f9999"
]
},
"expiration_date": {
"type": "string",
"title": "Card expiration date",
"description": "Card expiration date in MMYY format",
"examples": [
"0121"
]
},
"acquirer": {
"type": "string",
"title": "Acquirer ID",
"description": "ID of acquirer that partners with Pismo.",
"examples": [
"1hdj859"
]
},
"card_profile": {
"type": "string",
"title": "Card profile or color theme",
"description": "This field can be used to render the color or card image in payment app. This can be either a hex HTML color or the name of a profile that the issuer has registered with the network.",
"examples": [
"0XFF00FF",
"99-67-54"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date and time (RFC3339 format) when the card was added to the customer's wallet.",
"examples": [
"2020-03-03T12:03:00.000Z"
]
},
"default_card": {
"type": "boolean",
"title": "Cardholder's default card",
"description": "Is this the cardholder's default card flag.",
"examples": [
true,
false
]
},
"document_number": {
"type": "string",
"title": "Government document number.",
"description": "Cardholder's government document number.",
"examples": [
"41440022209"
]
},
"first_6_digits": {
"type": "string",
"title": "First 6 card numbers",
"description": "First six PAN (primary account number) digits.",
"examples": [
"456788"
]
},
"issuer_card": {
"type": "boolean",
"title": "Issuer card flag",
"description": "Is this card issued by the issuer flag.",
"examples": [
true,
false
]
},
"last_4_digits": {
"type": "string",
"title": "Last 4 card numbers",
"description": "Last four PAN (primary account number) digits.",
"examples": [
"1200"
]
},
"metadata": {
"type": "object",
"description": "Metadata added during card provisioning. Client created - no business rule validation is done."
},
"name": {
"type": "string",
"title": "Cardholder's name",
"description": "Cardholder's name",
"examples": [
"Helen Wheels"
]
},
"skip_acquirer_validation": {
"type": "boolean",
"title": "Skip acquirer validation flag.",
"description": "Should validation with acquirer be skipped flag.",
"examples": [
true,
false
]
},
"verified": {
"type": "boolean",
"title": "Issuer verified flag.",
"description": "Has the issuer already verified the card data flag.",
"examples": [
true,
false
]
}
}
}
Updated 6 days ago