Payment methods authorization created
This event represents a payment methods authorization request. This can be a request to a purchase authorization but also to a cancellation or confirmation. This is differentiated by the MTI of the operation.
Type: object
Domain: payment-methods
Event: authorization
Version: 1
tracking_id required
Title: Tracking ID of the authorization
Description: Unique tracking id used to identify an authorization request. If payment methods API doesn't receive one, it will generate a new one and the request will be handled as a new Request. Different requests using the same tracking id will be considered the same request and will return the same result.
Type: string
Example:
99999999-1234-4321-5678-123456789012
category
Title: Event Category
Description: Describe the action this event represents over an Authorization.
Type: string
Must be one of the following:
AUTHORIZATION
DECLINED
CANCELLATION
mti
Title: Message Type Identifier
Description: It will identify if it is an Authorization, Cancellation or Confirmation request.
Type: string
Example:
0100
0400
0202
clearing_type
Title: Clearing Type
Description: Define whether the confirmation of the authorization will be performed online at request time or it will wait for a confirmation request. If not present, MTI is considered to define this behavior.
Type: string
Must be one of the following:
null
ONLINE
OFFLINE
account_id
Title: Account ID
Description: Pismo ID of the account to be used as the owner of this request.
Type: integer or null
Example:
15500
1000
program_id
Title: Program ID
Description: Pismo ID of the program related to the owner of this request.
Type: integer or null
Example:
99
123
card_id
Title: Card Identifier
Description: Pismo ID of the card related to the owner of this request.
Type: integer or null
Example:
536743
94628393
card_mode_id
Title: Card Mode Identifier
Description: Pismo ID of the card mode related to the card used on this request.
Type: integer or null
Example:
6443298
7566890
document_number_present
Title: Document Number Presence
Description: Identifies whether the Document Number was present as the authorization identification of the account holder.
Type: boolean
authentication_token_present
Title: Authentication Token Presence
Description: Identifies whether the Authentication Token was present as the authorization identification of the account holder.
Type: boolean
processing_code
Title: Processing Code
Description: Unique alphanumeric identifier that defines how the Pismo platform handles this financial authorization.
Type: string
Example:
00
00AABB
network
Title: Network Identifier
Description: Identify the Network/Partner where this request has come from.
Type: string
Example:
Mastercard
Partner
entry_mode
Title: Entry Mode
Description: Defines the authorization entry mode.
Type: string
Example:
01
05
card_number_present
Title: Card Number Presence
Description: Identifies whether the Card Number was present as the authorization identification of the account holder.
Type: boolean
cvv2_present
Title: Cvv2 Presence
Description: Identifies whether the CVV 2 was present as the cardholder verification method.
Type: boolean
track1_data_present
Title: Track1 Data Presence
Description: Identifies whether the Track1 Data was present as the cardholder verification method.
Type: boolean
track2_data_present
Title: Track1 Data Presence
Description: Identifies whether the Track2 Data was present as the cardholder verification method.
Type: boolean
pin_present
Title: Pin Block Presence
Description: Identifies whether the Pin Block was present as the cardholder verification method.
Type: boolean
cryptogram_data_present
Title: Pin Block Presence
Description: Identifies whether the Cryptogram Data was present as the cardholder verification method.
Type: boolean
merchant_id
Title: Merchant Identifier
Description: Identifies the card acceptor that defines the point of the transaction in both local and interchange environments. This is used as a merchant ID to uniquely identify the merchant in a POS transaction.
Type: string or null
merchant_category_code
Title: MCC
Description: This is the classification (MCC) of the merchant’s type of business or service.
Type: string or null
merchant_name
Title: Merchant Name
Description: Name of the Merchant where the authorization is performed.
Type: string or null
merchant_city
Title: Merchant City
Description: City of the Merchant where the authorization is performed.
Type: string or null
merchant_country
Title: Merchant Country
Description: Country Code of the Merchant where the authorization is performed.
Type: string or null
merchant_terminal_id
Title: Merchant Terminal ID
Description: This uniquely identifies a terminal at the card acceptor location.
Type: string or null
authorization_code
Title: Authorization Code
Description: Alphanumeric code generated in an authorization request and assigned to the authorization response. Used on cancellation or advices requests to match the original authorization.
Type: string
Example:
ABC123
response_code
Title: Authorization Response Code
Description: Response code indicating the decision taken over an authorization request. Used in advice requests to identify the decision taken outside Pismo platform.
Type: string
Example:
ABC123
denial_code
Title: Authorization Denial Code
Description: Denial code that indicates the reason why the request was denied.
Type: string
Example:
SED
IAD
installment_plan_id
Title: Installment Plan Identifier
Description: Identifier of the installment plan that should be used to calculate this purchase.
Type: string
nsu
Title: NSU
Description: Sequential unique number that identifies this authorization.
Type: string
Example:
123456789
authorization_datetime
Title: Acquirer Authorization Date Time
Description: Date and time when the authorization request took place on acquirer side.
Type: string
Format: date-time
Example:
2020-01-01T10:10:00Z
amount
Title: Authorization Amount
Description: Total Amount of the authorization being requested in the local currency of the acquirer or source location of the transaction.
Type: number
Example:
10.0
123.99
currency_code
Title: Authorizaton Currency Code
Description: It is the local currency of the acquirer or source location of the transaction. It specifies the currency used in the field Amount.
Type: string
Example:
986
authorization_mode
Title: Authorization Mode
Description: Defines the mode of the authorization being requested.
Type: string
Example:
CREDIT
DEBIT
pre_authorization
Title: Pre Authorization Indicator
Description: Defines whether this authorization request is a pre authorization or not.
Type: boolean
number_of_installments
Title: Number Of Installments
Description: Number of installments of this authorization request. Purchases without installments should have the value 1.
Type: integer
Example:
1
12
atc
Title: Application transaction counter
Description: The ATC (application transaction counter) is a counter, maintained by the chip card application (incremented by the chip), that provides a sequential reference to each transaction. This field is the ATC value for this card on this authorization. Only authorization requests with cryptogram information contain this counter.
Type: integer
Example:
100
null
labels
Type: array or null
Must be one of the following:[ "INCREMENT_ATC", "INCREMENT_PASSWORD_TRIES", "BLOCK_CARD", "CLEAR_PASSWORD_TRIES" ]
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Payment methods authorization created",
"description": "This event represents a payment methods authorization request. This can be a request to a purchase authorization but also to a cancellation or confirmation. This is differentiated by the MTI of the operation.",
"required": [
"tracking_id"
],
"properties": {
"tracking_id": {
"title": "Tracking ID of the authorization",
"description": "Unique tracking id used to identify an authorization request. If payment methods API doesn't receive one, it will generate a new one and the request will be handled as a new Request. Different requests using the same tracking id will be considered the same request and will return the same result.",
"type": "string",
"examples": [
"99999999-1234-4321-5678-123456789012"
]
},
"category": {
"title": "Event Category",
"description": "Describe the action this event represents over an Authorization.",
"type": "string",
"enum": [
"AUTHORIZATION",
"DECLINED",
"CANCELLATION"
]
},
"mti": {
"title": "Message Type Identifier",
"description": "It will identify if it is an Authorization, Cancellation or Confirmation request.",
"type": "string",
"examples": [
"0100",
"0400",
"0202"
]
},
"clearing_type": {
"title": "Clearing Type",
"description": "Define whether the confirmation of the authorization will be performed online at request time or it will wait for a confirmation request. If not present, MTI is considered to define this behavior.",
"type": "string",
"enum": [
"",
"ONLINE",
"OFFLINE"
]
},
"account_id": {
"title": "Account ID",
"description": "Pismo ID of the account to be used as the owner of this request.",
"type": [
"integer",
"null"
],
"examples": [
15500,
1000
]
},
"program_id": {
"title": "Program ID",
"description": "Pismo ID of the program related to the owner of this request.",
"type": [
"integer",
"null"
],
"examples": [
99,
123
]
},
"card_id": {
"title": "Card Identifier",
"description": "Pismo ID of the card related to the owner of this request.",
"type": [
"integer",
"null"
],
"examples": [
536743,
94628393
]
},
"card_mode_id": {
"title": "Card Mode Identifier",
"description": "Pismo ID of the card mode related to the card used on this request.",
"type": [
"integer",
"null"
],
"examples": [
6443298,
7566890
]
},
"document_number_present": {
"title": "Document Number Presence",
"description": "Identifies whether the Document Number was present as the authorization identification of the account holder.",
"type": "boolean"
},
"authentication_token_present": {
"title": "Authentication Token Presence",
"description": "Identifies whether the Authentication Token was present as the authorization identification of the account holder.",
"type": "boolean"
},
"processing_code": {
"title": "Processing Code",
"description": "Unique alphanumeric identifier that defines how the Pismo platform handles this financial authorization.",
"type": "string",
"examples": [
"00",
"00AABB"
]
},
"network": {
"title": "Network Identifier",
"description": "Identify the Network/Partner where this request has come from.",
"type": "string",
"examples": [
"Mastercard",
"Partner"
]
},
"entry_mode": {
"title": "Entry Mode",
"description": "Defines the authorization entry mode.",
"type": "string",
"examples": [
"01",
"05"
]
},
"card_number_present": {
"title": "Card Number Presence",
"description": "Identifies whether the Card Number was present as the authorization identification of the account holder.",
"type": "boolean"
},
"cvv2_present": {
"title": "Cvv2 Presence",
"description": "Identifies whether the CVV 2 was present as the cardholder verification method.",
"type": "boolean"
},
"track1_data_present": {
"title": "Track1 Data Presence",
"description": "Identifies whether the Track1 Data was present as the cardholder verification method.",
"type": "boolean"
},
"track2_data_present": {
"title": "Track1 Data Presence",
"description": "Identifies whether the Track2 Data was present as the cardholder verification method.",
"type": "boolean"
},
"pin_present": {
"title": "Pin Block Presence",
"description": "Identifies whether the Pin Block was present as the cardholder verification method.",
"type": "boolean"
},
"cryptogram_data_present": {
"title": "Pin Block Presence",
"description": "Identifies whether the Cryptogram Data was present as the cardholder verification method.",
"type": "boolean"
},
"merchant_id": {
"title": "Merchant Identifier",
"description": "Identifies the card acceptor that defines the point of the transaction in both local and interchange environments. This is used as a merchant ID to uniquely identify the merchant in a POS transaction.",
"type": [
"string",
"null"
]
},
"merchant_category_code": {
"title": "MCC",
"description": "This is the classification (MCC) of the merchant\u2019s type of business or service.",
"type": [
"string",
"null"
]
},
"merchant_name": {
"title": "Merchant Name",
"description": "Name of the Merchant where the authorization is performed.",
"type": [
"string",
"null"
]
},
"merchant_city": {
"title": "Merchant City",
"description": "City of the Merchant where the authorization is performed.",
"type": [
"string",
"null"
]
},
"merchant_country": {
"title": "Merchant Country",
"description": "Country Code of the Merchant where the authorization is performed.",
"type": [
"string",
"null"
]
},
"merchant_terminal_id": {
"title": "Merchant Terminal ID",
"description": "This uniquely identifies a terminal at the card acceptor location.",
"type": [
"string",
"null"
]
},
"authorization_code": {
"title": "Authorization Code",
"description": "Alphanumeric code generated in an authorization request and assigned to the authorization response. Used on cancellation or advices requests to match the original authorization.",
"type": "string",
"examples": [
"ABC123"
]
},
"response_code": {
"title": "Authorization Response Code",
"description": "Response code indicating the decision taken over an authorization request. Used in advice requests to identify the decision taken outside Pismo platform.",
"type": "string",
"examples": [
"ABC123"
]
},
"denial_code": {
"title": "Authorization Denial Code",
"description": "Denial code that indicates the reason why the request was denied.",
"type": "string",
"examples": [
"SED",
"IAD"
]
},
"installment_plan_id": {
"title": "Installment Plan Identifier",
"description": "Identifier of the installment plan that should be used to calculate this purchase.",
"type": "string"
},
"nsu": {
"title": "NSU",
"description": "Sequential unique number that identifies this authorization.",
"type": "string",
"examples": [
"123456789"
]
},
"authorization_datetime": {
"title": "Acquirer Authorization Date Time",
"description": "Date and time when the authorization request took place on acquirer side.",
"type": "string",
"format": "date-time",
"examples": [
"2020-01-01T10:10:00Z"
]
},
"amount": {
"title": "Authorization Amount",
"description": "Total Amount of the authorization being requested in the local currency of the acquirer or source location of the transaction.",
"type": "number",
"examples": [
10.0,
123.99
]
},
"currency_code": {
"title": "Authorizaton Currency Code",
"description": "It is the local currency of the acquirer or source location of the transaction. It specifies the currency used in the field Amount.",
"type": "string",
"examples": [
"986"
]
},
"authorization_mode": {
"title": "Authorization Mode",
"description": "Defines the mode of the authorization being requested.",
"type": "string",
"examples": [
"CREDIT",
"DEBIT"
]
},
"pre_authorization": {
"title": "Pre Authorization Indicator",
"description": "Defines whether this authorization request is a pre authorization or not.",
"type": "boolean"
},
"number_of_installments": {
"title": "Number Of Installments",
"description": "Number of installments of this authorization request. Purchases without installments should have the value 1.",
"type": "integer",
"examples": [
1,
12
]
},
"atc": {
"title": "Application transaction counter",
"description": "The ATC (application transaction counter) is a counter, maintained by the chip card application (incremented by the chip), that provides a sequential reference to each transaction. This field is the ATC value for this card on this authorization. Only authorization requests with cryptogram information contain this counter.",
"type": "integer",
"examples": [
100,
0
]
},
"labels": {
"title": "Authorization Labels",
"description": "List with all labels related to this authorization. Each label identifies an authorization characteristic.",
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"INCREMENT_ATC",
"INCREMENT_PASSWORD_TRIES",
"BLOCK_CARD",
"CLEAR_PASSWORD_TRIES"
]
}
}
}
}
Updated 10 days ago