Create, retrieve, update, and manage checkout sessions. A checkout session generates a hosted payment page URL that the customer visits to complete payment.
" } ], "servers": [ { "url": "https://au.gsc.verifone.cloud/oidc/checkout-service", "description": "Australia" }, { "url": "https://cst.test-gsc.vfims.com/oidc/checkout-service", "description": "Global Sandbox" } ], "paths": { "/v2/checkout": { "get": { "tags": [ "Checkout" ], "summary": "List Checkouts", "security": [ { "BasicAuth": [] }, { "BearerAuth": [] } ], "operationId": "getV2Checkout", "parameters": [ { "name": "search", "in": "query", "description": "RSQL is a REST query language that allows you to filter resources based on their attributes. The RSQL query is a string that represents a query in a human-readable format. The RSQL query is passed as a query parameter in the URL and is used to filter the resources based on the attributes of the resource. See [RSQL queries for Checkout API](https://merchants.westpac.com.au/onlinepay/reference/checkout-rsql) for example filters to use with the Checkout API. See  for more information on RSQL queries.", "required": true, "schema": { "type": "string" }, "x-gitbook-description-html": "Filter checkouts using RSQL syntax. Combine expressions with ; (AND) or , (OR).
Filterable fields:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Field | Type | Operators |
|---|---|---|
amount | number | == != =in= =out= =gt= =ge= =lt= =le= |
created_at | date | == != =in= =out= =gt= =ge= =lt= =le= |
currency_code | string | == != =in= =out= =regex= |
customer | string | == != =in= =out= =regex= |
id | string | == != =in= =out= =regex= |
merchant_reference | string | == != =in= =out= =regex= |
entity_id | string | == != =in= =out= =regex= |
updated_at | date | == != =in= =out= =gt= =ge= =lt= =le= |
expiry_time | date | == != =in= =out= =gt= =ge= =lt= =le= |
status | string | == != =in= =out= =regex= |
notification_methods.email.email_address | string | == != =in= =out= =regex= |
configurations.card.token_details.reuse_token | string | == != =in= =out= =regex= |
payment_method_used | string | == != =in= =out= =regex= |
interaction_type | string | == != =in= =out= =regex= |
theme_id | string | == != =in= =out= =regex= |
transaction_id | string | == != =in= =out= =regex= |
created_by | string | == != =in= =out= =regex= |
Examples:
\nid==123;(amount==999,currency_code==USD);status==Authorizedid==12345,merchant_reference==1234554321;amount==3224amount=in=(100,200);interaction_type!=PAYMENT_LINKThe ordering sequence of the selected checkouts\nIf not selected then a default order is based on created Date Time.\nThe value of order_criteria can be one of the following:
\nThe ordering sequence of the selected customers If not selected then Descending order is the default order.
" }, { "name": "page_number", "in": "query", "description": "A filter query in RSQL format to retrieve customers based on page number. If not selected then a default pageNumber is 1.", "schema": { "minimum": 1, "type": "number" }, "x-gitbook-description-html": "A filter query in RSQL format to retrieve customers based on page number. If not selected then a default pageNumber is 1.
" }, { "name": "page_size", "in": "query", "description": "A filter query in RSQL format to retrieve customers based on page size. If not selected then a default pageSize is 50", "schema": { "minimum": 0, "type": "number" }, "x-gitbook-description-html": "A filter query in RSQL format to retrieve customers based on page size. If not selected then a default pageSize is 50
" }, { "name": "populate_customer_details", "in": "query", "description": "A query param to allow customer details to be populated for the customer id attached to checkout.", "schema": { "type": "boolean", "default": false }, "x-gitbook-description-html": "A query param to allow customer details to be populated for the customer id attached to checkout.
" } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutList" } } }, "x-gitbook-description-html": "Successful
" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "x-gitbook-description-html": "Bad Request
" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "x-gitbook-description-html": "Unauthorized
" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "x-gitbook-description-html": "Forbidden
" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "x-gitbook-description-html": "Internal Server Error
" } } } } }, "components": { "schemas": { "consentTextDynamicValues": { "type": "array", "description": "Optional merchant provided links to be inserted in consent text as a link for the text in brackets.", "items": { "type": "string" }, "x-gitbook-description-html": "Optional merchant provided links to be inserted in consent text as a link for the text in brackets.
" }, "details": { "type": "object" }, "Event": { "required": [ "id", "timestamp", "type" ], "type": "object", "properties": { "type": { "maxLength": 256, "type": "string", "description": "Type of event which occurred", "x-gitbook-description-html": "Type of event which occurred
" }, "id": { "type": "string", "description": "Id of the event", "x-format": { "guid": true }, "x-gitbook-description-html": "Id of the event
" }, "timestamp": { "type": "string", "description": "Time at which the event occurred", "format": "date-time", "x-gitbook-description-html": "Time at which the event occurred
" }, "details": { "$ref": "#/components/schemas/details" } } }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "threed_secure": { "required": [ "enabled", "threeds_contract_id" ], "type": "object", "description": "Used for 3D-Secure payments", "properties": { "account_age_indicator": { "type": "string", "description": "Length of time cardholder has had account.Length of time cardholder has had account.
Possible Values:
* 01 - No account
* 02 - Created during transaction
* 03 - Less than 30 days
* 04 - 30-60 days
* 05 - More than 60 days
Date the cardholder opened the account. Format: YYYYMMDD
Length of time since the last change to the cardholder account. This includes shipping address,
new payment account or new user added. Possible Values:
* 01 - Changed during transaction
* 02 - Less than 30 days
* 03 - 30-60 days
* 04 - More than 60 days
Date the cardholder's account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added. Format: YYYYMMDD
Length of time since the cardholder changed or reset the password on the account.
Possible Values:
* 01 - No change
* 02 - Changed during transaction
* 03 - Less than 30 days
* 04 - 30-60 days
* 05 - More than 60 days
Date the cardholder last changed or reset password on account. Format: YYYYMMDD
Additional cardholder account information.
" }, "account_purchases": { "maximum": 9999, "type": "integer", "description": "Number of purchases with this cardholder account during the previous six months.", "x-gitbook-description-html": "Number of purchases with this cardholder account during the previous six months.
" }, "acs_window_size": { "type": "string", "description": "An override field that a merchant can pass in to set the challenge window size to display to the endAn override field that a merchant can pass in to set the challenge window size to display to the end
cardholder.The ACS will reply with content that is formatted appropriately to this window size to allow
for the best user experience. The sizes are width x height in pixels of the window displayed in
the cardholder browser window. Possible values:
* 01 - 250x400
* 02 - 390x400
* 03 - 500x600
* 04 - 600x400
* 05 - Full page
Number of add card attempts in the last 24 hours.
" }, "address_match": { "type": "string", "description": "Indicates whether cardholder billing and shipping addresses match.Indicates whether cardholder billing and shipping addresses match.
Possible Values:
* Y - Shipping address matches billing address
* N - Shipping address does not match billing address
Mechanism used by the cardholder to authenticate to the 3DS requester.
Possible Values:
* 01 - No authentication occurred (e.g. Guest Checkout)
* 02 - Login to the cardholder account at the Merchant system using Merchant system credentials
* 03 - Login to the cardholder account at the Merchant system using a Federated ID
* 04 - Login to the cardholder account at the Merchant system using Issuer credentials
* 05 - Login to the cardholder account at the Merchant system using third-party authentication
* 06 - Login to the cardholder account at the Merchant system using FIDO Authenticator
Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM
Data that documents and supports a specific authentication
process that was sent in the AlternateAuthenticationMethod field.
The ID of the threeDSContract used.
" }, "authentication_indicator": { "type": "string", "description": "Indicates the type of Authentication request. 01 - Payment transactionIndicates the type of Authentication request. 01 - Payment transaction
02 - Recurring transaction
03 - Installment transaction
04 - Add card
05 - Maintain card
06 - Cardholder verification as part of EMV token ID&V
Merchant category code (MCC)
Note: This value is always taken from 3-D Secure Contract. If 3-D Secure Contract is not configured with MCC, Cardinal will use the default value configured.
NOTE: This is a 2.0 required field, Cardinal will default to 01 on Merchant Configuration
- can be overridden by the merchant. Possible Values:
* 01 - No preference
* 02 - No challenge requested
* 03 - Challenge requested (3DS Requestor Preference)
* 04 - Challenge requested (Mandate)
* 05 - No challenge requested (transactional risk analysis is already performed)
* 06 - No challenge requested (Data share only)
* 07 - No challenge requested (strong consumer authentication is already performed)
* 08 - No challenge requested (utilise whitelist exemption if no challenge required)
* 09 - Challenge requested (whitelist prompt requested if challenge required)
* 90 - CB specific value
For electronic delivery, email address to which the merchandise was delivered.
" }, "delivery_time_frame": { "type": "string", "description": "Indicates the delivery timeframe.Indicates the delivery timeframe.
Possible Values:
* 01 - Electronic delivery
* 02 - Same day shipping
* 03 - Overnight shipping
* 04 - Two or more day shipping
Whether 3DS should be used.
" }, "fraud_activity": { "type": "string", "description": "Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account.Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account.
Possible Values:
* 01 - No suspicious activity
* 02 - Suspicious activity observed
The purchase amount total for prepaid gift cards in major units.
Example: $123.45 USD = 12345
ISO 4217 currency code for the gift card purchased.
" }, "gift_card_count": { "maximum": 99, "type": "integer", "description": "Total count of individual prepaid gift cards purchased.", "x-gitbook-description-html": "Total count of individual prepaid gift cards purchased.
" }, "installment": { "maximum": 999, "minimum": 2, "type": "number", "description": "Indicates the maximum number of authorizations for installment payments. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments. ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **", "x-gitbook-description-html": "Indicates the maximum number of authorizations for installment payments. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments. ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **
" }, "message_category": { "type": "string", "description": "Category of the message for a specific use case.Category of the message for a specific use case.
Possible Values:
* 01 - PA (payment)
* 02 - NPA (non payment)
NOTE: Default is payment (01). Configured on Merchant account, or can be overridden on transaction.
Indicates the type of payment.The value from this field will be mapped to the data field on the CB-USECASE extension
Possible Values:
* 01 - Single Payment
* 02 - Fixed Amount and Term Subscription
* 03 - Payment By Instalments
* 04 - Payment By Shipment
* 05 - Other Recurring Payments
NOTE: Required for CB transactions (Required if message_category = 01, or message_category = 02 and authentication_indicator = 02 or 03
Indicates the length of time that the payment account was enrolled in the merchant account.
Possible Values:
* 01 - No account (guest checkout)
* 02 - During the transaction
* 03 - Less than 30 days
* 04 - 30-60 days
* 05 - More than 60 days
Date the payment account was added to the cardholder account. Format: YYYYMMDD
Indicates whether cardholder is placing an order with a future availability or release date.
Possible Values:
* 01 - Merchandise available
* 02 - Future availability
Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD
This field carry data that the ACS can use to verify the authentication process
" }, "prior_authentication_method": { "type": "string", "description": "Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor.Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor.
* 01 - Frictionless authentication occurred by ACS
* 02 - Cardholder challenge occurred by ACS
* 03 - AVS verified
* 04 - Other issuer methods
Date and time in UTC of the prior cardholder authentication. Format: YYYYMMDDHHMM
This data element contains a ACS Transaction ID for a prior authenticated transaction.
For example, the first recurring transaction that was authenticated with the cardholder
Merchant product code.
Possible Values:
* PHY - Goods/Service Purchase
* CHA - Check Acceptance
* ACF - Account Funding
* QCT - Quasi-Cash Transaction
* PAL - Prepaid Activation and Load
NOTE: This value defaults to PHY. This field can be used to override that value if applicable.
The date after which no further recurring authorizations should be performed. Format: YYYYMMDD ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **
Conditional: Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168 ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **
" }, "reorder_indicator": { "type": "string", "description": "Indicates whether cardholder is placing an order with a future availability or release date.Indicates whether cardholder is placing an order with a future availability or release date.
Possible Values:
* 01 - Merchandise available
* 02 - Future availability
This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID.
NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is,
configured on the Merchant's profile.
This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID.
NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is configured
on the Merchant's profile.
Indicates when the shipping address used for transaction was first used.
Possible Values:
* 01 - This transaction
* 02 - Less than 30 days
* 03 - 30-60 days
* 04 - More than 60 days
Date when the shipping address used for this transaction was first used.
Format: YYYYMMDD
Indicates shipping method chosen for the transaction.
Possible Values:
* 01 - Ship to cardholder billing address
* 02 - Ship to another verified address on file with merchant
* 03 - Ship to address that is different than billing address
* 04 - Ship to store (store address should be populated on request)
* 05 - Digital goods
* 06 - Travel and event tickets, not shipped
* 07 - Other
Indicates if the cardholder name on the account is identical to the
shipping name used for the transaction. Possible Values:
* 01 - Account and shipping name identical
* 02 - Account and shipping name differ
Total items in the shopping cart of the shopper
" }, "merchant_score": { "maxLength": 20, "type": "string", "description": "Merchant score", "x-format": { "alphanum": true }, "x-gitbook-description-html": "Merchant score
" }, "transaction_count_day": { "maximum": 999, "type": "integer", "description": "Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.
Number of transactions (successful or abandoned) for this cardholder account within the last year.
Transaction mode identifier. Identifies the channel the transaction originates from. Available Options:
M - Moto (Mail Order Telephone Order)
P - Mobile Device
R - Retail (Physical Store)
S - Computer Device
T - Tablet Device
This field contains the 3DS version that can be leveraged to force a transaction down the 1.0 rails.
" }, "white_list_status": { "type": "string", "description": "Enables the communication of trusted beneficiary between the ACS, the DS and the 3DS Requestor.Enables the communication of trusted beneficiary between the ACS, the DS and the 3DS Requestor.
Possible Values:
* Y - 3DS Requestor is trustlisted by cardholder
* N - 3DS Requestor is not trustlisted by cardholder
* E - Not eligible as determined by issuer
* P - Pending confirmation by cardholder
* R - Cardholder rejected
* U - Trustlist status unknown, unavailable, or does not apply
Note: This field may be returned for 2.1.0 if the MasterCard PSD2 extensions are passed and issuer supports them.
This data element will be populated by the system setting Whitelist Status.
" } }, "x-gitbook-description-html": "Used for 3D-Secure payments
" }, "card_brand": { "type": "array", "items": { "type": "string" } }, "token_details": { "type": "object", "properties": { "reuse_token": { "maxLength": 4096, "type": "string", "description": "The identifier used to represent the Cardholder data.", "x-gitbook-description-html": "The identifier used to represent the Cardholder data.
" }, "analytics_token": { "maxLength": 4096, "type": "string", "description": "A token that cannot be reversed to Card Holder data. This is included in a Payment for auditing and tracking purposes.", "x-gitbook-description-html": "A token that cannot be reversed to Card Holder data. This is included in a Payment for auditing and tracking purposes.
" } } }, "InstalmentConfiguration": { "required": [ "max_number_of_instalments" ], "type": "object", "properties": { "max_number_of_instalments": { "minimum": 1, "type": "integer", "description": "The number of individual parts that the total amount should be paid in", "x-gitbook-description-html": "The number of individual parts that the total amount should be paid in
" }, "down_payment_amount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "An integer value for down payment amount", "x-gitbook-description-html": "An integer value for down payment amount
" } }, "description": "The details on the instalment scheme that should be enacted by the issuer. Only applicable for ABS Acquirer.", "x-gitbook-description-html": "The details on the instalment scheme that should be enacted by the issuer. Only applicable for ABS Acquirer.
" }, "CVV": { "type": "object", "properties": { "validation_rule": { "type": "string", "default": "NONE", "enum": [ "NONE", "LUHN" ] }, "usage": { "type": "string", "default": "REQUIRED", "enum": [ "REQUIRED", "PROHIBITED" ] } } }, "FieldValidationRules": { "type": "object", "properties": { "CVV": { "$ref": "#/components/schemas/CVV" }, "CREDIT_TERM": { "$ref": "#/components/schemas/CVV" }, "IDENTITY_CARD_NUMBER": { "$ref": "#/components/schemas/CVV" } } }, "instalment_used": { "type": "object", "properties": { "instalment_amount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "An integer value for instalment amount", "x-gitbook-description-html": "An integer value for instalment amount
" }, "down_payment_amount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "An integer value for down payment amount", "x-gitbook-description-html": "An integer value for down payment amount
" }, "number_of_instalments": { "type": "integer", "description": "The number of individual parts that the total amount should be paid in", "x-gitbook-description-html": "The number of individual parts that the total amount should be paid in
" } }, "description": "The details on the instalment scheme that should be enacted by the issuer. Only applicable for ABS Acquirer.", "x-gitbook-description-html": "The details on the instalment scheme that should be enacted by the issuer. Only applicable for ABS Acquirer.
" }, "payment_contract_id": { "oneOf": [ { "type": "string", "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.", "x-gitbook-description-html": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.
" }, { "type": "object", "$ref": "#/x-alt-definitions/paymentContractIdDef" } ] }, "payment_frequency": { "type": "object", "description": "Payment frequencies. Used only for processing_model=RECURRING", "properties": { "time_unit": { "type": "string", "description": "must be one of DAY WEEK MONTH YEAR", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ], "x-gitbook-description-html": "must be one of DAY WEEK MONTH YEAR
" }, "value": { "type": "number" } }, "x-gitbook-description-html": "Payment frequencies. Used only for processing_model=RECURRING
" }, "processing_model_details": { "required": [ "processing_model" ], "type": "object", "properties": { "processing_model": { "type": "string", "description": "
* RECURRING - allows only for RECURRING subsequent charges to be done.
* NONE - does not specify what is the type of subsequent charges. Only allows CREDENTIAL_ON_FILE and UNSCHEDULED_CREDENTIAL_ON_FILE charges.
* If it is RECURRING for SIGNUP should be RECURRING FOR CHARGE TOO.
* If it is NONE for SIGNUP should be CREDENTIAL_ON_FILE or UNSCHEDULED_CREDENTIAL_ON_FILE FOR CHARGE.
Total number of payments for the stored credential series. Usage applies to specific acquirers. Used only for processing_model=RECURRING
" }, "total_payment_amount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Total amount for all the payments in the stored credential series. Usage applies to specific acquirers. Used only for processing_model=RECURRING", "x-gitbook-description-html": "Total amount for all the payments in the stored credential series. Usage applies to specific acquirers. Used only for processing_model=RECURRING
" }, "first_payment_amount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Amount of first payment for the stored credential series. Usage applies to specific acquirers. Used only for processing_model=RECURRING", "x-gitbook-description-html": "Amount of first payment for the stored credential series. Usage applies to specific acquirers. Used only for processing_model=RECURRING
" }, "payment_frequency": { "$ref": "#/components/schemas/payment_frequency" }, "merchant_signup_code": { "type": "string", "description": "Merchant signup code for the stored credential series. Usage applies to specific acquirers. Used only for processing_model=NONE", "x-gitbook-description-html": "Merchant signup code for the stored credential series. Usage applies to specific acquirers. Used only for processing_model=NONE
" } } }, "stored_credential": { "required": [ "processing_model_details", "stored_credential_type" ], "type": "object", "description": "Used for transactions with Stored Credentials", "properties": { "stored_credential_type": { "type": "string", "description": "must be one of SIGNUP CHARGE", "enum": [ "SIGNUP", "CHARGE" ], "x-gitbook-description-html": "must be one of SIGNUP CHARGE
" }, "first_payment": { "type": "boolean", "description": "Set to true if this signup request also is the first payment.\nMost relevant for signup using a minor amount, to indicate if that minor amount is just a signup account verification amount or an actual first payment amount as well.\nDefault on this endpoint is that zero amount is not a payment, but any amount provided is a payment.\nUse this indicator to explicitly tell the intention.\n", "x-gitbook-description-html": "Set to true if this signup request also is the first payment.\nMost relevant for signup using a minor amount, to indicate if that minor amount is just a signup account verification amount or an actual first payment amount as well.\nDefault on this endpoint is that zero amount is not a payment, but any amount provided is a payment.\nUse this indicator to explicitly tell the intention.
" }, "consent_text": { "maxLength": 2048, "pattern": "[\\p{L}\\p{N}.,_\\-+\\s\\\\{\\\\}]", "type": "string", "description": "Optional merchant provided text to display to the shopper as a checkbox, requiring their consent for the given sign up, detailing the terms at which the shopper agrees to be charged in the future. If not provided, there will be no consent checkbox.", "x-gitbook-description-html": "Optional merchant provided text to display to the shopper as a checkbox, requiring their consent for the given sign up, detailing the terms at which the shopper agrees to be charged in the future. If not provided, there will be no consent checkbox.
" }, "consent_text_dynamic_values": { "$ref": "#/components/schemas/consentTextDynamicValues" }, "processing_model_details": { "$ref": "#/components/schemas/processing_model_details" }, "reference": { "type": "string" }, "scheme_reference": { "type": "string" } }, "x-gitbook-description-html": "Used for transactions with Stored Credentials
" }, "additional_business_data": { "type": "object", "properties": { "addendum1": { "maxLength": 300, "type": "string", "description": "Additional field 1 for processor data.", "x-gitbook-description-html": "Additional field 1 for processor data.
" }, "addendum2": { "maxLength": 300, "type": "string", "description": "Additional field 2 for processor data.", "x-gitbook-description-html": "Additional field 2 for processor data.
" } }, "description": "Merchant defined additional data fields for ABS Acquirer.", "x-gitbook-description-html": "Merchant defined additional data fields for ABS Acquirer.
" }, "CardPaymentConfigResponse": { "required": [ "payment_contract_id" ], "type": "object", "properties": { "account_validation": { "type": "boolean", "description": "Indicates whether the card transaction should be processed as Account Validation request instead. If set to true, the amount provided for the Checkout would be ignored and the transaction be processed with amount: 0", "default": false, "x-gitbook-description-html": "Indicates whether the card transaction should be processed as Account Validation request instead. If set to true, the amount provided for the Checkout would be ignored and the transaction be processed with amount: 0
" }, "capture_now": { "type": "boolean", "description": "True - transaction will be sent as authCapture and automatically captured.True - transaction will be sent as authCapture and automatically captured.
False - transaction will be sent as auth and only authorized. NOT CAPTURED.
If you don't have any value in the capture_now parameter, at the moment of the call the value will be set as TRUE.
Indicates whether cvv is required
" }, "authorization_type": { "type": "string", "description": "Card Authorization Type.", "enum": [ "PRE_AUTH", "FINAL_AUTH" ], "x-gitbook-description-html": "Card Authorization Type.
" }, "shopper_interaction": { "$ref": "#/components/schemas/shopper_interaction" }, "payment_contract_id": { "$ref": "#/components/schemas/payment_contract_id" }, "token_preference": { "$ref": "#/x-alt-definitions/card_token_preference" }, "threed_secure": { "$ref": "#/components/schemas/threed_secure" }, "mode": { "$ref": "#/components/schemas/card_mode" }, "card_capture_mode": { "$ref": "#/components/schemas/card_capture_mode" }, "card_token": { "maxLength": 2048, "type": "string", "description": "*Only applicable for Tokenisation v1* Card token representing the card used by a customer to fill in the form. In case that Customer retries the payment with different card(s), only the last one ", "x-gitbook-description-html": "Only applicable for Tokenisation v1 Card token representing the card used by a customer to fill in the form. In case that Customer retries the payment with different card(s), only the last one
" }, "card_last_four": { "maxLength": 4, "minLength": 4, "type": "string", "description": "*Only applicable for Tokenisation v1* Last four digits of the card number used by the customer. In case that Customer retries the payment with different card(s), its always the last one", "x-gitbook-description-html": "Only applicable for Tokenisation v1 Last four digits of the card number used by the customer. In case that Customer retries the payment with different card(s), its always the last one
" }, "card_expiry_year": { "pattern": "\\d{2}", "type": "string", "description": "*Only applicable for Tokenisation v1* Card expiry year", "x-gitbook-description-html": "Only applicable for Tokenisation v1 Card expiry year
" }, "card_expiry_month": { "pattern": "^(0[1-9]|1[012])$", "type": "string", "description": "*Only applicable for Tokenisation v1* Card expiry month", "x-gitbook-description-html": "Only applicable for Tokenisation v1 Card expiry month
" }, "card_brand": { "$ref": "#/components/schemas/card_brand" }, "card_encryption_key_alias": { "maxLength": 2048, "type": "string", "description": "*Only applicable for Tokenisation v2* Public Key alias used for card encryption", "x-gitbook-description-html": "Only applicable for Tokenisation v2 Public Key alias used for card encryption
" }, "threeds_authentication_id": { "type": "string", "description": "3DS Authentication ID. Only available if 3DS was configured and performed via the Checkout.", "x-format": { "guid": true }, "x-gitbook-description-html": "3DS Authentication ID. Only available if 3DS was configured and performed via the Checkout.
" }, "token_details": { "$ref": "#/components/schemas/token_details" }, "credit_term": { "type": "string", "description": "Determines whether the transaction type for ABS. Available Options:Determines whether the transaction type for ABS. Available Options:
STANDARD- Sale
PREFERRED - Sale - Preferred Isracard
DEBIT - Sale - Direct Debit
INSTALMENT_STANDARD- Instalment standard
INSTALMENT_CREDIT- Instalment credit
Determines whether the transaction type for ABS. Available Options:
STANDARD- Sale
PREFERRED - Sale - Preferred Isracard
DEBIT - Sale - Direct Debit
INSTALMENT_STANDARD- Instalment standard
INSTALMENT_CREDIT- Instalment credit
The identifier used to represent the Cardholder data.
" }, "encrypted_card": { "maxLength": 4096, "type": "string", "description": "Encrypted card details", "x-gitbook-description-html": "Encrypted card details
" }, "additional_business_data": { "$ref": "#/components/schemas/additional_business_data" } }, "description": "Card payment configuration", "x-gitbook-description-html": "Card payment configuration
" }, "ThreeDSData": { "description": "Used for 3D-Secure payments", "required": [ "threeds_contract_id", "transaction_mode" ], "type": "object", "properties": { "account_age_indicator": { "type": "string", "description": "Length of time cardholder has had account.Length of time cardholder has had account.
Possible Values:
* 01 - No account
* 02 - Created during transaction
* 03 - Less than 30 days
* 04 - 30-60 days
* 05 - More than 60 days
Date the cardholder opened the account. Format: YYYYMMDD
Length of time since the last change to the cardholder account. This includes shipping address,
new payment account or new user added. Possible Values:
* 01 - Changed during transaction
* 02 - Less than 30 days
* 03 - 30-60 days
* 04 - More than 60 days
Date the cardholder's account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added. Format: YYYYMMDD
Length of time since the cardholder changed or reset the password on the account.
Possible Values:
* 01 - No change
* 02 - Changed during transaction
* 03 - Less than 30 days
* 04 - 30-60 days
* 05 - More than 60 days
Date the cardholder last changed or reset password on account. Format: YYYYMMDD
Additional cardholder account information.
" }, "account_purchases": { "maximum": 9999, "type": "integer", "description": "Number of purchases with this cardholder account during the previous six months.", "x-gitbook-description-html": "Number of purchases with this cardholder account during the previous six months.
" }, "acs_window_size": { "type": "string", "description": "An override field that a merchant can pass in to set the challenge window size to display to the endAn override field that a merchant can pass in to set the challenge window size to display to the end
cardholder.The ACS will reply with content that is formatted appropriately to this window size to allow
for the best user experience. The sizes are width x height in pixels of the window displayed in
the cardholder browser window. Possible values:
* 01 - 250x400
* 02 - 390x400
* 03 - 500x600
* 04 - 600x400
* 05 - Full page
Number of add card attempts in the last 24 hours.
" }, "address_match": { "type": "string", "description": "Indicates whether cardholder billing and shipping addresses match.Indicates whether cardholder billing and shipping addresses match.
Possible Values:
* Y - Shipping address matches billing address
* N - Shipping address does not match billing address
Mechanism used by the cardholder to authenticate to the 3DS requester.
Possible Values:
* 01 - No authentication occurred (e.g. Guest Checkout)
* 02 - Login to the cardholder account at the Merchant system using Merchant system credentials
* 03 - Login to the cardholder account at the Merchant system using a Federated ID
* 04 - Login to the cardholder account at the Merchant system using Issuer credentials
* 05 - Login to the cardholder account at the Merchant system using third-party authentication
* 06 - Login to the cardholder account at the Merchant system using FIDO Authenticator
Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM
Data that documents and supports a specific authentication
process that was sent in the AlternateAuthenticationMethod field.
The ID of the threeDSContract used.
" }, "authentication_indicator": { "type": "string", "description": "Indicates the type of Authentication request. 01 - Payment transactionIndicates the type of Authentication request. 01 - Payment transaction
02 - Recurring transaction
03 - Installment transaction
04 - Add card
05 - Maintain card
06 - Cardholder verification as part of EMV token ID&V
Merchant category code (MCC) NOTE: This field is required by Mastercard and VISA Brazil extensions.
NOTE: This is a 2.0 required field, Cardinal will default to 01 on Merchant Configuration
- can be overridden by the merchant. Possible Values:
* 01 - No preference
* 02 - No challenge requested
* 03 - Challenge requested (3DS Requestor Preference)
* 04 - Challenge requested (Mandate)
* 90 - CB specific value
For electronic delivery, email address to which the merchandise was delivered.
" }, "delivery_time_frame": { "type": "string", "description": "Indicates the delivery timeframe.Indicates the delivery timeframe.
Possible Values:
* 01 - Electronic delivery
* 02 - Same day shipping
* 03 - Overnight shipping
* 04 - Two or more day shipping
Whether 3DS should be used.
" }, "fraud_activity": { "type": "string", "description": "Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account.Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account.
Possible Values:
* 01 - No suspicious activity
* 02 - Suspicious activity observed
The purchase amount total for prepaid gift cards in major units.
Example: $123.45 USD = 12345
ISO 4217 currency code for the gift card purchased.
" }, "gift_card_count": { "maximum": 99, "type": "integer", "description": "Total count of individual prepaid gift cards purchased.", "x-gitbook-description-html": "Total count of individual prepaid gift cards purchased.
" }, "installment": { "maximum": 999, "minimum": 2, "type": "number", "description": "Indicates the maximum number of authorizations for installment payments. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments. ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **", "x-gitbook-description-html": "Indicates the maximum number of authorizations for installment payments. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments. ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **
" }, "message_category": { "type": "string", "description": "Category of the message for a specific use case.Category of the message for a specific use case.
Possible Values:
* 01 - PA (payment)
* 02 - NPA (non payment)
NOTE: Default is payment (01). Configured on Merchant account, or can be overridden on transaction.
Indicates the type of payment.The value from this field will be mapped to the data field on the CB-USECASE extension
Possible Values:
* 01 - Single Payment
* 02 - Fixed Amount and Term Subscription
* 03 - Payment By Instalments
* 04 - Payment By Shipment
* 05 - Other Recurring Payments
NOTE: Required for CB transactions (Required if message_category = 01, or message_category = 02 and authentication_indicator = 02 or 03
Indicates the length of time that the payment account was enrolled in the merchant account.
Possible Values:
* 01 - No account (guest checkout)
* 02 - During the transaction
* 03 - Less than 30 days
* 04 - 30-60 days
* 05 - More than 60 days
Date the payment account was added to the cardholder account. Format: YYYYMMDD
Indicates whether cardholder is placing an order with a future availability or release date.
Possible Values:
* 01 - Merchandise available
* 02 - Future availability
Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD
This field carry data that the ACS can use to verify the authentication process
" }, "prior_authentication_method": { "type": "string", "description": "Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor.Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor.
* 01 - Frictionless authentication occurred by ACS
* 02 - Cardholder challenge occurred by ACS
* 03 - AVS verified
* 04 - Other issuer methods
Date and time in UTC of the prior cardholder authentication. Format: YYYYMMDDHHMM
This data element contains a ACS Transaction ID for a prior authenticated transaction.
For example, the first recurring transaction that was authenticated with the cardholder
Merchant product code.
Possible Values:
* PHY - Goods/Service Purchase
* CHA - Check Acceptance
* ACF - Account Funding
* QCT - Quasi-Cash Transaction
* PAL - Prepaid Activation and Load
NOTE: This value defaults to PHY. This field can be used to override that value if applicable.
The date after which no further recurring authorizations should be performed. Format: YYYYMMDD ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **
Conditional: Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168 ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **
" }, "reorder_indicator": { "type": "string", "description": "Indicates whether cardholder is placing an order with a future availability or release date.Indicates whether cardholder is placing an order with a future availability or release date.
Possible Values:
* 01 - Merchandise available
* 02 - Future availability
This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID.
NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is,
configured on the Merchant's profile.
This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID.
NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is configured
on the Merchant's profile.
Indicates when the shipping address used for transaction was first used.
Possible Values:
* 01 - This transaction
* 02 - Less than 30 days
* 03 - 30-60 days
* 04 - More than 60 days
Date when the shipping address used for this transaction was first used.
Format: YYYYMMDD
Indicates shipping method chosen for the transaction.
Possible Values:
* 01 - Ship to cardholder billing address
* 02 - Ship to another verified address on file with merchant
* 03 - Ship to address that is different than billing address
* 04 - Ship to store (store address should be populated on request)
* 05 - Digital goods
* 06 - Travel and event tickets, not shipped
* 07 - Other
Indicates if the cardholder name on the account is identical to the
shipping name used for the transaction. Possible Values:
* 01 - Account and shipping name identical
* 02 - Account and shipping name differ
Total items in the shopping cart of the shopper
" }, "merchant_score": { "maxLength": 20, "type": "string", "description": "Merchant score", "x-format": { "alphanum": true }, "x-gitbook-description-html": "Merchant score
" }, "transaction_count_day": { "maximum": 999, "type": "integer", "description": "Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.
Number of transactions (successful or abandoned) for this cardholder account within the last year.
Transaction mode identifier. Identifies the channel the transaction originates from. Available Options:
M - Moto (Mail Order Telephone Order)
P - Mobile Device
R - Retail (Physical Store)
S - Computer Device
T - Tablet Device
This field contains the 3DS version that can be leveraged to force a transaction down the 1.0 rails.
" } }, "x-gitbook-description-html": "Used for 3D-Secure payments
" }, "GooglePayCardConfig": { "required": [ "payment_contract_id", "sca_compliance_level" ], "type": "object", "properties": { "sca_compliance_level": { "type": "string", "description": "Strong Customer Authentication (SCA) compliance level, possible values \n * NONE: No SCA required. \n * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. \n * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.", "enum": [ "NONE", "WALLET", "FORCE_3DS" ], "x-gitbook-description-html": "Strong Customer Authentication (SCA) compliance level, possible values
\n* NONE: No SCA required.
\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.
\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.
Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.
" }, "shopper_interaction": { "$ref": "#/components/schemas/shopper_interaction" }, "payment_contract_id": { "type": "string", "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.", "x-alternatives": [ { "type": "string", "description": "Payment Contract Id", "x-format": { "guid": true }, "x-gitbook-description-html": "Payment Contract Id
" }, { "$ref": "#/x-alt-definitions/paymentContractIdDef" } ], "x-format": { "guid": true }, "x-gitbook-description-html": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.
" }, "token_preference": { "$ref": "#/x-alt-definitions/token_preference" }, "card_encryption_key_alias": { "maxLength": 2048, "type": "string", "description": "*Only applicable for Tokenisation v2* Public Key alias used for card encryption", "x-gitbook-description-html": "Only applicable for Tokenisation v2 Public Key alias used for card encryption
" }, "threeds_authentication_id": { "type": "string", "description": "3DS Authentication ID. Only available if 3DS was configured and performed via the Checkout.", "x-format": { "guid": true }, "x-gitbook-description-html": "3DS Authentication ID. Only available if 3DS was configured and performed via the Checkout.
" }, "token_details": { "$ref": "#/components/schemas/token_details" } } }, "shopper_interaction": { "type": "string", "description": "Used to indicate the channel used by to send they checkout linkUsed to indicate the channel used by to send they checkout link
* ECOMMERCE
* MAIL - value is used only in Virtual terminal transactions and cannot be used in createCheckout API call
* TELEPHONE - value is used only in Virtual terminal transactions and cannot be used in createCheckout API call
True - transaction will be sent as authCapture and automatically captured.
False - transaction will be sent as auth and only authorized. NOT CAPTURED.
If you don't have any value in the capture_now parameter, at the moment of the call the value will be set as TRUE.
Google Pay payment configuration
" }, "card_capture_mode": { "type": "string", "description": "Method of capturing card data.\nv2 is used by default as the recommended method.\nv1 is considered deprecated and is not supported for new integrations.", "enum": [ "v2", "v1" ], "x-gitbook-description-html": "Method of capturing card data.\nv2 is used by default as the recommended method.\nv1 is considered deprecated and is not supported for new integrations.
" }, "card_mode": { "type": "string", "description": "- `PAYMENT` - A checkout is created with the intent to perform a card payment. OnlinePay takes care of the full payment process and returns the final transaction response to the merchant, alongside any related details to it. Requires providing payment provider contract details.PAYMENT - A checkout is created with the intent to perform a card payment. OnlinePay takes care of the full payment process and returns the final transaction response to the merchant, alongside any related details to it. Requires providing payment provider contract details. 3DS_PAYMENT - Same as PAYMENT but with performing 3DS verification. CARD_CAPTURE - A checkout is created with intent to retrieve customer's card data. The checkout captures the card data of the shopper, encrypts it and returns it to the Merchant. The Merchant then uses the encrypted card data to perform 3DS and/or payments with it.3DS - A checkout is created with intent to perform 3DS verification for the cardholder. The checkout captures the card data and performs 3DS verification with it and returns both card data and 3DS results to the Merchant. The merchant then can then use the encrypted card data to perform a payment with it. Requires providing 3DS contract details.Default language is used for displaying the page. Any customer language choice would override this option
" }, "fallback_language": { "type": "string", "description": "Fallback language is used when DEFAULT_LANGUAGE is invalid. Any customer language choice would override this option", "x-gitbook-description-html": "Fallback language is used when DEFAULT_LANGUAGE is invalid. Any customer language choice would override this option
" }, "show_language_options": { "type": "boolean", "description": "Indicates whether a language selection option should be shown to the customer on the Checkout page or not", "default": true, "x-gitbook-description-html": "Indicates whether a language selection option should be shown to the customer on the Checkout page or not
" } } }, "customer_details": { "required": [ "entity_id" ], "type": "object", "properties": { "billing": { "$ref": "#/components/schemas/billing" }, "company_name": { "maxLength": 100, "type": "string", "description": "Company of the customer. . **Required** in case that billing.firstName & billing.lastName are not provided.", "x-gitbook-description-html": "Company of the customer. . Required in case that billing.firstName & billing.lastName are not provided.
" }, "company_registration_number": { "maxLength": 24, "type": "string", "description": "Unique identifier of the company, recognised by the government.\n Known as CoC (Chamber of Commerce) number in some countries", "x-gitbook-description-html": "Unique identifier of the company, recognised by the government.\nKnown as CoC (Chamber of Commerce) number in some countries
" }, "email_address": { "maxLength": 255, "type": "string", "description": "Consumer's email address.", "x-format": { "email": { "minDomainSegments": 2 } }, "x-gitbook-description-html": "Consumer's email address.
\nField required for: Klarna, Paypal
Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)
" }, "phone_number": { "maxLength": 25, "pattern": "^(\\s*[0-9-+().])[0-9-\\s+().]*$", "type": "string", "description": "Cardholder's phone number", "x-gitbook-description-html": "Cardholder's phone number
" }, "shipping": { "$ref": "#/components/schemas/shipping" }, "title": { "pattern": "^[a-zA-Z-\\s.]+$", "maxLength": 120, "type": "string", "description": "Title", "x-gitbook-description-html": "Title
" }, "work_phone": { "maxLength": 25, "pattern": "^(\\s*[0-9-+().])[0-9-\\s+().]*$", "type": "string", "description": "Consumer's work phone number.", "x-gitbook-description-html": "Consumer's work phone number.
" }, "tax": { "$ref": "#/components/schemas/tax" } } }, "billing": { "type": "object", "properties": { "address_1": { "maxLength": 40, "type": "string", "description": "Customer's primary billing address information.", "x-gitbook-description-html": "Customer's primary billing address information.
" }, "address_2": { "maxLength": 40, "type": "string", "description": "Customer's secondary billing address information.", "x-gitbook-description-html": "Customer's secondary billing address information.
" }, "address_3": { "maxLength": 40, "type": "string", "description": "Customer's third billing address information.", "x-gitbook-description-html": "Customer's third billing address information.
" }, "city": { "maxLength": 28, "type": "string", "description": "Customer's city on their billing address.", "x-gitbook-description-html": "Customer's city on their billing address.
" }, "country_code": { "type": "string", "description": "Customer's alpha 2 digit ISO 3166 country code. (e.g. United States = US)", "x-gitbook-description-html": "Customer's alpha 2 digit ISO 3166 country code. (e.g. United States = US)
" }, "first_name": { "maxLength": 22, "type": "string", "description": "Customer's first name.Customer's first name.
Required in case that companyName is not provided.
Customer's middle name.
" }, "last_name": { "maxLength": 22, "type": "string", "description": "Customer's last name.Customer's last name.
Required in case that companyName is not provided.
Customer's phone number for billing address.
" }, "postal_code": { "maxLength": 10, "type": "string", "description": "Customer's postal code of their billing address.", "x-gitbook-description-html": "Customer's postal code of their billing address.
Required if the payment method is PayPal.
Customer's state or province of their billing address. (e,g. Ohio = OH, Texas = TX)
" } } }, "shipping": { "type": "object", "properties": { "address_1": { "maxLength": 40, "type": "string", "description": "Consumer's primary shipping address information.\n**Field required for**: Google Pay, Apple Pay", "x-gitbook-description-html": "Consumer's primary shipping address information.
\nField required for: Klarna, Paypal, Vipps, MobilePay, Google Pay, Apple Pay, Affirm, Swish
Consumer's secondary shipping address information.
\nField required for: Paypal
Consumer's third shipping address information.
" }, "city": { "maxLength": 28, "type": "string", "description": "Consumer's city on their shipping address.\n**Field required for**: Google Pay, Apple Pay", "x-gitbook-description-html": "Consumer's city on their shipping address.
\nField required for: Klarna, Paypal, Vipps, MobilePay, Google Pay, Apple Pay, Affirm, Swish
Consumer's first name.
\nField required for: Klarna, Vipps, MobilePay
Consumer's middle name.
" }, "last_name": { "maxLength": 22, "type": "string", "description": "Consumer's last name.", "x-gitbook-description-html": "Consumer's last name.
\nField required for: Klarna, Vipps, MobilePay
Field required for: Klarna, Paypal, Vipps, MobilePay
" }, "country_code": { "type": "string", "description": "Consumer's alpha 2 digit ISO 3166 country code. (e.g. United\nStates = US)\n**Field required for**: Google Pay, Apple Pay", "x-gitbook-description-html": "Consumer's alpha 2 digit ISO 3166 country code. (e.g. United\nStates = US)
\nField required for: Klarna, Paypal, Vipps, MobilePay, Google Pay, Apple Pay, Affirm, Swish
Consumer's postal code of their shipping address.
\nField required for: Klarna, Paypal, Vipps, MobilePay, Google Pay, Apple Pay, Affirm, Swish
Consumer's state or province of their shipping address. (e,g.\nOhio = OH, Texas = TX)
\nField required for: Klarna, Paypal
An optional identifier of the document recipient:
Personal ID (for individuals)
Tax identification number (for business)
Image URL for the line item
" }, "item_url": { "maxLength": 2000, "type": "string", "description": "Item URL for the line item", "x-format": { "uri": true }, "x-gitbook-description-html": "Item URL for the line item
" }, "image_id": { "type": "string", "description": "Image ID for the line item", "x-format": { "guid": true }, "x-gitbook-description-html": "Image ID for the line item
" }, "name": { "maxLength": 255, "type": "string", "description": "Descriptive name of the order line item", "x-gitbook-description-html": "Descriptive name of the order line item
" }, "quantity": { "type": "integer", "default": 1, "description": "Quantity of the order line item", "x-gitbook-description-html": "Quantity of the order line item
" }, "unit_price": { "type": "number", "description": "Unit Price", "x-gitbook-description-html": "Unit Price
" }, "unit_price_tax": { "type": "number", "description": "Unit Price Tax", "x-gitbook-description-html": "Unit Price Tax
" }, "tax_rate": { "type": "number", "description": "Additional details specific to this type of event", "x-gitbook-description-html": "Additional details specific to this type of event
" }, "total_tax_amount": { "type": "number", "description": "Total tax amount", "x-gitbook-description-html": "Total tax amount
" }, "total_amount": { "type": "number", "description": "Total Amount", "x-gitbook-description-html": "Total Amount
" }, "sku": { "maxLength": 127, "type": "string", "description": "The stock keeping unit (SKU) for the item.", "x-gitbook-description-html": "The stock keeping unit (SKU) for the item.
" }, "description": { "maxLength": 127, "type": "string", "description": "The detailed item description.", "x-gitbook-description-html": "The detailed item description.
" }, "category": { "type": "string", "description": "The item category type.The item category type.
The possible values are:
* DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the PayPal for Commerce Platform product.
* DIGITAL_GOODS - A tangible item that can be shipped with proof of delivery.
List of shopping cart items, to be displayed on the page. Read Line items for details.
" }, "Checkout": { "required": [ "amount", "created_at", "currency_code", "entity_id", "id", "updated_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "Checkout ID", "x-format": { "guid": true }, "x-gitbook-description-html": "Checkout ID
" }, "amount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Transaction amount - Transaction with zero amount value will be considered as account verification and by default implicitly capture will be set to false for AV transaction", "x-gitbook-description-html": "Transaction amount - Transaction with zero amount value will be considered as account verification and by default implicitly capture will be set to false for AV transaction
" }, "entity_id": { "type": "string", "description": "Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)", "x-format": { "guid": true }, "x-gitbook-description-html": "Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)
" }, "currency_code": { "type": "string", "description": "Currency code", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC" ], "x-gitbook-description-html": "Currency code
" }, "customer": { "type": "string", "description": "Customer UUID", "x-format": { "guid": true }, "x-gitbook-description-html": "Customer UUID
" }, "expiry_time": { "type": "string", "description": "Expiry time of the Checkout page. Defaults to 15 min from creation time. If a user tries to visit or use an expired Checkout, an error will be shown. Maximum value is 30 days.", "format": "date", "x-gitbook-description-html": "Expiry time of the Checkout page. Defaults to 15 min from creation time. If a user tries to visit or use an expired Checkout, an error will be shown. Maximum value is 30 days.
" }, "merchant_reference": { "maxLength": 50, "pattern": "^[^=+\\-@].*", "type": "string", "description": "Reference provided by Merchant to identify the Checkout and the transaction initiated from it", "x-gitbook-description-html": "Reference provided by Merchant to identify the Checkout and the transaction initiated from it
" }, "return_url": { "type": "string", "description": "URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed. If this parameter is used, the customer will be redirected after spending 10 seconds on the payment confirmation page provided by OnlinePay in case of HPP and PAYMENT LINK transactions. For IFRAME transaction the redirect is performed right after the checkout page without passing through the payment confirmation page.URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed. If this parameter is used, the customer will be redirected after spending 10 seconds on the payment confirmation page provided by OnlinePay in case of HPP and PAYMENT LINK transactions. For IFRAME transaction the redirect is performed right after the checkout page without passing through the payment confirmation page.
Note 1: The return_url accepts only securely connected URLs i.e., via https protocol.
Note 2: The time after which redirection happens can be customized using redirect_method.
Checkout created time
" }, "updated_at": { "type": "string", "description": "Checkout updated time", "format": "date-time", "x-gitbook-description-html": "Checkout updated time
" }, "transaction_id": { "type": "string", "description": "Id of a successfully processed transaction with the Checkout", "x-format": { "guid": true }, "x-gitbook-description-html": "Id of a successfully processed transaction with the Checkout
" }, "customer_ip": { "type": "string", "description": "Customer IP address from the last viewing of the Checkout page", "x-format": { "ip": { "cidr": "optional", "version": [ "ipv4", "ipv6" ] } }, "x-gitbook-description-html": "Customer IP address from the last viewing of the Checkout page
" }, "user_agent": { "maxLength": 256, "type": "string", "description": "User agent of the browser of the Customer from the last time the Checkout was viewed", "x-gitbook-description-html": "User agent of the browser of the Customer from the last time the Checkout was viewed
" }, "i18n": { "$ref": "#/components/schemas/I18nResponse" }, "events": { "$ref": "#/components/schemas/events" }, "status": { "type": "string", "description": "Checkout Status", "x-gitbook-description-html": "Checkout Status
" }, "display_line_items": { "type": "boolean", "description": "Indicates whether line items should be displayed on the page. Defaults to true", "default": true, "x-gitbook-description-html": "Indicates whether line items should be displayed on the page. Defaults to true
" }, "line_items": { "$ref": "#/components/schemas/line_items" }, "interaction_type": { "type": "string", "description": "Type of checkout. Allows for distinguishing payments accepted via different channels.Type of checkout. Allows for distinguishing payments accepted via different channels.
Possible Values:
* HPP - For payments done as Hosted Payments Page integration.
* IFRAME - For payments done as an Iframe integration.
* PAYMENT_LINK - For payments done through the Payment link feature in the merchant portal.
Payment method used on the checkout
" }, "url": { "type": "string", "description": "URL of the Checkout", "x-format": { "uri": true }, "x-gitbook-description-html": "URL of the Checkout
" }, "theme_id": { "type": "string", "description": "Parameter that was created within the create theme API call that applies the customizations upon the checkout interface. Read Theming for details.", "x-format": { "guid": true }, "x-gitbook-description-html": "Parameter that was created within the create theme API call that applies the customizations upon the checkout interface. Read Theming for details.
" }, "receipt_type": { "type": "string", "description": "Can be used to send different invoices to the customer.Can be used to send different invoices to the customer.
Possible Values:
* INVOICE
* FULL_RECEIPT
* SIMPLE_RECEIPT
* INVOICE_RECEIPT
General description of the document
" }, "customer_details": { "$ref": "#/components/schemas/customer_details" }, "promo_code": { "type": "string", "description": "A code defined by the merchant that affects the calculation of the total amount.", "x-gitbook-description-html": "A code defined by the merchant that affects the calculation of the total amount.
" }, "invoice_number": { "maxLength": 127, "type": "string", "description": "The invoice number to track this payment.The invoice number to track this payment.
Note: Valid for card payments only.
User id who created the checkout.
" }, "fraud_protection_data": { "$ref": "#/components/schemas/FraudProtectionData" }, "allow_customer_inputs": { "type": "boolean", "default": false, "description": "Allows customer to enter or update their billing/shipping information on the hosted payments page.Only applicable for HPP and PAYMENT_LINK interaction types.", "x-gitbook-description-html": "Allows customer to enter or update their billing/shipping information on the hosted payments page.Only applicable for HPP and PAYMENT_LINK interaction types.
" }, "surcharge_amount": { "type": "number", "description": "An optional additional amount representing the surcharge associated with a payment.", "x-gitbook-description-html": "An optional additional amount representing the surcharge associated with a payment.
" }, "redirect_method": { "type": "string", "enum": [ "DEFAULT", "HEADER_REDIRECT" ], "description": "Configures the redirect behaviour for return_url on successful payment when interaction type is either HPP or PAYMENT_LINK \n * DEFAULT: The customer will be redirected after spending 10 seconds on the payment confirmation page provided by Verifone. \n * HEADER_REDIRECT: The payment confirmation page is skipped and the customer is redirected immediately.Configures the redirect behaviour for return_url on successful payment when interaction type is either HPP or PAYMENT_LINK
\n* DEFAULT: The customer will be redirected after spending 10 seconds on the payment confirmation page provided by Verifone.
\n* HEADER_REDIRECT: The payment confirmation page is skipped and the customer is redirected immediately.
\nNote: This parameter does not have any effect when interaction type is IFRAME.
This change will remove the payment confirmation page from the user interface. Payment actions will now be managed through postMessage events.
Checkout Events:
* CHECKOUT_RENDERED: Indicates successful iFrame loading.
* CHECKOUT_RENDERED_FAILED: Signals iFrame loading failure.
* CARD_DETAILS_ENTERED: Triggered after the cardholder inputs card details.
* CHECKOUT_FAILED: Occurs when the checkout process encounters an error.
Payment Action listerer events:
* CONTINUE: Initiates the payment process.
Note: This parameter has no effect when the interaction type is HPP or PAYMENT_LINK.
This change will remove the payment confirmation page from the user interface. Payment actions will now be managed through postMessage events.
Checkout Events:
* CARD_CAPTURE_SUCCESS: Indicates successful card capture.
* CHECKOUT_COMPLETED: Signals successful completion of the checkout process.
* CHECKOUT_FAILED: Occurs when the checkout process encounters an error.
Note: This parameter has no effect when the interaction type is HPP or PAYMENT_LINK.
A 3-digit code which uniquely identify an error.
" }, "details": { "$ref": "#/components/schemas/details" }, "message": { "maxLength": 2048, "type": "string", "description": "A description of the error.", "x-gitbook-description-html": "A description of the error.
" }, "timestamp": { "type": "string", "description": "Error timestamp", "format": "date-time", "x-gitbook-description-html": "Error timestamp
" } }, "example": { "code": 400, "message": "Invalid request parameters", "timestamp": "2024-01-15T10:30:00Z" } }, "ApplePayCardConfig": { "required": [ "payment_contract_id", "sca_compliance_level", "threed_secure" ], "type": "object", "properties": { "sca_compliance_level": { "type": "string", "default": "NONE", "description": "Strong Customer Authentication (SCA) compliance level, possible values \n * NONE: No SCA required. \n *Deprecated WALLET: Apple Pay will indicate the PSP to trigger 3DS which in this case will be required.\n Details [here](https://developers.google.com/pay/api/web/reference/response-objects#assurance-details-specifications)\n *Deprecated FORCE_3DS: SCA will be triggered. Regarding the liability shift, please check\n [this page](https://developers.googleblog.com/en/google-pay-enabling-liability-shift-for-eligible-visa-device-token-transactions-globally/)\n *Note: Apple Pay is SCA compliant by design and 3DS check is not a mandatory function for processing transactions with this wallet. As a result, the previously supported WALLET and FORCE_3DS parameters are no longer relevant for Apple Pay transactions and have been deprecated.\n Supports only NONE. Any other values (WALLET or FORCE_3DS) are sanitized and ignored.", "enum": [ "NONE", "WALLET", "FORCE_3DS" ], "x-gitbook-description-html": "Strong Customer Authentication (SCA) compliance level, possible values
\n* NONE: No SCA required.
\n*Deprecated WALLET: Apple Pay will indicate the PSP to trigger 3DS which in this case will be required.\nDetails here
\n*Deprecated FORCE_3DS: SCA will be triggered. Regarding the liability shift, please check\nthis page
\n*Note: Apple Pay is SCA compliant by design and 3DS check is not a mandatory function for processing transactions with this wallet. As a result, the previously supported WALLET and FORCE_3DS parameters are no longer relevant for Apple Pay transactions and have been deprecated.\nSupports only NONE. Any other values (WALLET or FORCE_3DS) are sanitized and ignored.
Used for 3D-Secure payments
" }, "authorization_type": { "type": "string", "description": "Default: \"FINAL_AUTH\"Default: \"FINAL_AUTH\"
Other Possible Values: \"PRE_AUTH\"
Text: PRE_AUTH is used when a merchant wants to ensure shopper's funds availability at a later time.
Attention: If you are using PRE_AUTH function make sure capture_now is set as FALSE. Otherwise the PRE_AUTH will not work.
This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.
" }, { "$ref": "#/x-alt-definitions/paymentContractIdDef" } ], "x-format": { "guid": true }, "x-gitbook-description-html": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.
" }, "token_preference": { "$ref": "#/x-alt-definitions/token_preference" } } }, "apple_pay": { "type": "object", "description": "Apple Pay payment configuration", "properties": { "capture_now": { "type": "boolean", "description": "True - transaction will be sent as authCapture and automatically captured.True - transaction will be sent as authCapture and automatically captured.
False - transaction will be sent as auth and only authorized. NOT CAPTURED.
If you don't have any value in the capture_now parameter, at the moment of the call the value will be set as TRUE.
Indicates whether the card transaction should be processed as Account Validation request instead. If set to true, the amount provided for the Checkout would be ignored and the transaction be processed with amount: 0
" }, "card": { "$ref": "#/components/schemas/ApplePayCardConfig" } }, "example": { "capture_now": true, "card": { "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a", "sca_compliance_level": "NONE" } }, "x-gitbook-description-html": "Apple Pay payment configuration
" }, "FraudProtectionData": { "type": "object", "properties": { "fraud_protection_token": { "type": "string" }, "client_side_parameters": { "type": "object", "properties": { "org_id": { "type": "string" }, "web_session_id": { "type": "string" } } } } } }, "securitySchemes": { "BasicAuth": { "type": "http", "scheme": "basic", "description": "HTTP Basic authentication using entity credentials (username:password encoded in Base64).", "x-gitbook-description-html": "HTTP Basic authentication using entity credentials (username:password encoded in Base64).
" }, "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "OAuth 2.0 Bearer token obtained via the OIDC authentication endpoint.", "x-gitbook-description-html": "OAuth 2.0 Bearer token obtained via the OIDC authentication endpoint.
" } } }, "x-tagGroups": [ { "name": "Payments", "tags": [ "Checkout" ] }, { "name": "Customisation", "tags": [ "Theming", "Templating" ] }, { "name": "Reference", "tags": [ "Error codes" ] } ], "x-alt-definitions": { "paymentContractIdDef": { "type": "object", "properties": { "AMEX": { "type": "string", "description": "Payment Contract to be used for AMEX card payments", "x-format": { "guid": true }, "x-gitbook-description-html": "Payment Contract to be used for AMEX card payments
" }, "JCB": { "type": "string", "description": "Payment Contract to be used for JCB card payments", "x-format": { "guid": true }, "x-gitbook-description-html": "Payment Contract to be used for JCB card payments
" }, "MASTERCARD": { "type": "string", "description": "Payment Contract to be used for MASTERCARD card payments", "x-format": { "guid": true }, "x-gitbook-description-html": "Payment Contract to be used for MASTERCARD card payments
" }, "VISA": { "type": "string", "description": "Payment Contract to be used for VISA card payments", "x-format": { "guid": true }, "x-gitbook-description-html": "Payment Contract to be used for VISA card payments
" } } }, "threedSecureDef": { "type": "object", "description": "Used for 3D-Secure payments", "properties": { "accountAgeIndicator": { "type": "string", "description": "Length of time cardholder has had account.Length of time cardholder has had account.
Possible Values:
* 01 - No account
* 02 - Created during transaction
* 03 - Less than 30 days
* 04 - 30-60 days
* 05 - More than 60 days
Date the cardholder opened the account. Format: YYYYMMDD
Length of time since the last change to the cardholder account. This includes shipping address,
new payment account or new user added. Possible Values:
* 01 - Changed during transaction
* 02 - Less than 30 days
* 03 - 30-60 days
* 04 - More than 60 days
Date the cardholder's account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added. Format: YYYYMMDD
Length of time since the cardholder changed or reset the password on the account.
Possible Values:
* 01 - No change
* 02 - Changed during transaction
* 03 - Less than 30 days
* 04 - 30-60 days
* 05 - More than 60 days
Date the cardholder last changed or reset password on account. Format: YYYYMMDD
Additional cardholder account information.
" }, "accountPurchases": { "type": "integer", "description": "Number of purchases with this cardholder account during the previous six months.", "maximum": 9999, "x-gitbook-description-html": "Number of purchases with this cardholder account during the previous six months.
" }, "acsWindowSize": { "type": "string", "description": "An override field that a merchant can pass in to set the challenge window size to display to the endAn override field that a merchant can pass in to set the challenge window size to display to the end
cardholder.The ACS will reply with content that is formatted appropriately to this window size to allow
for the best user experience. The sizes are width x height in pixels of the window displayed in
the cardholder browser window. Possible values:
* 01 - 250x400
* 02 - 390x400
* 03 - 500x600
* 04 - 600x400
* 05 - Full page
Number of add card attempts in the last 24 hours.
" }, "addressMatch": { "type": "string", "description": "Indicates whether cardholder billing and shipping addresses match.Indicates whether cardholder billing and shipping addresses match.
Possible Values:
* Y - Shipping address matches billing address
* N - Shipping address does not match billing address
Mechanism used by the cardholder to authenticate to the 3DS requester.
Possible Values:
* 01 - No authentication occurred (e.g. Guest Checkout)
* 02 - Login to the cardholder account at the Merchant system using Merchant system credentials
* 03 - Login to the cardholder account at the Merchant system using a Federated ID
* 04 - Login to the cardholder account at the Merchant system using Issuer credentials
* 05 - Login to the cardholder account at the Merchant system using third-party authentication
* 06 - Login to the cardholder account at the Merchant system using FIDO Authenticator
Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM
Data that documents and supports a specific authentication
process that was sent in the AlternateAuthenticationMethod field.
The ID of the threeDSContract used.
" }, "authenticationIndicator": { "type": "string", "description": "Indicates the type of Authentication request. 01 - Payment transactionIndicates the type of Authentication request. 01 - Payment transaction
02 - Recurring transaction
03 - Installment transaction
04 - Add card
05 - Maintain card
06 - Cardholder verification as part of EMV token ID&V
Merchant category code (MCC) NOTE: This field is required by Mastercard and VISA Brazil extensions.
NOTE: This is a 2.0 required field, Cardinal will default to 01 on Merchant Configuration
- can be overridden by the merchant. Possible Values:
* 01 - No preference
* 02 - No challenge requested
* 03 - Challenge requested (3DS Requestor Preference)
* 04 - Challenge requested (Mandate)
* 05 - No challenge requested (transactional risk analysis is already performed)
* 06 - No challenge requested (Data share only)
* 07 - No challenge requested (strong consumer authentication is already performed)
* 08 - No challenge requested (utilise whitelist exemption if no challenge required)
* 09 - Challenge requested (whitelist prompt requested if challenge required)
* 90 - CB specific value
For electronic delivery, email address to which the merchandise was delivered.
" }, "deliveryTimeFrame": { "type": "string", "description": "Indicates the delivery timeframe.Indicates the delivery timeframe.
Possible Values:
* 01 - Electronic delivery
* 02 - Same day shipping
* 03 - Overnight shipping
* 04 - Two or more day shipping
Whether 3DS should be used.
" }, "fraudActivity": { "type": "string", "description": "Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account.Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account.
Possible Values:
* 01 - No suspicious activity
* 02 - Suspicious activity observed
The purchase amount total for prepaid gift cards in major units.
Example: $123.45 USD = 12345
ISO 4217 currency code for the gift card purchased.
" }, "giftCardCount": { "type": "integer", "description": "Total count of individual prepaid gift cards purchased.", "maximum": 99, "x-gitbook-description-html": "Total count of individual prepaid gift cards purchased.
" }, "installment": { "type": "number", "description": "Indicates the maximum number of authorizations for installment payments. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments. ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **", "minimum": 2, "maximum": 999, "x-gitbook-description-html": "Indicates the maximum number of authorizations for installment payments. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments. ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **
" }, "messageCategory": { "type": "string", "description": "Category of the message for a specific use case.Category of the message for a specific use case.
Possible Values:
* 01 - PA (payment)
* 02 - NPA (non payment)
NOTE: Default is payment (01). Configured on Merchant account, or can be overridden on transaction.
Indicates the type of payment.The value from this field will be mapped to the data field on the CB-USECASE extension
Possible Values:
* 01 - Single Payment
* 02 - Fixed Amount and Term Subscription
* 03 - Payment By Instalments
* 04 - Payment By Shipment
* 05 - Other Recurring Payments
NOTE: Required for CB transactions (Required if message_category = 01, or message_category = 02 and authentication_indicator = 02 or 03
Indicates the length of time that the payment account was enrolled in the merchant account.
Possible Values:
* 01 - No account (guest checkout)
* 02 - During the transaction
* 03 - Less than 30 days
* 04 - 30-60 days
* 05 - More than 60 days
Date the payment account was added to the cardholder account. Format: YYYYMMDD
Indicates whether cardholder is placing an order with a future availability or release date.
Possible Values:
* 01 - Merchandise available
* 02 - Future availability
Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD
This field carry data that the ACS can use to verify the authentication process
" }, "priorAuthenticationMethod": { "type": "string", "description": "Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor.Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor.
* 01 - Frictionless authentication occurred by ACS
* 02 - Cardholder challenge occurred by ACS
* 03 - AVS verified
* 04 - Other issuer methods
Date and time in UTC of the prior cardholder authentication. Format: YYYYMMDDHHMM
This data element contains a ACS Transaction ID for a prior authenticated transaction.
For example, the first recurring transaction that was authenticated with the cardholder
Merchant product code.
Possible Values:
* PHY - Goods/Service Purchase
* CHA - Check Acceptance
* ACF - Account Funding
* QCT - Quasi-Cash Transaction
* PAL - Prepaid Activation and Load
NOTE: This value defaults to PHY. This field can be used to override that value if applicable.
The date after which no further recurring authorizations should be performed. Format: YYYYMMDD ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **
Conditional: Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168 ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **
" }, "reorderIndicator": { "type": "string", "description": "Indicates whether cardholder is placing an order with a future availability or release date.Indicates whether cardholder is placing an order with a future availability or release date.
Possible Values:
* 01 - Merchandise available
* 02 - Future availability
This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID.
NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is,
configured on the Merchant's profile.
This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID.
NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is configured
on the Merchant's profile.
Indicates when the shipping address used for transaction was first used.
Possible Values:
* 01 - This transaction
* 02 - Less than 30 days
* 03 - 30-60 days
* 04 - More than 60 days
Date when the shipping address used for this transaction was first used.
Format: YYYYMMDD
Indicates shipping method chosen for the transaction.
Possible Values:
* 01 - Ship to cardholder billing address
* 02 - Ship to another verified address on file with merchant
* 03 - Ship to address that is different than billing address
* 04 - Ship to store (store address should be populated on request)
* 05 - Digital goods
* 06 - Travel and event tickets, not shipped
* 07 - Other
Indicates if the cardholder name on the account is identical to the
shipping name used for the transaction. Possible Values:
* 01 - Account and shipping name identical
* 02 - Account and shipping name differ
Total items in the shopping cart of the shopper
" }, "merchantScore": { "type": "string", "description": "Merchant score", "maxLength": 20, "x-format": { "alphanum": true }, "x-gitbook-description-html": "Merchant score
" }, "transactionCountDay": { "type": "integer", "description": "Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.
Number of transactions (successful or abandoned) for this cardholder account within the last year.
Transaction mode identifier. Identifies the channel the transaction originates from. Available Options:
M - Moto (Mail Order Telephone Order)
P - Mobile Device
R - Retail (Physical Store)
S - Computer Device
T - Tablet Device
This field contains the 3DS version that can be leveraged to force a transaction down the 1.0 rails.
" }, "whiteListStatus": { "type": "string", "description": "Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor.", "enum": [ "Y", "N" ], "x-gitbook-description-html": "Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor.
" }, "whiteListStatusSource": { "type": "string", "description": "This data element will be populated by the system setting Whitelist Status.", "enum": [ 1, 2, 3 ], "x-gitbook-description-html": "This data element will be populated by the system setting Whitelist Status.
" } }, "required": [ "threeDSContractId", "transactionMode" ], "x-gitbook-description-html": "Used for 3D-Secure payments
" }, "card": { "type": "object", "properties": { "scaComplianceLevel": { "type": "string", "description": "Strong Customer Authentication (SCA) compliance level, possible values \n * NONE: No SCA required. \n * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. \n * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS", "x-gitbook-description-html": "Strong Customer Authentication (SCA) compliance level, possible values
\n* NONE: No SCA required.
\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.
\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:
Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.
" }, "encryptedCard": { "type": "string", "description": "Encrypted card details", "maxLength": 4096, "x-gitbook-description-html": "Encrypted card details
" }, "cardEncryptionKeyAlias": { "type": "string", "description": "Public key alias", "x-gitbook-description-html": "Public key alias
" }, "returnUrl": { "type": "string", "description": "URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed.", "x-format": { "uri": true }, "x-gitbook-description-html": "URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed.
" } }, "required": [ "scaComplianceLevel", "threedSecure" ] }, "Model1": { "type": "object", "properties": { "scaComplianceLevel": { "type": "string", "description": "Strong Customer Authentication (SCA) compliance level, possible values \n * NONE: No SCA required. \n * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. \n * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS", "x-gitbook-description-html": "Strong Customer Authentication (SCA) compliance level, possible values
\n* NONE: No SCA required.
\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.
\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:
Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.
" }, "encryptedCard": { "type": "string", "description": "Encrypted card details", "maxLength": 4096, "x-gitbook-description-html": "Encrypted card details
" }, "cardEncryptionKeyAlias": { "type": "string", "description": "Public key alias", "x-gitbook-description-html": "Public key alias
" }, "returnUrl": { "type": "string", "description": "URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed.", "x-format": { "uri": true }, "x-gitbook-description-html": "URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed.
" } }, "required": [ "scaComplianceLevel" ] }, "CVV": { "type": "object", "properties": { "validation_rule": { "type": "string", "default": "NONE", "enum": [ "NONE", "LUHN" ] }, "usage": { "type": "string", "default": "REQUIRED", "enum": [ "REQUIRED", "PROHIBITED" ] } } }, "input_overrides": { "type": "object", "title": "Payment Details", "properties": { "CVV": { "$ref": "#/x-alt-definitions/CVV" }, "CREDIT_TERM": { "$ref": "#/x-alt-definitions/CVV" }, "IDENTITY_CARD_NUMBER": { "$ref": "#/x-alt-definitions/CVV" } } }, "Model2": { "type": "object", "title": "Card Brands", "description": "Need to enable merchants to configure additional input fields on checkout for the input in scope.", "properties": { "AMEX": { "$ref": "#/x-alt-definitions/input_overrides" }, "JCB": { "$ref": "#/x-alt-definitions/input_overrides" }, "MASTERCARD": { "$ref": "#/x-alt-definitions/input_overrides" }, "VISA": { "$ref": "#/x-alt-definitions/input_overrides" } }, "x-gitbook-description-html": "Need to enable merchants to configure additional input fields on checkout for the input in scope.
" }, "threed_secure_duplicate": { "type": "object", "properties": { "account_age_indicator": { "type": "string", "description": "Length of time cardholder has had account.Length of time cardholder has had account.
Possible Values:
* 01 - No account
* 02 - Created during transaction
* 03 - Less than 30 days
* 04 - 30-60 days
* 05 - More than 60 days
Date the cardholder opened the account. Format: YYYYMMDD
Length of time since the last change to the cardholder account. This includes shipping address,
new payment account or new user added. Possible Values:
* 01 - Changed during transaction
* 02 - Less than 30 days
* 03 - 30-60 days
* 04 - More than 60 days
Date the cardholder's account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added. Format: YYYYMMDD
Length of time since the cardholder changed or reset the password on the account.
Possible Values:
* 01 - No change
* 02 - Changed during transaction
* 03 - Less than 30 days
* 04 - 30-60 days
* 05 - More than 60 days
Date the cardholder last changed or reset password on account. Format: YYYYMMDD
Additional cardholder account information.
" }, "account_purchases": { "type": "integer", "description": "Number of purchases with this cardholder account during the previous six months.", "maximum": 9999, "x-gitbook-description-html": "Number of purchases with this cardholder account during the previous six months.
" }, "acs_window_size": { "type": "string", "description": "An override field that a merchant can pass in to set the challenge window size to display to the endAn override field that a merchant can pass in to set the challenge window size to display to the end
cardholder.The ACS will reply with content that is formatted appropriately to this window size to allow
for the best user experience. The sizes are width x height in pixels of the window displayed in
the cardholder browser window. Possible values:
* 01 - 250x400
* 02 - 390x400
* 03 - 500x600
* 04 - 600x400
* 05 - Full page
Number of add card attempts in the last 24 hours.
" }, "address_match": { "type": "string", "description": "Indicates whether cardholder billing and shipping addresses match.Indicates whether cardholder billing and shipping addresses match.
Possible Values:
* Y - Shipping address matches billing address
* N - Shipping address does not match billing address
Mechanism used by the cardholder to authenticate to the 3DS requester.
Possible Values:
* 01 - No authentication occurred (e.g. Guest Checkout)
* 02 - Login to the cardholder account at the Merchant system using Merchant system credentials
* 03 - Login to the cardholder account at the Merchant system using a Federated ID
* 04 - Login to the cardholder account at the Merchant system using Issuer credentials
* 05 - Login to the cardholder account at the Merchant system using third-party authentication
* 06 - Login to the cardholder account at the Merchant system using FIDO Authenticator
Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM
Data that documents and supports a specific authentication
process that was sent in the AlternateAuthenticationMethod field.
The ID of the threeDSContract used.
" }, "authentication_indicator": { "type": "string", "description": "Indicates the type of Authentication request. 01 - Payment transactionIndicates the type of Authentication request. 01 - Payment transaction
02 - Recurring transaction
03 - Installment transaction
04 - Add card
05 - Maintain card
06 - Cardholder verification as part of EMV token ID&V
Merchant category code (MCC) NOTE: This field is required by Mastercard and VISA Brazil extensions.
NOTE: This is a 2.0 required field, Cardinal will default to 01 on Merchant Configuration
- can be overridden by the merchant. Possible Values:
* 01 - No preference
* 02 - No challenge requested
* 03 - Challenge requested (3DS Requestor Preference)
* 04 - Challenge requested (Mandate)
* 05 - No challenge requested (transactional risk analysis is already performed)
* 06 - No challenge requested (Data share only)
* 07 - No challenge requested (strong consumer authentication is already performed)
* 08 - No challenge requested (utilise whitelist exemption if no challenge required)
* 09 - Challenge requested (whitelist prompt requested if challenge required)
* 90 - CB specific value
For electronic delivery, email address to which the merchandise was delivered.
" }, "delivery_time_frame": { "type": "string", "description": "Indicates the delivery timeframe.Indicates the delivery timeframe.
Possible Values:
* 01 - Electronic delivery
* 02 - Same day shipping
* 03 - Overnight shipping
* 04 - Two or more day shipping
Whether 3DS should be used.
" }, "fraud_activity": { "type": "string", "description": "Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account.Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account.
Possible Values:
* 01 - No suspicious activity
* 02 - Suspicious activity observed
The purchase amount total for prepaid gift cards in major units.
Example: $123.45 USD = 12345
ISO 4217 currency code for the gift card purchased.
" }, "gift_card_count": { "type": "integer", "description": "Total count of individual prepaid gift cards purchased.", "maximum": 99, "x-gitbook-description-html": "Total count of individual prepaid gift cards purchased.
" }, "installment": { "type": "number", "description": "Indicates the maximum number of authorizations for installment payments. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments. ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **", "minimum": 2, "maximum": 999, "x-gitbook-description-html": "Indicates the maximum number of authorizations for installment payments. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments. ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **
" }, "message_category": { "type": "string", "description": "Category of the message for a specific use case.Category of the message for a specific use case.
Possible Values:
* 01 - PA (payment)
* 02 - NPA (non payment)
NOTE: Default is payment (01). Configured on Merchant account, or can be overridden on transaction.
Indicates the type of payment.The value from this field will be mapped to the data field on the CB-USECASE extension
Possible Values:
* 01 - Single Payment
* 02 - Fixed Amount and Term Subscription
* 03 - Payment By Instalments
* 04 - Payment By Shipment
* 05 - Other Recurring Payments
NOTE: Required for CB transactions (Required if message_category = 01, or message_category = 02 and authentication_indicator = 02 or 03
Indicates the length of time that the payment account was enrolled in the merchant account.
Possible Values:
* 01 - No account (guest checkout)
* 02 - During the transaction
* 03 - Less than 30 days
* 04 - 30-60 days
* 05 - More than 60 days
Date the payment account was added to the cardholder account. Format: YYYYMMDD
Indicates whether cardholder is placing an order with a future availability or release date.
Possible Values:
* 01 - Merchandise available
* 02 - Future availability
Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD
This field carry data that the ACS can use to verify the authentication process
" }, "prior_authentication_method": { "type": "string", "description": "Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor.Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor.
* 01 - Frictionless authentication occurred by ACS
* 02 - Cardholder challenge occurred by ACS
* 03 - AVS verified
* 04 - Other issuer methods
Date and time in UTC of the prior cardholder authentication. Format: YYYYMMDDHHMM
This data element contains a ACS Transaction ID for a prior authenticated transaction.
For example, the first recurring transaction that was authenticated with the cardholder
Merchant product code.
Possible Values:
* PHY - Goods/Service Purchase
* CHA - Check Acceptance
* ACF - Account Funding
* QCT - Quasi-Cash Transaction
* PAL - Prepaid Activation and Load
NOTE: This value defaults to PHY. This field can be used to override that value if applicable.
The date after which no further recurring authorizations should be performed. Format: YYYYMMDD ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **
Conditional: Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168 ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **
" }, "reorder_indicator": { "type": "string", "description": "Indicates whether cardholder is placing an order with a future availability or release date.Indicates whether cardholder is placing an order with a future availability or release date.
Possible Values:
* 01 - Merchandise available
* 02 - Future availability
This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID.
NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is,
configured on the Merchant's profile.
This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID.
NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is configured
on the Merchant's profile.
Indicates when the shipping address used for transaction was first used.
Possible Values:
* 01 - This transaction
* 02 - Less than 30 days
* 03 - 30-60 days
* 04 - More than 60 days
Date when the shipping address used for this transaction was first used.
Format: YYYYMMDD
Indicates shipping method chosen for the transaction.
Possible Values:
* 01 - Ship to cardholder billing address
* 02 - Ship to another verified address on file with merchant
* 03 - Ship to address that is different than billing address
* 04 - Ship to store (store address should be populated on request)
* 05 - Digital goods
* 06 - Travel and event tickets, not shipped
* 07 - Other
Indicates if the cardholder name on the account is identical to the
shipping name used for the transaction. Possible Values:
* 01 - Account and shipping name identical
* 02 - Account and shipping name differ
Total items in the shopping cart of the shopper
" }, "merchant_score": { "type": "string", "description": "Merchant score", "maxLength": 20, "x-format": { "alphanum": true }, "x-gitbook-description-html": "Merchant score
" }, "transaction_count_day": { "type": "integer", "description": "Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.
Number of transactions (successful or abandoned) for this cardholder account within the last year.
Transaction mode identifier. Identifies the channel the transaction originates from. Available Options:
M - Moto (Mail Order Telephone Order)
P - Mobile Device
R - Retail (Physical Store)
S - Computer Device
T - Tablet Device
This field contains the 3DS version that can be leveraged to force a transaction down the 1.0 rails.
" }, "white_list_status": { "type": "string", "description": "Enables the communication of trusted beneficiary between the ACS, the DS and the 3DS Requestor.Enables the communication of trusted beneficiary between the ACS, the DS and the 3DS Requestor.
Possible Values:
* Y - 3DS Requestor is trustlisted by cardholder
* N - 3DS Requestor is not trustlisted by cardholder
* E - Not eligible as determined by issuer
* P - Pending confirmation by cardholder
* R - Cardholder rejected
* U - Trustlist status unknown, unavailable, or does not apply
Note: This field may be returned for 2.1.0 if the MasterCard PSD2 extensions are passed and issuer supports them.
This data element will be populated by the system setting Whitelist Status.
" } }, "required": [ "threeds_contract_id", "transaction_mode" ] }, "Model3": { "type": "object", "properties": { "sca_compliance_level": { "type": "string", "description": "Strong Customer Authentication (SCA) compliance level, possible values \n * NONE: No SCA required. \n * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. \n * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS", "x-gitbook-description-html": "Strong Customer Authentication (SCA) compliance level, possible values
\n* NONE: No SCA required.
\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.
\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:
Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.
" }, "encrypted_card": { "type": "string", "description": "Encrypted card details", "maxLength": 4096, "x-gitbook-description-html": "Encrypted card details
" }, "card_encryption_key_alias": { "type": "string", "description": "Public key alias", "x-gitbook-description-html": "Public key alias
" }, "return_url": { "type": "string", "description": "URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed. If this parameter is used, the customer will be redirected after spending 10 seconds on the payment confirmation page provided by OnlinePay in case of HPP and PAYMENT LINK transactions. For IFRAME transaction the redirect is performed right after the checkout page without passing through the payment confirmation page.URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed. If this parameter is used, the customer will be redirected after spending 10 seconds on the payment confirmation page provided by OnlinePay in case of HPP and PAYMENT LINK transactions. For IFRAME transaction the redirect is performed right after the checkout page without passing through the payment confirmation page.
Note: The time after which redirection happens can be customized using redirect_method.
Strong Customer Authentication (SCA) compliance level, possible values
\n* NONE: No SCA required.
\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.
\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:
Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.
" }, "encrypted_card": { "type": "string", "description": "Encrypted card details", "maxLength": 4096, "x-gitbook-description-html": "Encrypted card details
" }, "card_encryption_key_alias": { "type": "string", "description": "Public key alias", "x-gitbook-description-html": "Public key alias
" }, "return_url": { "type": "string", "description": "URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed. If this parameter is used, the customer will be redirected after spending 10 seconds on the payment confirmation page provided by OnlinePay in case of HPP and PAYMENT LINK transactions. For IFRAME transaction the redirect is performed right after the checkout page without passing through the payment confirmation page.URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed. If this parameter is used, the customer will be redirected after spending 10 seconds on the payment confirmation page provided by OnlinePay in case of HPP and PAYMENT LINK transactions. For IFRAME transaction the redirect is performed right after the checkout page without passing through the payment confirmation page.
Note: The time after which redirection happens can be customized using redirect_method.
The token scope under which a token gets created
" }, "tokenExpiryDate": { "type": "string", "format": "date", "description": "Token expiry date", "x-gitbook-description-html": "Token expiry date
" }, "tokenType": { "type": "string", "description": "Token type", "enum": [ "REUSE", "REUSE_AND_ANALYTICS", "ANALYTICS" ], "x-gitbook-description-html": "Token type
" } }, "required": [ "tokenScope" ], "x-gitbook-description-html": "Read Tokenization for additional information
" }, "Model5": { "type": "object", "properties": { "scaComplianceLevel": { "type": "string", "description": "Strong Customer Authentication (SCA) compliance level, possible values \n * NONE: No SCA required. \n * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. \n * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS", "x-gitbook-description-html": "Strong Customer Authentication (SCA) compliance level, possible values
\n* NONE: No SCA required.
\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.
\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:
Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.
" }, "shopperInteraction": { "type": "string", "description": "Shopper interaction to send within the payment request", "default": "ECOMMERCE", "enum": [ "ECOMMERCE", "MAIL", "TELEPHONE" ], "x-gitbook-description-html": "Shopper interaction to send within the payment request
" }, "paymentContractId": { "type": "string", "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.", "x-format": { "guid": true }, "required": [ "paymentContractId" ], "x-alternatives": [ { "type": "string", "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.", "x-format": { "guid": true }, "x-gitbook-description-html": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.
" }, { "$ref": "#/x-alt-definitions/paymentContractIdDef" } ], "x-gitbook-description-html": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.
" }, "tokenPreference": { "$ref": "#/x-alt-definitions/tokenPreferenceDef" } }, "required": [ "scaComplianceLevel", "threedSecure", "paymentContractId" ] }, "Model6": { "type": "object", "properties": { "scaComplianceLevel": { "type": "string", "description": "Strong Customer Authentication (SCA) compliance level, possible values \n * NONE: No SCA required. \n * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. \n * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS", "x-gitbook-description-html": "Strong Customer Authentication (SCA) compliance level, possible values
\n* NONE: No SCA required.
\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.
\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:
Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.
" }, "shopperInteraction": { "type": "string", "description": "Shopper interaction to send within the payment request", "default": "ECOMMERCE", "enum": [ "ECOMMERCE", "MAIL", "TELEPHONE" ], "x-gitbook-description-html": "Shopper interaction to send within the payment request
" }, "paymentContractId": { "type": "string", "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.", "x-format": { "guid": true }, "required": [ "paymentContractId" ], "x-alternatives": [ { "type": "string", "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.", "x-format": { "guid": true }, "x-gitbook-description-html": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.
" }, { "$ref": "#/x-alt-definitions/paymentContractIdDef" } ], "x-gitbook-description-html": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.
" }, "tokenPreference": { "$ref": "#/x-alt-definitions/tokenPreferenceDef" } }, "required": [ "scaComplianceLevel", "paymentContractId" ] }, "Model7": { "type": "object", "properties": { "scaComplianceLevel": { "type": "string", "enum": [ "NONE", "WALLET" ] }, "authorizationType": { "type": "string", "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.", "default": "FINAL_AUTH", "x-gitbook-description-html": "Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.
" }, "shopperInteraction": { "type": "string", "description": "Shopper interaction to send within the payment request", "default": "ECOMMERCE", "enum": [ "ECOMMERCE", "MAIL", "TELEPHONE" ], "x-gitbook-description-html": "Shopper interaction to send within the payment request
" }, "paymentContractId": { "type": "string", "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.", "x-format": { "guid": true }, "required": [ "paymentContractId" ], "x-alternatives": [ { "type": "string", "description": "Payment Contract Id", "x-format": { "guid": true }, "x-gitbook-description-html": "Payment Contract Id
" }, { "$ref": "#/x-alt-definitions/paymentContractIdDef" } ], "x-gitbook-description-html": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.
" }, "tokenPreference": { "$ref": "#/x-alt-definitions/tokenPreferenceDef" } }, "required": [ "paymentContractId" ] }, "Model8": { "type": "object", "properties": { "scaComplianceLevel": { "type": "string", "description": "Strong Customer Authentication (SCA) compliance level, possible values \n * NONE: No SCA required. \n * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. \n * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS", "x-gitbook-description-html": "Strong Customer Authentication (SCA) compliance level, possible values
\n* NONE: No SCA required.
\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.
\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:
Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.
" } }, "required": [ "scaComplianceLevel", "threedSecure" ] }, "Model9": { "type": "object", "properties": { "scaComplianceLevel": { "type": "string", "description": "Strong Customer Authentication (SCA) compliance level, possible values \n * NONE: No SCA required. \n * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. \n * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS", "x-gitbook-description-html": "Strong Customer Authentication (SCA) compliance level, possible values
\n* NONE: No SCA required.
\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.
\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:
Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.
" } }, "required": [ "scaComplianceLevel" ] }, "Model10": { "type": "object", "properties": { "imageUrl": { "type": "string", "description": "Image URL for the line item", "maxLength": 2000, "x-format": { "uri": true }, "x-gitbook-description-html": "Image URL for the line item
" }, "itemUrl": { "type": "string", "description": "Item URL for the line item", "maxLength": 2000, "x-format": { "uri": true }, "x-gitbook-description-html": "Item URL for the line item
" }, "name": { "type": "string", "description": "Descriptive name of the order line item", "maxLength": 255, "x-gitbook-description-html": "Descriptive name of the order line item
" }, "quantity": { "type": "integer", "default": 1, "description": "Quantity of the order line item", "x-gitbook-description-html": "Quantity of the order line item
" }, "unitPrice": { "type": "number", "description": "Unit Price", "x-gitbook-description-html": "Unit Price
" }, "unitPriceTax": { "type": "number", "description": "Unit Price Tax", "x-gitbook-description-html": "Unit Price Tax
" }, "taxRate": { "type": "number", "description": "Additional details specific to this type of event", "x-gitbook-description-html": "Additional details specific to this type of event
" }, "totalTaxAmount": { "type": "number", "description": "Total tax amount", "x-gitbook-description-html": "Total tax amount
" }, "totalAmount": { "type": "number", "description": "Total Amount", "x-gitbook-description-html": "Total Amount
" }, "sku": { "type": "string", "description": "The stock keeping unit (SKU) for the item.", "maxLength": 127, "x-gitbook-description-html": "The stock keeping unit (SKU) for the item.
" }, "description": { "type": "string", "description": "The detailed item description.", "maxLength": 127, "x-gitbook-description-html": "The detailed item description.
" }, "category": { "type": "string", "description": "The item category type.The item category type.
The possible values are:
* DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the PayPal for Commerce Platform product.
* DIGITAL_GOODS - A tangible item that can be shipped with proof of delivery.
List of shopping cart items, to be displayed on the page. Read Line items for details.
" }, "Model11": { "type": "object", "properties": { "imageUrl": { "type": "string", "description": "Image URL for the line item", "maxLength": 2000, "x-format": { "uri": true }, "x-gitbook-description-html": "Image URL for the line item
" }, "itemUrl": { "type": "string", "description": "Item URL for the line item", "maxLength": 2000, "x-format": { "uri": true }, "x-gitbook-description-html": "Item URL for the line item
" }, "name": { "type": "string", "description": "Descriptive name of the order line item", "maxLength": 255, "x-gitbook-description-html": "Descriptive name of the order line item
" }, "quantity": { "type": "integer", "default": 1, "description": "Quantity of the order line item", "x-gitbook-description-html": "Quantity of the order line item
" }, "unitPrice": { "type": "number", "description": "Unit Price", "x-gitbook-description-html": "Unit Price
" }, "unitPriceTax": { "type": "number", "description": "Unit Price Tax", "x-gitbook-description-html": "Unit Price Tax
" }, "taxRate": { "type": "number", "description": "Additional details specific to this type of event", "x-gitbook-description-html": "Additional details specific to this type of event
" }, "totalTaxAmount": { "type": "number", "description": "Total tax amount", "x-gitbook-description-html": "Total tax amount
" }, "totalAmount": { "type": "number", "description": "Total Amount", "x-gitbook-description-html": "Total Amount
" }, "sku": { "type": "string", "description": "The stock keeping unit (SKU) for the item.", "maxLength": 127, "x-gitbook-description-html": "The stock keeping unit (SKU) for the item.
" }, "description": { "type": "string", "description": "The detailed item description.", "maxLength": 127, "x-gitbook-description-html": "The detailed item description.
" }, "category": { "type": "string", "description": "The item category type.The item category type.
The possible values are:
* DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the PayPal for Commerce Platform product.
* DIGITAL_GOODS - A tangible item that can be shipped with proof of delivery.
Need to enable merchants to configure additional input fields on checkout for the input in scope.
" }, "token_preference": { "type": "object", "description": "Read Tokenization for additional information", "properties": { "token_scope": { "type": "string", "description": "The token scope under which a token gets created", "x-format": { "guid": true }, "x-gitbook-description-html": "The token scope under which a token gets created
" }, "token_expiry_date": { "type": "string", "format": "date", "description": "Token expiry date", "x-gitbook-description-html": "Token expiry date
" }, "token_type": { "type": "string", "description": "Token type", "enum": [ "REUSE", "REUSE_AND_ANALYTICS", "ANALYTICS" ], "x-gitbook-description-html": "Token type
" } }, "required": [ "token_scope" ], "x-gitbook-description-html": "Read Tokenization for additional information
" }, "card_token_preference": { "type": "object", "description": "Read Tokenization for additional information", "properties": { "token_scope": { "type": "string", "description": "The token scope under which a token gets created", "x-format": { "guid": true }, "x-gitbook-description-html": "The token scope under which a token gets created
" }, "token_expiry_date": { "type": "string", "format": "date", "description": "Token expiry date", "x-gitbook-description-html": "Token expiry date
" }, "token_type": { "type": "string", "description": "Token type", "enum": [ "REUSE", "REUSE_AND_ANALYTICS", "ANALYTICS" ], "x-gitbook-description-html": "Token type
" }, "reuse_token_type": { "type": "string", "description": "Reuse token type", "enum": [ "TAVE", "CHASE", "INTERNAL" ], "x-gitbook-description-html": "Reuse token type
" } }, "required": [ "token_scope" ], "x-gitbook-description-html": "Read Tokenization for additional information
" }, "Model16": { "type": "object", "properties": { "sca_compliance_level": { "type": "string", "description": "Strong Customer Authentication (SCA) compliance level, possible values \n * NONE: No SCA required. \n * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. \n * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS", "x-gitbook-description-html": "Strong Customer Authentication (SCA) compliance level, possible values
\n* NONE: No SCA required.
\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.
\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:
Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.
" }, "shopper_interaction": { "$ref": "#/components/schemas/shopper_interaction" }, "payment_contract_id": { "type": "string", "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.", "x-format": { "guid": true }, "required": [ "payment_contract_id" ], "x-alternatives": [ { "type": "string", "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.", "x-format": { "guid": true }, "x-gitbook-description-html": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.
" }, { "$ref": "#/x-alt-definitions/paymentContractIdDef" } ], "x-gitbook-description-html": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.
" }, "token_preference": { "$ref": "#/x-alt-definitions/token_preference" } }, "required": [ "sca_compliance_level", "threed_secure", "payment_contract_id" ] }, "Model18": { "type": "object", "properties": { "sca_compliance_level": { "type": "string", "enum": [ "NONE", "WALLET" ] }, "authorization_type": { "type": "string", "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.", "default": "FINAL_AUTH", "x-gitbook-description-html": "Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.
" }, "shopper_interaction": { "$ref": "#/components/schemas/shopper_interaction" }, "payment_contract_id": { "type": "string", "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.", "x-format": { "guid": true }, "required": [ "payment_contract_id" ], "x-alternatives": [ { "type": "string", "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.", "x-format": { "guid": true }, "x-gitbook-description-html": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.
" }, { "$ref": "#/x-alt-definitions/paymentContractIdDef" } ], "x-gitbook-description-html": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.
" }, "token_preference": { "$ref": "#/x-alt-definitions/token_preference" } }, "required": [ "payment_contract_id" ] }, "Model19": { "type": "object", "properties": { "sca_compliance_level": { "type": "string", "description": "Strong Customer Authentication (SCA) compliance level, possible values \n * NONE: No SCA required. \n * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. \n * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS", "x-gitbook-description-html": "Strong Customer Authentication (SCA) compliance level, possible values
\n* NONE: No SCA required.
\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.
\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:
Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.
" } }, "required": [ "sca_compliance_level", "threed_secure" ] }, "Model20": { "type": "object", "properties": { "sca_compliance_level": { "type": "string", "description": "Strong Customer Authentication (SCA) compliance level, possible values \n * NONE: No SCA required. \n * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. \n * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS", "x-gitbook-description-html": "Strong Customer Authentication (SCA) compliance level, possible values
\n* NONE: No SCA required.
\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.
\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:
Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture now is set to true pre-authorization transactions cannot be done.
" } }, "required": [ "sca_compliance_level" ] }, "Model21": { "type": "object", "properties": { "image_url": { "type": "string", "description": "Image URL for the line item", "maxLength": 2000, "x-format": { "uri": true }, "x-gitbook-description-html": "Image URL for the line item
" }, "item_url": { "type": "string", "description": "Item URL for the line item", "maxLength": 2000, "x-format": { "uri": true }, "x-gitbook-description-html": "Item URL for the line item
" }, "name": { "type": "string", "description": "Descriptive name of the order line item", "maxLength": 255, "x-gitbook-description-html": "Descriptive name of the order line item
" }, "quantity": { "type": "integer", "default": 1, "description": "Quantity of the order line item", "x-gitbook-description-html": "Quantity of the order line item
" }, "unit_price": { "type": "number", "description": "Unit Price", "x-gitbook-description-html": "Unit Price
" }, "unit_price_tax": { "type": "number", "description": "Unit Price Tax", "x-gitbook-description-html": "Unit Price Tax
" }, "tax_rate": { "type": "number", "description": "Additional details specific to this type of event", "x-gitbook-description-html": "Additional details specific to this type of event
" }, "total_tax_amount": { "type": "number", "description": "Total tax amount", "x-gitbook-description-html": "Total tax amount
" }, "total_amount": { "type": "number", "description": "Total Amount", "x-gitbook-description-html": "Total Amount
" }, "sku": { "type": "string", "description": "The stock keeping unit (SKU) for the item.", "maxLength": 127, "x-gitbook-description-html": "The stock keeping unit (SKU) for the item.
" }, "description": { "type": "string", "description": "The detailed item description.", "maxLength": 127, "x-gitbook-description-html": "The detailed item description.
" }, "category": { "type": "string", "description": "The item category type.The item category type.
The possible values are:
* DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the PayPal for Commerce Platform product.
* DIGITAL_GOODS - A tangible item that can be shipped with proof of delivery.
List of shopping cart items, to be displayed on the page. Read Line items for details.
" }, "Model22": { "type": "object", "properties": { "image_url": { "type": "string", "description": "Image URL for the line item", "maxLength": 2000, "x-format": { "uri": true }, "x-gitbook-description-html": "Image URL for the line item
" }, "item_url": { "type": "string", "description": "Item URL for the line item", "maxLength": 2000, "x-format": { "uri": true }, "x-gitbook-description-html": "Item URL for the line item
" }, "name": { "type": "string", "description": "Descriptive name of the order line item", "maxLength": 255, "x-gitbook-description-html": "Descriptive name of the order line item
" }, "quantity": { "type": "integer", "default": 1, "description": "Quantity of the order line item", "x-gitbook-description-html": "Quantity of the order line item
" }, "unit_price": { "type": "number", "description": "Unit Price", "x-gitbook-description-html": "Unit Price
" }, "unit_price_tax": { "type": "number", "description": "Unit Price Tax", "x-gitbook-description-html": "Unit Price Tax
" }, "tax_rate": { "type": "number", "description": "Additional details specific to this type of event", "x-gitbook-description-html": "Additional details specific to this type of event
" }, "total_tax_amount": { "type": "number", "description": "Total tax amount", "x-gitbook-description-html": "Total tax amount
" }, "total_amount": { "type": "number", "description": "Total Amount", "x-gitbook-description-html": "Total Amount
" }, "sku": { "type": "string", "description": "The stock keeping unit (SKU) for the item.", "maxLength": 127, "x-gitbook-description-html": "The stock keeping unit (SKU) for the item.
" }, "description": { "type": "string", "description": "The detailed item description.", "maxLength": 127, "x-gitbook-description-html": "The detailed item description.
" }, "category": { "type": "string", "description": "The item category type.The item category type.
The possible values are:
* DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the PayPal for Commerce Platform product.
* DIGITAL_GOODS - A tangible item that can be shipped with proof of delivery.