swagger: '2.0'
info:
description: All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
version: 0.0.1
title: CyberSource Merged Spec bankAccountValidation Unified Checkout V1 Capture Context API
host: apitest.cybersource.com
basePath: /
schemes:
- https
consumes:
- application/json;charset=utf-8
produces:
- application/hal+json;charset=utf-8
tags:
- name: Unified Checkout V1 Capture Context
externalDocs:
description: Find out more
url: https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-about-guide.html
paths:
/uc/v1/sessions:
post:
tags:
- Unified Checkout V1 Capture Context
summary: Generate Unified Checkout V1 Capture Context
description: 'Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions.
Click to Pay Drop-in UI is built on the Unified Checkout platform.
For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java).
Generate Unified Checkout V1 Capture Context
Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page'
operationId: generateUnifiedCheckoutV1CaptureContext
x-devcenter-metaData:
categoryTag: Unified_Checkout
developerGuides: https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-about-guide.html
disableProcessorDropDown: true
produces:
- application/jwt
parameters:
- in: body
name: generateUnifiedCheckoutV1CaptureContextRequest
required: true
schema:
type: object
properties:
clientVersion:
type: string
example: '1.0'
maxLength: 60
description: "This field is used to specify the Unified Checkout API version your integration should use. \nThe recommended approach is to omit this field from the uc/v1/sessions API request. When omitted, Unified Checkout automatically uses the latest available version, ensuring access to the most recent enhancements and updates without requiring integration changes.\nIf included, the value must be provided in Major.Minor format (for example, 1.1 or 1.2).
\n\nOptional field:\nThis field cannot be configured through the Merchant Experience screens in the Business Center but can be provided in the uc/v1/sessions API request.\n"
targetOrigins:
type: array
items:
type: string
example: https://yourCheckoutPage.com
description: "The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Unified Checkout is defined by the scheme (protocol), hostname (domain) and port number (if used). \n\nYou must use https://hostname. The following is NOT supported: http://localhost\nWildcards are NOT supported. Ensure that subdomains are included.\nAny valid top-level domain is supported (e.g. .com, .co.uk, .gov.br etc)\n\nExamples:\n - https://example.com\n - https://subdomain.example.com\n - https://example.com:8080
\n\nIf you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example:\n\n targetOrigins: [\n \"https://example.com\",\n \"https://basket.example.com\",\n \"https://ecom.example.com\"\n ]
\n\nYou can supply up to seven origins within the targetOrigins field for nested iframes.\nIf the list of origins exceeds five ensure that you:\n - Compare the list of origins in the v1/sessions targetOrigins field against the location.ancestorOrigins of the browser. \n - Ensure that the count of origins and their content matches in both. If any origins are absent or mismatched, the system will prevent Unified Checkout from loading and display a client-side error message.
\n\nRequired field:\nThis field cannot be configured through the Merchant Experience Screens in the Business Center and must be provided on a per transaction basis via the uc/v1/sessions API request.\n"
allowedCardNetworks:
type: array
items:
type: string
maxLength: 30
example:
- VISA
- MASTERCARD
description: "The list of card networks you want to use for this Unified Checkout transaction.\n\nUnified Checkout currently supports the following card networks:\n - VISA\n - MASTERCARD\n - AMEX\n - CARNET\n - CARTESBANCAIRES\n - CUP\n - DINERSCLUB\n - DISCOVER\n - EFTPOS\n - ELO\n - JAYWAN\n - JCB\n - JCREW\n - KCP\n - MADA\n - MAESTRO\n - MEEZA\n - PAYPAK\n - UATP
\n\nOptional field: \nThis field can be configured through the Merchant Experience Screens in the Business Center. The configured value may be overridden on a per transaction basis in the uc/v1/sessions API request.\n"
allowedPaymentTypes:
type: array
items:
type: string
description: "The payment types that are allowed for the merchant. \n\nPossible values when launching Unified Checkout:\n - APPLEPAY\n - CHECK\n - CLICKTOPAY\n - GOOGLEPAY\n - PANENTRY \n - PAZE \n - TMS_TOKEN
\n\nUnified Checkout supports the following wallet based payment methods:\n - PayPal v2: PAYPAL\n - Venmo: VENMO
\n\nUnified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods:\n - Cash App Afterpay (US): AFTERPAY\n - Clearpay (GB): AFTERPAY\n - Afterpay (CA, AU, NZ): AFTERPAY
\n\nUnified Checkout supports the following Online Bank Transfer payment methods:\n - Bancontact (BE): BANCONTACT\n - DragonPay (PH): DRAGONPAY\n - iDEAL (NL): IDEAL\n - Multibanco (PT): MULTIBANCO\n - MyBank (IT, BE, PT, ES): MYBANK \n - Przelewy24|P24 (PL): PRZELEWY24\n - Tink Pay By Bank (DE, ES, FR, GB, IE, NL): TINKPAYBYBANK
\n\nUnified Checkout supports the following Post-Pay Reference payment methods:\n - Konbini (JP): KONBINI
\n\nPossible values when launching Click To Pay Drop-In UI:\n- CLICKTOPAY \n- PANENTRY
\n\n**Important:** \n - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards.\n - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester.\n - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.
\n\nOptional field: \nThis field can be configured through the Merchant Experience Screens in the Business Center. The configured value may be overridden on a per transaction basis in the uc/v1/sessions API request.\n"
paymentConfigurations:
type: object
description: 'Allows per-transaction payment type configuration overrides.
'
properties:
GOOGLEPAY:
type: object
properties:
allowedAuthMethods:
type: array
description: "When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.
\nBy default, Google sends both authentication types. When the complete mandate is used and Google Pay does not authenticate the transaction, then Unified Checkout completes the authentication request as part of the complete mandate.
\nPossible values:\n- PAN_ONLY: Google returns primary account number (PAN) values\n- CRYPTOGRAM_3DS: Google returns fully authenticated network token values.
\n\nOptional field: \nThis field can be configured through the Merchant Experience Screens in the Business Center. The configured value may be overridden on a per transaction basis in the uc/v1/sessions API request.\n"
minItems: 1
items:
type: string
CLICKTOPAY:
type: object
properties:
autoCheckEnrollment:
type: boolean
description: "Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\".
\n\nThis is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\".\n - UAE\n - Argentina\n - Brazil\n - Chile\n - Colombia\n - Kuwait\n - Mexico\n - Peru\n - Qatar\n - Saudi Arabia\n - Ukraine\n - South Africa
\n\nIf false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry.
\nOptional field:\nThis field can be configured through the Merchant Experience Screens in the Business Center. The configured value may be overridden on a per transaction basis in the uc/v1/sessions API request.\n"
PAYPAL:
type: object
properties:
vaultingEnabled:
type: boolean
description: 'Enables PayPal''s Vaulted Payments flow within Unified Checkout. This provides a seamless checkout experience by storing payment methods for high-frequency and low average-order-value services such as rides, meal pickups, and other quick purchases.
This field is optional.
'
tokenizedPaymentMethod:
type: object
description: 'Description of the vaulted payment method shown to the buyer during checkout and in their PayPal account.
'
properties:
usageType:
type: string
description: 'Indicates the type of vaulting relationship. Valid values:
- "MERCHANT": Single merchant relationship.
- "PLATFORM": Platform hosting multiple merchants.
'
usagePattern:
type: string
description: 'Indicates how the merchant will primarily use the vaulted payment method. Valid values:
- "IMMEDIATE": For on-demand, instant payments. These payments are variable in both amount and frequency and will be used to pay for goods or services before they are rendered to the buyer
- "DEFERRED": For post-pay payments; that is, payments for goods or services that have already been rendered to the buyer
- "RECURRING_PREPAID": For recurring payments before services are rendered.
- "RECURRING_POSTPAID": For recurring payments after services are rendered.
- "THRESHOLD_PREPAID": For payments when a pre-defined threshold is reached before services are rendered.
- "THRESHOLD_POSTPAID": For payments when a pre-defined threshold is reached after services are rendered.
'
allowMultipleTokens:
type: boolean
description: 'Create multiple payment tokens for the same payer, merchant/platform combination. This helps to identify customers distinctly even though they may share the same PayPal account.
'
industryType:
type: string
description: 'Indicates the industry type.
Possible Values:
- "Events"
- "Ticketing"
- "Fuel"
- "GAMING"
- "DIGITAL GOODS"
- "TELCO"
- "Token Service Providers"
- "Gambling"
- "CFDs"
- "car rental"
- "hotel"
- "transportation"
- "travel package"
- "Cruise Line"
- "P2P"
- "Retail"
- "Food"
- "Groceries"
- "Ride Sharing"
- "Taxi"
- "Remittance"
- "Crypto"
- "Marketplaces"
'
TMS_TOKEN:
type: object
description: 'Allows a single Token Management Service (TMS) token to be presented within the Unified Checkout user interface. This enables customers to complete a payment using an existing stored credential.
Supported token types:
- customer
- instrumentIdentifiers
- paymentInstruments
**Important note:**
If a customer token ID is provided and token creation (tokenCreate) is enabled for a paymentInstrument or instrumentIdentifier within the Complete Mandate, Unified Checkout will create a new payment instrument or instrument identifier and associate it with the specified customer token.
'
properties:
customer:
type: object
description: 'Existing customer token stored in the merchant token vault.
'
properties:
id:
type: string
maxLength: 50
example: 07C9CA98022DA498E063A2598D0AA400
paymentInstruments:
type: array
maxItems: 50
description: 'List of existing payment instrument tokens associated with the customer.
'
items:
type: object
properties:
id:
type: string
maxLength: 50
example: 404352E77F6A66E7E0634136CF0ABCD7
instrumentIdentifiers:
type: array
maxItems: 50
description: 'List of existing instrument identifier tokens.
If not supplied, the default token type for the merchant''s token vault is used.
'
items:
type: object
properties:
id:
type: string
maxLength: 50
example: 07C9CA98022DA498E063A2598D0AA400
appearance:
type: object
description: Controls the Unified Checkout UI appearance.
properties:
theme:
type: string
maxLength: 25
example: LIGHT
description: 'Configure Unified Checkout theme.
Possible values:
- LIGHT
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center and must be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
variables:
type: object
description: 'CSS appearance variables. All variables optional.
'
properties:
backgroundColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#FFFFFF'
description: 'Main background color
Optional field::
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.'
textColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#000000'
description: 'Main text color
Optional field::
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.'
headerBackground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#1A237E'
description: 'Header background color
Optional field::
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.'
headerForeground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#FFFFFF'
description: 'Header text/icon color
Optional field::
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.'
headerAvatarBackgroundColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#3F51B5'
description: 'Avatar background in header
Optional field::
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.'
headerAvatarForegroundColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#FFFFFF'
description: 'Avatar text/icon color
Optional field::
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.'
inputBackground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#FAFAFA'
description: 'Input field background
Optional field::
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.'
inputColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#333333'
description: 'Input text color
Optional field::
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.'
inputPlaceholderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#AAAAAA'
description: 'Placeholder text color
Optional field::
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.'
inputBorderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#CCCCCC'
description: 'Input border color
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputBorderStyle:
type: string
example: solid
description: 'Border style (solid, dashed, dotted)
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputBorderRadius:
type: string
example: 6px
description: 'Border radius with CSS unit
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputHoverBackground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#EFEFEF'
description: 'Background on hover
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputHoverColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#444444'
description: 'Text color on hover
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputHoverPlaceholderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#999999'
description: 'Placeholder color on hover
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputHoverBorderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#BBBBBB'
description: 'Border color on hover
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputHoverBorderStyle:
type: string
example: dotted
description: 'Border style on hover
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputFocusedBackground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#FFFFFF'
description: 'Background when focused
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputFocusedColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#222222'
description: 'Text color when focused
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputFocusedPlaceholderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#888888'
description: 'Placeholder color when focused
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputFocusedBorderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#AAAAAA'
description: 'Border color when focused
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputFocusedBorderStyle:
type: string
example: solid
description: 'Border style when focused
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputActiveBackground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#F0F0F0'
description: 'Background when active
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputActiveColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#111111'
description: 'Text color when active
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputActivePlaceholderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#777777'
description: 'Placeholder color when active
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputActiveBorderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#999999'
description: 'Border color when active
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputActiveBorderStyle:
type: string
example: solid
description: 'Border style when active
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputPressedBackground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#E0E0E0'
description: 'Background when pressed
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputPressedColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#000000'
description: 'Text color when pressed
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputPressedPlaceholderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#666666'
description: 'Placeholder color when pressed
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputPressedBorderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#888888'
description: 'Border color when pressed
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputPressedBorderStyle:
type: string
example: solid
description: 'Border style when pressed
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputErrorBackground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#FFEBEE'
description: 'Background on error
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputErrorColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#FF0000'
description: 'Text color on error
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputErrorPlaceholderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#EF9A9A'
description: 'Placeholder color on error
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputErrorBorderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#F44336'
description: 'Border color on error
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputErrorBorderStyle:
type: string
example: solid
description: 'Border style on error
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputValidBackground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#E8F5E9'
description: 'Background when valid
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputValidColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#008000'
description: 'Text color when valid
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputValidPlaceholderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#A5D6A7'
description: 'Placeholder color when valid
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputValidBorderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#4CAF50'
description: 'Border color when valid
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
inputValidBorderStyle:
type: string
example: solid
description: 'Border style when valid
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonBackground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#E0E0E0'
description: 'Button background
Optional field:
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis by passing a value in the uc/v1/sessions API request.
'
buttonForeground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#333333'
description: 'Button text/icon color
Optional field:
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis by passing a value in the uc/v1/sessions API request.
'
buttonShape:
type: string
example: filled
description: 'Button shape
Optional field:
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis by passing a value in the uc/v1/sessions API request.
'
buttonBorderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#CCCCCC'
description: 'Button border color
Optional field:
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis by passing a value in the uc/v1/sessions API request.
'
buttonBorderStyle:
type: string
example: solid
description: 'Border Style
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonBorderRadius:
type: string
example: 4px
description: 'Border radius with unit
Optional field:
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis by passing a value in the uc/v1/sessions API request.
'
buttonHoverBackground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#F0F0F0'
description: 'Background on hover
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonHoverForeground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#444444'
description: 'Text color on hover
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonHoverBorderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#BBBBBB'
description: 'Border color on hover
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonHoverBorderStyle:
type: string
example: dashed
description: 'Border style on hover
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonFocusBackground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#C0C0C0'
description: 'Background when focused
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonFocusForeground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#111111'
description: 'Text color when focused
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonFocusBorderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#999999'
description: 'Border color when focused
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonActiveBackground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#D0D0D0'
description: 'Background when active
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonActiveForeground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#222222'
description: 'Text color when active
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonActiveBorderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#AAAAAA'
description: 'Border color when active
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonActiveBorderStyle:
type: string
example: solid
description: 'Border style when active
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonDisabledBackground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#F5F5F5'
description: 'Background color when disabled
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonDisabledForeground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#888888'
description: 'Text color when disabled
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonDisabledBorderColor:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#DDDDDD'
description: 'Border color when disabled
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
fontFamily:
type: string
example: Roboto Slab, serif
description: 'Font Family
Optional field:
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis by passing a value in the uc/v1/sessions API request.
'
borderRadius:
type: string
example: 5px
description: 'Global border radius
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center. If required, should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
paymentSelectionBackground:
type: string
pattern: ^#([A-Fa-f0-9]{6})$
example: '#F5F5F5'
description: 'Background for payment method list
Optional field:
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis by passing a value in the uc/v1/sessions API request.
'
country:
type: string
example: US
maxLength: 2
description: "Country the purchase is originating from (e.g. country of the merchant). \nUse the two-character ISO Standard
\n\nCountry must be in the format: ISO 3166 country code
\n\nRequired field:\nThis field cannot be configured through the Merchant Experience screens in the Business Center and must be provided on a per‑transaction basis in the uc/v1/sessions API request.\n"
locale:
type: string
example: en_US
description: 'Localization of the User experience conforming to the ISO 639 language standards and two-character ISO Standard Country Code.
Locale must be in the format: _
Please refer to list of [supported locales through Unified Checkout](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-appendix-languages.html)
Required field:
This field cannot be configured through the Merchant Experience screens in the Business Center and must be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
buttonType:
type: string
example: null
description: 'Changes the label on the payment button within Unified Checkout .
Possible values:
- ADD_CARD
- CARD_PAYMENT
- CHECKOUT
- CHECKOUT_AND_CONTINUE
- DEBIT_CREDIT
- DONATE
- PAY
- PAY_WITH_CARD
- SAVE_CARD
- SUBSCRIBE_WITH_CARD
The default value is CHECKOUT.
Optional field:
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
'
captureMandate:
type: object
properties:
billingType:
type: string
example: FULL
maxLength: 25
description: 'Configure Unified Checkout to capture billing address information.
Possible values:
- FULL: Capture complete billing address information.
- PARTIAL: Capture first name, last name, country and postal/zip code only.
- NONE: Capture only first name and last name.
Optional field:
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
'
requestEmail:
type: boolean
description: "Configure Unified Checkout to capture customer email address.\n\nPossible values:\n - True\n - False
\n\nOptional field:\nThis field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.\n"
requestPhone:
type: boolean
description: 'Configure Unified Checkout to capture customer phone number.
Possible values:
- True
- False
Optional field:
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
'
requestShipping:
type: boolean
description: 'Configure Unified Checkout to capture customer shipping details.
Possible values:
- True
- False
Optional field:
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
'
shipToCountries:
type: array
description: "List of countries available to ship to. \nUse the two-character ISO Standard Country Codes.
\n\nOptional field:\nThis field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.\n"
items:
type: string
example: US
maxLength: 2
showAcceptedNetworkIcons:
type: boolean
description: 'Configure Unified Checkout to display the list of accepted card networks beneath the payment button
Possible values:
- True
- False
Optional field:
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
'
showConfirmationStep:
type: boolean
description: 'Configure Unified Checkout to display the final confirmation screen when using Click to Pay.
Where ''BillingType''= NONE and ''requestShipping''= FALSE and the customer is using an existing Click to Pay card as their chosen payment method, a final confirmation screen can be removed allowing the customer to check out as soon as they have selected their payment method from within their Click to Pay card tray.
Possible values:
- True
- False
Optional field:
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
'
requestSaveCredentials:
type: boolean
description: "Configure Unified Checkout to display the \"Save card for future use\" checkbox.
\n\nConfigurable check box that will show in a Manual card entry flow to allow a Cardholder to give consent to store their manually entered credential with the Merchant that they are paying.
\nApplicable when manually entering the details and not enrolling in Click to Pay.\n\nPossible values:\n - True \n - False
\n\n**Use Cases:**\n\n**Offer consumers option to save their card in Unified Checkout:** \n- Include the captureMandate.requestSaveCard field in the capture context request and set it to true.\n- When set to true, this will show a checkbox with the message 'Save card for future use' in Unified Checkout.\n- When selected this provides a response in both the Transient Token and Get Credentials API response.
\n\n**Do not offer consumers the option to save their card in Unified Checkout:** \n- Include the captureMandate.requestSaveCard field in the capture context request and set it to false OR omit the field from the capture context request.\n- When set to false, the save card option is not shown to consumers when manually entering card details.
\n\nOptional field:\nThis field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.\n"
comboCard:
type: boolean
description: "Configure Unified Checkout to display combo card at checkout.
\n\nA combo debit/credit card is a single card that functions both as a Debit/Credit card. \nUnified Checkout / Click to Pay Drop-in UI allows the Cardholder to choose whether they would like the transaction to be paid for using either debit or credit card.\n**Important:** This is applicable to Visa cards only.\n\nPossible values:\n- True \n- False
\n\n**Use Cases:**\n\n**Offer Combo Card at Checkout:** \n- Include the captureMandate.comboCard field in the capture context request and set it to true.\n- When set to true, Combo Card selection is shown at checkout
\n\n**Do not offer Combo Card at Checkout:** \n- Include the captureMandate.comboCard field in the capture context request and set it to false OR omit the field from the capture context request.\n- The Combo Card selection is not shown at checkout.
\n\nOptional field:\nThis field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.\n"
CPF:
type: object
properties:
required:
type: boolean
description: "Configure Unified Checkout to display and capture the CPF number (Cadastro de Pessoas Físicas). The CPF number is a unique 11-digit identifier issued to Brazilian citizens and residents for tax purposes.\n\nPossible values:\n- True\n- False
\n\nThis field is optional. \nIf set to true the field is required.\nIf set to false the field is optional.\nIf the field is not included in the capture context then it is not captured.
\n\n**Important:**\n - If PANENTRY is specified in the allowedPaymentTypes field, the CPF number will be displayed in Unified Checkout regardless of what card number is entered.\n - If CLICKTOPAY is specified in the allowedPaymentTypes field, the CPF number will be displayed in Unified Checkout only when a Visa Click To Pay card is entered.
\n\nOptional field:\nThis field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.\n"
completeMandate:
type: object
description: "The completeMandate object is designed to provide instructions for orchestrating payment services. Unified Checkout is capable of orchestrating a number of services on your behalf.
\nBy providing this field in the capture context Unified Checkout will initiate services on your behalf from the browser, simplifying your integration.\n"
properties:
type:
type: string
example: AUTH
maxLength: 25
description: "This field is used to indicate how a payment should be processed.\n\nPossible values:\n- AUTH: Use this value when you want to authorize a payment within Unified Checkout without capturing it immediately. Payment types that initiate an immediate transfer of funds are NOT allowed. If a capture context request includes a payment type incompatible with this mode, a 400 error will be returned. A merchant would need to perform their own capture via API where applicable.
\n- CAPTURE: Use this value when you want to perform a sale within Unified Checkout and capture the payment immediately during the transaction. Note: Some payment types may return a PENDING status, requiring an additional status check call to determine the final outcome of the payment.
\n- PREFER_AUTH: Use this value to offer multiple alternative payment options during the Unified Checkout experience. This option authorizes the payment without immediate capture, where available. It will perform a \"CAPTURE\" where an \"AUTH\" is not allowed by the payment type. Transactions can be AUTHORIZED, CAPTURED, or PENDING. If an \"AUTH\" is performed, a merchant would need to perform their own capture via API where applicable.
\n\nOptional field:\nThis field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.\n"
tms:
type: object
description: 'Configure Unified Checkout to create a TMS token at the end of the payment journey
'
properties:
tokenCreate:
type: boolean
example: true
description: "Use this when you want to create a token from the card/bank data in your payment request. \n\nPossible values:\n - True\n - False
\n\nOptional field:\nThis field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.\n"
tokenTypes:
type: array
items:
type: string
maxLength: 30
example:
- CUSTOMER
description: 'Cybersource tokens types you are performing a create on.
If not supplied the default token type for the merchants token vault will be used.
Possible values:
- Customer
- paymentInstrument
- instrumentIdentifier
- shippingAddress
Optional field:
This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
'
decisionManager:
type: boolean
description: "Configure Unified Checkout to determine whether Decision Manager is invoked during service orchestration.\n\nPossible values:\n - True\n - False
\n\nSetting this value to True indicates that device fingerprinting will be executed to add additional information for risk service\nSetting this value to False (or not provided) indicates that you do not wish to run device fingerprinting and skip decision manager services.
\n\nOptional field:\nThis field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.\n"
consumerAuthentication:
type: string
description: "Configure Unified Checkout to determine whether Consumer Authentication is invoked during service orchestration.\n\nPossible values:\n\n - PASSKEY\n - 3DS\n - NONE
\n\nSetting this value to PASSKEY performs Payer Authentication with an existing Visa Payment Passkey or create a new Passkey (Post a traditional 3DS Authentication) attempt to perform authentication using the Payer Authentication Service.
\nSetting this value to 3DS will attempt to perform authentication using the Payer Authentication Service.
\nSetting this value to NONE indicates that you do not wish to perform authentication using the Payer Authentication Service.
\n\nOptional field:\nThis field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.\n"
transientTokenResponseOptions:
type: object
properties:
includeCardPrefix:
type: boolean
description: "Use the transientTokenResponseOptions.includeCardPrefix field to choose your preferred card number prefix length: 6-digit, 8-digit, or no card number prefix.\n\nPossible values:\n- True\n- False
\n\nTo select the type of card number prefix:\n- No field included: A 6-digit prefix is returned (default)\n- True: An 8-digit prefix is returned\n- False: No prefix is returned
\n\nThe following conditions apply:\n- 8-digit card number prefixes only apply to Discover, JCB, Mastercard, UnionPay, and Visa brands with 16-digit card numbers or more.\n- Any card with less than 16-digit numbers will return a 6-digit prefix even when the transientTokenResponseOptions.includeCardPrefix field is set to true.\n- Any card brand other than Discover, JCB, Mastercard, UnionPay, or Visa will return a 6-digit prefix even when the transientTokenResponseOptions.includeCardPrefix field is set to true.\n- If any card brand is co-branded with Discover, JCB, Mastercard, UnionPay, or Visa, an 8-digit prefix will be returned if the transientTokenResponseOptions.includeCardPrefix field is set to true.
\n\n**Important:** \nIf your application does NOT require a card number prefix for routing or identification purposes, set the transientTokenResponseOptions.includeCardPrefix field to False. This will minimize your personal data exposure.
\n\nOptional field:\nThis field cannot be configured through the Merchant Experience screens in the Business Center and if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.\n"
data:
type: object
properties:
aggregatorInformation:
type: object
properties:
aggregatorId:
type: string
maxLength: 20
description: "Value that identifies you as a payment aggregator. Get this value from the processor.\n \n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n \nThis field is supported for Visa, Mastercard and Discover Transactions.\n \n**FDC Compass**\\\nThis value must consist of uppercase characters.\n"
name:
type: string
maxLength: 37
description: "Your payment aggregator business name.\n \n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n \n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n \n**FDC Compass**\\\nThis value must consist of uppercase characters.\n"
subMerchant:
type: object
properties:
cardAcceptorId:
type: string
maxLength: 15
description: Unique identifier assigned by the payment card company to the sub-merchant.
id:
type: string
maxLength: 20
description: 'The ID you assigned to your sub-merchant.
CyberSource through VisaNet: For American Express transaction, the value for this field corresponds to the following data in the TC 33 capture file:
- Record: CP01 TCRB
- Position: 65-84
- Field: American Express Seller ID
For Mastercard transactions, the value for this field corresponds to the following data in the TC 33 capture file:
- Record: CP01 TCR6
- Position: 117-131
- Field: Sub-Merchant ID
FDC Compass: This value must consist of uppercase characters.
American Express Direct: String (20)
CyberSource through VisaNet with American Express: String (20)
CyberSource through VisaNet with Visa,Mastercard and Discover: String (15)
FDC Compass: String (20)
FDC Nashville Global: String (14)
'
name:
type: string
maxLength: 37
description: 'Sub-merchant''s business name.
#### American Express Direct
The maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.
#### CyberSource through VisaNet
With American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.
#### FDC Compass
This value must consist of uppercase characters.
#### FDC Nashville Global
With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:
- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.
- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.
- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.
'
address1:
type: string
maxLength: 38
description: 'First line of the sub-merchant''s street address.
#### CyberSource through VisaNet
The value for this field does not map to the TC 33 capture file5.
#### FDC Compass
This value must consist of uppercase characters.
'
locality:
type: string
maxLength: 21
description: 'Sub-merchant''s city.
#### CyberSource through VisaNet
The value for this field does not map to the TC 33 capture file5.
#### FDC Compass
This value must consist of uppercase characters.
'
administrativeArea:
type: string
maxLength: 50
description: 'Sub-merchant''s state or province.
#### CyberSource through VisaNet
The value for this field does not map to the TC 33 capture file5.
#### FDC Compass
This value must consist of uppercase characters.
'
region:
type: string
maxLength: 3
description: 'Sub-merchant''s region.
**Example**\
`NE` indicates that the sub-merchant is in the northeast region.
'
postalCode:
type: string
maxLength: 15
description: 'Partial postal code for the sub-merchant''s address.
#### CyberSource through VisaNet
The value for this field does not map to the TC 33 capture file5.
#### FDC Compass
This value must consist of uppercase characters.
'
country:
type: string
maxLength: 3
description: 'Sub-merchant''s country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).
#### CyberSource through VisaNet
The value for this field does not map to the TC 33 capture file.
#### FDC Compass
This value must consist of uppercase characters.
'
email:
type: string
maxLength: 40
description: "Sub-merchant's email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
phoneNumber:
type: string
maxLength: 20
description: "Sub-merchant's telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
streetAddress:
type: string
maxLength: 150
description: Acquirer street name.
city:
type: string
maxLength: 100
description: Acquirer city.
state:
type: string
maxLength: 10
description: Acquirer state.
postalCode:
type: string
maxLength: 20
description: Acquirer postal code.
country:
type: string
maxLength: 10
description: Acquirer country.
serviceProvidername:
type: string
maxLength: 50
description: Contains transfer service provider name.
orderInformation:
type: object
properties:
amountDetails:
type: object
properties:
totalAmount:
type: string
maxLength: 19
example: '21.20'
description: 'This field defines the total order amount.
'
freightAmount:
type: string
maxLength: 13
description: "Total freight or shipping and handling charges for the order. \nWhen you include this field in your request, you must also include the **totalAmount** field.\n"
dutyAmount:
type: string
maxLength: 15
description: 'Total charges for any import or export duties included in the order.
'
discountAmount:
type: string
maxLength: 15
description: 'Total discount amount applied to the order.
'
taxAppliedAfterDiscount:
type: string
maxLength: 1
description: "Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n"
taxAppliedLevel:
type: string
maxLength: 1
description: "Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n"
currency:
type: string
maxLength: 3
example: USD
description: 'This field defines the currency applicable to the order.
'
surcharge:
type: object
properties:
amount:
type: string
example: 2.5
description: 'This field defines the surcharge amount applicable to the order.
'
subTotalAmount:
type: string
example: 5
description: 'This field defines the sub total amount applicable to the order.
'
serviceFeeAmount:
type: string
example: 5
description: 'This field defines the service fee amount applicable to the order.
'
taxAmount:
type: string
example: 10
description: 'This field defines the tax amount applicable to the order.
'
taxDetails:
type: array
items:
type: object
properties:
taxId:
type: string
maxLength: 15
example: '1234'
description: "Your tax ID number to use for the alternate tax amount. \nRequired if you set alternate tax amount to any value (including zero). \nYou may send this field without sending alternate tax amount.\n"
type:
type: string
maxLength: 9
example: N
description: 'Indicates the type of tax data for the taxDetails object.
Possible values:
- alternate
- local
- national
- vat
- other
- green
'
billTo:
type: object
properties:
address1:
type: string
example: 277 Park Avenue
maxLength: 60
description: 'Payment card billing street address as it appears on the credit card issuer''s records.
'
address2:
type: string
example: 50th Floor
maxLength: 60
description: 'Used for additional address information. For example: _Attention: Accounts Payable_
Optional field:.
'
address3:
type: string
example: Desk NY-50110
maxLength: 60
description: Additional address information (third line of the billing address)
address4:
type: string
example: address4
maxLength: 60
description: 'Additional address information (fourth line of the billing address)
'
administrativeArea:
type: string
example: NY
maxLength: 20
description: 'State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).
'
buildingNumber:
type: string
example: buildingNumber
maxLength: 256
description: 'Building number in the street address.
'
country:
type: string
example: US
maxLength: 2
description: 'Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).
'
district:
type: string
example: district
maxLength: 50
description: 'Customer''s neighborhood, community, or region (a barrio in Brazil) within the city or municipality
'
locality:
type: string
example: New York
maxLength: 50
description: 'Payment card billing city.
'
postalCode:
type: string
example: 10172
maxLength: 10
description: 'Postal code for the billing address. The postal code must consist of 5 to 9 digits.
'
company:
type: object
properties:
name:
type: string
example: Visa Inc
maxLength: 60
description: Name of the customer's company.
address1:
type: string
example: 277 Park Avenue
maxLength: 60
description: 'Payment card billing street address as it appears on the credit card issuer''s records.
'
address2:
type: string
example: 50th Floor
maxLength: 60
description: 'Used for additional address information. For example: _Attention: Accounts Payable_
Optional field:
'
administrativeArea:
type: string
example: NY
maxLength: 20
description: 'State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).
'
country:
type: string
example: US
maxLength: 2
description: 'Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).
'
locality:
type: string
example: New York
maxLength: 50
description: 'Payment card billing city.
'
postalCode:
type: string
example: 10172
maxLength: 10
description: 'Postal code for the billing address. The postal code must consist of 5 to 9 digits.
'
email:
type: string
example: john.doe@visa.com
maxLength: 255
description: 'Customer''s email address, including the full domain name.
'
firstName:
type: string
example: John
maxLength: 60
description: Customer's first name. This name must be the same as the name on the card
lastName:
type: string
example: Doe
maxLength: 60
description: 'Customer''s last name. This name must be the same as the name on the card.
'
middleName:
type: string
example: F
maxLength: 60
description: 'Customer''s middle name.
'
nameSuffix:
type: string
example: Jr
maxLength: 60
description: 'Customer''s name suffix.
'
title:
type: string
example: Mr
maxLength: 60
description: 'Title.
'
phoneNumber:
type: string
example: 1234567890
description: 'Customer''s phone number.
'
phoneType:
type: string
example: day
description: 'Customer''s phone number type.
#### For Payouts:
This field may be sent only for FDC Compass.
Possible Values:
* day
* home
* night
* work
'
shipTo:
type: object
properties:
address1:
type: string
example: CyberSource
maxLength: 60
description: 'First line of the shipping address.
'
address2:
type: string
example: Victoria House
maxLength: 60
description: 'Second line of the shipping address.
'
address3:
type: string
example: 15-17 Gloucester Street
description: 'Third line of the shipping address.
'
address4:
type: string
example: string
maxLength: 60
description: Fourth line of the shipping address.
administrativeArea:
type: string
example: CA
maxLength: 2
description: 'State or province of the shipping address.
Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf)
'
buildingNumber:
type: string
example: string
maxLength: 15
description: 'Building number in the street address.
'
country:
type: string
example: GB
description: 'Country of the shipping address.
Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)
'
district:
type: string
example: string
maxLength: 50
description: Neighborhood, community, or region within a city or municipality.
locality:
type: string
example: Belfast
maxLength: 50
description: 'City of the shipping address.
'
postalCode:
type: string
example: BT1 4LS
maxLength: 10
description: 'Postal code for the shipping address. The postal code must consist of 5 to 9 digits.
'
firstName:
type: string
example: John
maxLength: 60
description: First name of the recipient
lastName:
type: string
example: Doe
maxLength: 60
description: Last name of the recipient.
lineItems:
type: array
items:
type: object
properties:
productCode:
type: string
maxLength: 255
example: electronics
description: Code identifying the product.
productName:
type: string
maxLength: 255
example: smartphone
description: Name of the product.
productSku:
type: string
maxLength: 255
example: SKU12345
description: Stock Keeping Unit identifier
quantity:
type: integer
minimum: 1
maximum: 999999999
default: 1
example: 2
description: Quantity of the product
unitPrice:
type: string
maxLength: 15
example: '399.99'
description: Price per unit
unitOfMeasure:
type: string
maxLength: 12
example: EA
description: Unit of measure (e.g. EA, KG, LB)
totalAmount:
type: string
maxLength: 13
example: '799.98'
description: Total amount for the line item
taxRate:
type: string
description: 'The tax rate of an item. Maximum of 2 decimal places. Valid range is 0 or 0.01 to 99.99.
'
maxLength: 5
shippingCountryCode:
type: string
maxLength: 10
description: Country where item will be shipped
taxAmount:
type: string
maxLength: 15
example: '64.00'
description: Tax amount applied
taxAppliedAfterDiscount:
type: string
maxLength: 1
example: Y
description: Indicates if tax applied after discount
taxStatusIndicator:
type: string
maxLength: 1
example: N
description: Tax status indicator
taxTypeCode:
type: string
maxLength: 4
example: VAT
description: Tax type code
amountIncludesTax:
type: boolean
example: false
description: Indicates if amount includes tax
typeOfSupply:
type: string
maxLength: 2
example: GS
description: Type of supply
commodityCode:
type: string
maxLength: 15
example: '123456'
description: Commodity code
discountAmount:
type: string
maxLength: 13
example: '10.00'
description: Discount amount applied
discountApplied:
type: boolean
example: true
description: Indicates if discount applied
discountRate:
type: string
maxLength: 6
example: '0.05'
description: Discount rate applied
invoiceNumber:
type: string
maxLength: 23
example: INV-001
description: Invoice number for the line item
taxDetails:
type: object
properties:
type:
type: string
example: VAT
description: Type of tax
amount:
type: string
maxLength: 13
example: 5.99
description: Tax amount
rate:
type: string
maxLength: 6
example: 20
description: Tax rate
code:
type: string
maxLength: 4
example: VAT
description: Tax code
taxId:
type: string
maxLength: 15
example: TAXID12345
description: Tax Identifier
applied:
type: boolean
example: true
description: Indicates if tax applied
exemptionCode:
type: string
maxLength: 1
example: E
description: Tax exemption code
fulfillmentType:
type: string
example: Delivery
description: Fulfillment type
weight:
type: string
maxLength: 9
example: '1.5'
description: Weight of the product
weightIdentifier:
type: string
maxLength: 1
example: N
description: Weight identifier
weightUnit:
type: string
maxLength: 2
example: KG
description: Unit of weight of the product
referenceDataCode:
type: string
maxLength: 150
example: REFCODE
description: Reference data code
referenceDataNumber:
type: string
maxLength: 30
example: REF123
description: Reference data number
unitTaxAmount:
type: string
maxLength: 15
example: '3.20'
description: Unit tax amount
productDescription:
type: string
maxLength: 30
example: Latest model smartphone
description: Description of the product
giftCardCurrency:
type: string
maxLength: 3
example: USD
description: Gift card currency
shippingDestinationTypes:
type: string
maxLength: 50
example: Residential
description: Shipping destination types
gift:
type: boolean
example: false
description: Indicates if item is a gift
passenger:
type: object
properties:
type:
type: string
maxLength: 50
example: Residential
description: Passenger type
status:
type: string
maxLength: 32
example: Gold
description: Passenger status
phone:
type: string
maxLength: 15
example: '123456789'
description: Passenger phone number
firstName:
type: string
maxLength: 60
example: John
description: Passenger first name
lastName:
type: string
maxLength: 60
example: Doe
description: Passenger last name
id:
type: string
maxLength: 40
example: AIR1234567
description: Passenger ID
email:
type: string
maxLength: 50
example: john.doe@example.com
description: Passenger email
nationality:
type: string
maxLength: 2
example: US
description: Passenger nationality
invoiceDetails:
type: object
properties:
vatInvoiceReferenceNumber:
type: string
maxLength: 15
description: 'VAT invoice number associated with the transaction.
'
transactionAdviceAddendum:
type: array
items:
type: object
properties:
data:
type: string
maxLength: 40
description: "Four Transaction Advice Addendum (TAA) fields. \n\nThese fields are used to display descriptive information about a transaction on the customer's American Express card statement. \n\nWhen you send TAA fields, start with amexdata_taa1, then ...taa2, and so on. \n\nSkipping a TAA field causes subsequent TAA fields to be ignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"
invoiceNumber:
type: string
maxLength: 255
example: electronics
description: Invoice number
productDescription:
type: string
maxLength: 255
example: electronics
description: Product description
shippingDetails:
type: object
properties:
shippingMethod:
type: string
maxLength: 32
description: "Shipping method for the product. Possible values:\n\n - `lowcost`: Lowest-cost service\n - `sameday`: Courier or same-day service\n - `oneday`: Next-day or overnight service\n - `twoday`: Two-day service\n - `threeday`: Three-day service\n - `pickup`: Store pick-up\n - `other`: Other shipping method\n - `none`: No shipping method because product is a service or subscription\n"
shipFromPostalCode:
type: string
maxLength: 10
description: "Postal code for the address from which the goods are shipped, which is used to establish nexus. \nThe default is the postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. \nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n"
buyerInformation:
type: object
properties:
personalIdentification:
type: array
items:
type: object
properties:
type:
type: string
example: CPF
description: 'The type of document issued that identifies the account owner/authorized signer
'
id:
type: string
maxLength: 26
example: '12345678900'
description: 'CPF Number (Brazil). Must be 11 digits in length.
'
issuedBy:
type: string
maxLength: 6
example: US
description: 'Indicates the identity of the issuing authority, usually a state or country code
'
merchantCustomerId:
type: string
maxLength: 100
example: M123456767
description: "The Merchant Customer ID
\n\n Optional field:\n This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.\n"
companyTaxId:
type: string
maxLength: 9
example: ''
description: "The Company Tax ID
\n\n Optional field:\n This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.\n"
dateOfBirth:
type: string
maxLength: 10
example: 12/03/1976
description: 'The date of birth
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
language:
type: string
maxLength: 10
example: English
description: 'The preferred language
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
clientReferenceInformation:
type: object
properties:
code:
type: string
maxLength: 50
example: TC50171_3
applicationName:
type: string
description: 'The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.
'
applicationVersion:
type: string
description: 'Version of the CyberSource application or integration used for a transaction.
'
partner:
type: object
properties:
developerId:
type: string
maxLength: 8
example: DEV12345
solutionId:
type: string
maxLength: 8
example: SOL1234
consumerAuthenticationInformation:
type: object
properties:
challengeCode:
type: string
maxLength: 2
example: '01'
description: 'The challenge code
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
messageCategory:
type: string
maxLength: 2
example: '01'
description: 'The message category
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
acsWindowSize:
type: string
maxLength: 2
example: '01'
description: 'The acs window size
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
productCode:
type: string
maxLength: 3
description: "Specifies the product code, which designates the type of transaction.
\n\nSpecify one of the following values for this field:\n - AIR: Airline purchase\n\nImportant Required for American Express SafeKey (U.S.).\n - ACC: Accommodation Rental\n - ACF: Account funding\n - CHA: Check acceptance\n - DIG: Digital Goods\n - DSP: Cash Dispensing\n - GAS: Fuel\n - GEN: General Retail\n - LUX: Luxury Retail\n - PAL: Prepaid activation and load\n - PHY: Goods or services purchase\n - QCT: Quasi-cash transaction\n - REN: Car Rental\n - RES: Restaurant\n - SVC: Services\n - TBD: Other\n - TRA: Travel
\n\n**Important** Required for Visa Secure transactions in Brazil.\nDo not use this request field for any other types of transactions.\n"
merchantInformation:
type: object
properties:
merchantDescriptor:
type: object
properties:
name:
type: string
maxLength: 25
example: Euro Electronics
description: 'The name of the merchant
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
alternateName:
type: string
maxLength: 25
example: Smyth Holdings PLC
description: 'The alternate name of the merchant
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
contact:
type: string
maxLength: 25
description: 'Contact information for the merchant.
**Note** These are the maximum data lengths for the following payment processors:
- FDCCompass (13)
- Paymentech (13)
'
locality:
type: string
maxLength: 50
example: New York
description: 'The locality of the merchant
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
phone:
type: string
maxLength: 15
example: 555-555-123
description: 'The phone number of the merchant
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
country:
type: string
maxLength: 2
example: US
description: 'The country code of the merchant
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
postalCode:
type: string
maxLength: 10
example: '170056'
description: 'The postal code of the merchant
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
administrativeArea:
type: string
maxLength: 2
example: NY
description: 'The administrative area of the merchant
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
address1:
type: string
maxLength: 60
example: 123 47th Street
description: 'The first line of the merchant''s address
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
vatRegistrationNumber:
type: string
maxLength: 21
description: 'Your government-assigned tax identification number.
#### Tax Calculation
Required field for value added tax only. Not applicable to U.S. and Canadian taxes.
#### CyberSource through VisaNet
For CtV processors, the maximum length is 20.
'
processingInformation:
type: object
properties:
reconciliationId:
type: string
maxLength: 60
example: '01234567'
description: The reconciliation ID
purposeOfPayment:
type: string
maxLength: 12
description: "This field is applicable for AFT and OCT transactions. \nFor list of supported values, please refer to Developer Guide.\n"
authorizationOptions:
type: object
properties:
aftIndicator:
type: boolean
example: true
description: 'The AFT indicator
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
authIndicator:
type: string
example: 1
description: 'The authorization indicator
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
ignoreCvResult:
type: boolean
example: true
description: 'Ignore the CV result
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
ignoreAvsResult:
type: boolean
example: true
description: 'Ignore the AVS result
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
initiator:
type: object
properties:
credentialStoredOnFile:
type: boolean
example: true
description: 'Store the credential on file
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
merchantInitiatedTransaction:
type: object
properties:
reason:
type: string
maxLength: 2
example: 1
recurringOptions:
type: object
properties:
firstRecurringPayment:
type: boolean
description: "Flag that indicates whether this transaction is the first in a series of recurring payments.\n\nThis field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**.\n\nPossible values:\n - `true` Indicates this is the first payment in a series of recurring payments\n - `false` (default) Indicates this is not the first payment in a series of recurring payments.\n"
default: false
bankTransferOptions:
type: object
properties:
secCode:
type: string
maxLength: 3
description: 'Specifies the authorization method for the transaction.
#### TeleCheck
Accepts only the following values:
- `ARC`: account receivable conversion
- `CCD`: corporate cash disbursement
- `POP`: point of purchase conversion
- `PPD`: prearranged payment and deposit entry
- `TEL`: telephone-initiated entry
- `WEB`: internet-initiated entry
'
businessApplicationId:
type: string
maxLength: 2
example: AA
description: 'The business application Id
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
commerceIndicator:
type: string
maxLength: 20
example: INDICATOR
description: 'The commerce indicator
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
processingInstruction:
type: string
maxLength: 50
example: ORDER_SAVED_EXPLICITLY
description: 'The processing instruction
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
recipientInformation:
type: object
properties:
accountId:
type: string
maxLength: 50
description: 'Identifier for the recipient''s account.
This field is applicable for AFT transactions.
'
accountType:
type: string
maxLength: 2
description: "Identifies the recipient's account type.\nThis field is applicable for AFT transactions.\n\nValid values are:\n - `00` for Other\n - `01` for Routing Transit Number (RTN) + Bank Account Number (BAN)\n - `02` for International Bank Account Number (IBAN)\n - `03` for Card Account\n - `06` for Bank Account Number (BAN) + Bank Identification Code (BIC), also known as a SWIFT code\n"
firstName:
type: string
maxLength: 35
description: "First name of the recipient.\nThis field is applicable for AFT transactions. \n\nOnly alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor.\n"
middleName:
type: string
maxLength: 30
description: 'Middle name of the recipient.
This field is applicable for AFT transactions.
Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor.
'
lastName:
type: string
maxLength: 35
description: 'Last name of the recipient.
This field is applicable for AFT transactions.
Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor.
'
address1:
type: string
maxLength: 50
description: 'The street address of the recipient
This field is applicable for AFT and OCT transactions.
Only alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor.
'
administrativeArea:
type: string
maxLength: 2
description: 'The state or province of the recipient.
This field is applicable for AFT transactions when the recipient country is US or CA. Else it is optional.
Must be a two character value
'
postalCode:
type: string
maxLength: 10
description: 'Partial postal code for the recipient''s address. For example, if the postal code is **NN5 7SG**, the value for
this field should be the first part of the postal code: **NN5**. This field is a _pass-through_, which means that
CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field
is not required for the transaction, CyberSource does not forward it to the processor.
'
country:
type: string
maxLength: 2
description: "The country associated with the address of the recipient.\nThis field is applicable for AFT and OCT transactions.\n\nMust be a two character ISO country code. \nFor example, see [ISO Country Code](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html)\n"
phoneNumber:
type: string
maxLength: 15
description: Account Owner phone number
dateOfBirth:
type: string
maxLength: 8
description: 'Recipient''s date of birth. **Format**: `YYYYMMDD`.
This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters
but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field
is not required for the transaction, CyberSource does not forward it to the processor.
'
locality:
type: string
maxLength: 25
description: 'The city of the recipient.
This field is applicable for AFT transactions.
Only alpha numeric values are supported.
Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor.
'
senderInformation:
type: object
properties:
firstName:
type: string
maxLength: 30
description: "First name of the sender.\nThis field is applicable for AFT and OCT transactions. \n\nOnly alpha numeric values are supported.Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to the processor.\n"
middleName:
type: string
maxLength: 30
description: "Middle name of the sender.\nThis field is applicable for AFT and OCT transactions. \n\nOnly alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor.\n"
lastName:
type: string
maxLength: 35
description: 'Last name of the sender.
This field is applicable for AFT and OCT transactions.
Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor.
'
address1:
type: string
maxLength: 35
description: "The street address of the sender.\nThis field is applicable for AFT transactions. \n\nOnly alpha numeric values are supported. \nSpecial characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor.\n"
locality:
type: string
maxLength: 25
description: "The city or locality of the sender.\nThis field is applicable for AFT transactions.\n\nOnly alpha numeric values are supported. \nSpecial characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor.\n"
administrativeArea:
type: string
maxLength: 2
description: 'The state or province of the sender.
This field is applicable for AFT transactions when the sender country is US or CA. Else it is optional.
Must be a two character value
'
postalCode:
type: string
maxLength: 10
description: 'Postal code of sender.
'
countryCode:
type: string
maxLength: 2
description: "The country associated with the address of the sender.\nThis field is applicable for AFT transactions. \n\nMust be a two character ISO country code. \nFor example, see [ISO Country Code](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html)\n"
phoneNumber:
type: string
maxLength: 15
description: Sender phone number
dateOfBirth:
type: string
maxLength: 8
description: 'Sender''s date of birth. **Format**: `YYYYMMDD`.
This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters
but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field
is not required for the transaction, CyberSource does not forward it to the processor.
'
accountType:
type: string
maxLength: 2
description: "Identifies the sender's account type.\n This field is applicable for AFT transactions.\n\n Valid values are:\n - `00` for Other\n - `01` for Routing Transit Number (RTN) + Bank Account Number (BAN)\n - `02` for International Bank Account Number (IBAN)\n - `03` for Card Account\n - `04` for Email\n - `05` for Phone Number\n - `06` for Bank Account Number (BAN) + Bank Identification Code (BIC), also known as a SWIFT code\n - `07` for Wallet ID\n - `08` for Social Network ID\n"
account:
type: object
properties:
number:
type: string
maxLength: 50
description: 'The account number of the entity funding the transaction. The value for this field can be a payment card account number or bank account number.
'
fundsSource:
type: string
maxLength: 2
description: "Source of funds.\nPossible Values:\n - `01`: Credit.\n - `02`: Debit.\n - `03`: Prepaid.\n - `04`: Deposit Account.\n - `05`: Mobile Money Account.\n - `06`: Cash.\n - `07`: Other.\n - `V5`: Debits / deposit access other than those linked to the cardholders' scheme.\n - `V6`: Credit accounts other than those linked to the cardholder's scheme.\n"
deviceInformation:
type: object
properties:
ipAddress:
type: string
maxLength: 45
example: 192.168.1.1
description: 'The IP Address
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
paymentInformation:
type: object
properties:
card:
type: object
properties:
typeSelectionIndicator:
type: string
maxLength: 1
example: '0'
description: 'The card type selection indicator
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
installmentInformation:
type: object
properties:
sequence:
type: integer
maximum: 999
description: 'Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.
For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.
#### Chase Paymentech Solutions and FDC Compass
This field is optional because this value is required in the merchant descriptors.
#### CyberSource through VisaNet
When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.
For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:
- Record: CP01 TCR9
- Position: 38-40
- Field: Installment Payment Number
* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant''s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.
'
merchantDefinedInformation:
type: array
items:
type: object
description: 'Contains merchant-defined key-value pairs
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
properties:
key:
type: string
maxLength: 10
example: customer_id
description: 'The key or identifier for the merchant-defined data field. Valid values are 1 to 100.
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
value:
type: string
maxLength: 255
example: '123456'
description: 'The value you assign for your merchant-defined data field.
Optional field:
This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request.
'
x-example:
example0:
summary: Generate Unified Checkout V1 Capture Context (Minimum Fields)
value:
targetOrigins:
- https://yourCheckoutPage.com
country: US
locale: en_US
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: USD
example1:
summary: Generate Unified Checkout V1 Capture Context With Full List of Card Networks
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
- CARNET
- CARTESBANCAIRES
- CUP
- DINERSCLUB
- DISCOVER
- EFTPOS
- ELO
- JAYWAN
- JCB
- JCREW
- KCP
- MADA
- MAESTRO
- MEEZA
- PAYPAK
- UATP
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
country: US
locale: en_US
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- US
- GB
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: USD
example2:
summary: Generate Unified Checkout V1 Capture Context With Custom Google Payment Options
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- GOOGLEPAY
paymentConfigurations:
GOOGLEPAY:
allowedAuthMethods:
- PAN_ONLY
country: US
locale: en_US
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- US
- GB
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: USD
parentTag: Unified Checkout V1 Capture Context With Payment Configurations
example3:
summary: Generate Unified Checkout V1 Capture Context With Autocheck Enrollment
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
- ELO
allowedPaymentTypes:
- GOOGLEPAY
- CLICKTOPAY
- PANENTRY
paymentConfigurations:
CLICKTOPAY:
autoCheckEnrollment: true
country: BR
locale: pt_BR
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- BR
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: USD
parentTag: Unified Checkout V1 Capture Context With Payment Configurations
example4:
summary: Generate Unified Checkout V1 Capture Context With PAN Entry Enablement
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- PANENTRY
paymentConfigurations:
PANENTRY:
customer: existing_customer_token_123
country: BR
locale: pt_BR
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- BR
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: USD
parentTag: Unified Checkout V1 Capture Context With Payment Configurations
example5:
summary: Generate Unified Checkout V1 Capture Context With TMS_TOKEN
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- TMS_TOKEN
paymentConfigurations:
TMS_TOKEN:
customer:
id: 404352E77F6A66E7E0634136CF0ABCD7
country: US
locale: en_US
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- US
- GB
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: USD
parentTag: Unified Checkout V1 Capture Context With Payment Configurations
example6:
summary: Generate Unified Checkout V1 Capture Context (Opt-out of receiving card number prefix)
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
country: US
locale: en_US
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- US
- GB
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: USD
transientTokenResponseOptions:
includeCardPrefix: false
example7:
summary: Generate Unified Checkout V1 Capture Context passing Billing & Shipping
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
country: US
locale: en_US
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- US
- GB
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: USD
billTo:
address1: 277 Park Avenue
address2: 50th Floor
address3: Desk NY-50110
address4: address4
administrativeArea: NY
buildingNumber: buildingNumber
country: US
district: district
locality: New York
postalCode: '10172'
company:
name: Visa Inc
address1: 900 Metro Center Blvd
address2: address2
administrativeArea: CA
country: US
locality: Foster City
postalCode: '94404'
email: john.doe@visa.com
firstName: John
lastName: Doe
middleName: F
nameSuffix: Jr
title: Mr
phoneNumber: '1234567890'
phoneType: day
shipTo:
address1: CyberSource
address2: Victoria House
address3: 15-17 Gloucester Street
address4: string
administrativeArea: CA
buildingNumber: string
country: GB
district: string
locality: Belfast
postalCode: BT1 4LS
firstName: Joe
lastName: Soap
example8:
summary: Generate Unified Checkout V1 Capture Context With AFT Fields
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
country: US
locale: en_US
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- US
- GB
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: USD
processingInformation:
authorizationOptions:
aftIndicator: true
authIndicator: Y
businessApplicationId: AA
purposeOfPayment: ISACCT
commerceIndicator: Retail
senderInformation:
firstName: John
middleName: Michael
lastName: Smith
address1: 123 Sender Street
locality: San Francisco
administrativeArea: CA
postalCode: '94105'
countryCode: US
phoneNumber: '4155551234'
dateOfBirth: '19850315'
accountType: '01'
account:
fundsSource: '01'
number: '1234567890123456'
recipientInformation:
firstName: John
middleName: A
lastName: Buyer
address1: 10 Second Street
locality: Belfast
administrativeArea: GB
postalCode: '170056'
country: GB
phoneNumber: '5551234567'
accountId: acc0123567
accountType: '01'
dateOfBirth: 05111999
example9:
summary: Generate Unified Checkout V1 Capture Context For Click To Pay Drop-In UI
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- CLICKTOPAY
country: US
locale: en_US
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- US
- GB
showAcceptedNetworkIcons: true
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: USD
parentTag: Unified Checkout V1 Capture Context For Click To Pay Drop-In UI
example10:
summary: Generate Unified Checkout V1 Capture Context For Click To Pay Drop-In UI with Customization Variables
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- CLICKTOPAY
country: US
locale: en_US
appearance:
variables:
backgroundColor: '#FFFFFF'
textColor: '#1A1A1A'
headerBackground: '#0A3450'
headerForeground: '#FFFFFF'
headerAvatarBackgroundColor: '#E6EEF8'
headerAvatarForegroundColor: '#0A2540'
inputBackground: '#FFFFFF'
inputColor: '#1A1A1A'
inputPlaceholderColor: '#6B7280'
inputBorderColor: '#D1D5DB'
inputBorderStyle: solid
inputBorderRadius: 6px
inputHoverBackground: '#FFFFFF'
inputHoverColor: '#111827'
inputHoverPlaceholderColor: '#6B7280'
inputHoverBorderColor: '#9CA3AF'
inputHoverBorderStyle: solid
inputFocusedBackground: '#FFFFFF'
inputFocusedColor: '#111827'
inputFocusedPlaceholderColor: '#6B7280'
inputFocusedBorderColor: '#2563EB'
inputFocusedBorderStyle: solid
inputActiveBackground: '#FFFFFF'
inputActiveColor: '#111827'
inputActivePlaceholderColor: '#6B7280'
inputActiveBorderColor: '#2563EB'
inputActiveBorderStyle: solid
inputPressedBackground: '#F9FAFB'
inputPressedColor: '#111827'
inputPressedPlaceholderColor: '#9CA3AF'
inputPressedBorderColor: '#2563EB'
inputPressedBorderStyle: solid
inputErrorBackground: '#FEF2F2'
inputErrorColor: '#991B1B'
inputErrorPlaceholderColor: '#B91C1C'
inputErrorBorderColor: '#DC2626'
inputErrorBorderStyle: solid
inputValidBackground: '#F0FDF4'
inputValidColor: '#065F46'
inputValidPlaceholderColor: '#047857'
inputValidBorderColor: '#16A34A'
inputValidBorderStyle: solid
buttonBackground: '#2563EB'
buttonForeground: '#FFFFFF'
buttonShape: rect
buttonBorderColor: '#2563EB'
buttonBorderStyle: solid
buttonBorderRadius: 8px
buttonHoverBackground: '#1D4ED8'
buttonHoverForeground: '#FFFFFF'
buttonHoverBorderColor: '#1D4ED8'
buttonHoverBorderStyle: solid
buttonFocusBackground: '#1E40AF'
buttonFocusForeground: '#FFFFFF'
buttonFocusBorderColor: '#1E40AF'
buttonActiveBackground: '#1E3A8A'
buttonActiveForeground: '#FFFFFF'
buttonActiveBorderColor: '#1E3A8A'
buttonActiveBorderStyle: solid
buttonDisabledBackground: '#E5E7EB'
buttonDisabledForeground: '#9CA3AF'
buttonDisabledBorderColor: '#E5E7EB'
fontFamily: Inter, Arial, sans-serif
borderRadius: 8px
paymentSelectionBackground: '#F9FAFB'
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- US
- GB
showAcceptedNetworkIcons: true
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: USD
parentTag: Unified Checkout V1 Capture Context For Click To Pay Drop-In UI
example11:
summary: Generate Unified Checkout V1 Capture Context (PayPal (US))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- GOOGLEPAY
- PANENTRY
- CHECK
- PAYPAL
country: US
locale: en_US
completeMandate:
type: PREFER_AUTH
data:
orderInformation:
amountDetails:
totalAmount: '21.60'
currency: USD
taxAmount: '1.60'
lineItems:
- productName: Summer Occasion Top - Embroidered Tulle
quantity: 1
productDescription: The perfect elevated summer staple
unitPrice: '20.00'
taxAmount: '1.60'
totalAmount: '20.00'
typeOfSupply: '01'
productSku: SKU_123_SummerOT
parentTag: Unified Checkout with Alternate Payments (Wallets)
example12:
summary: Generate Unified Checkout V1 Capture Context PayPal Vaulted Payment
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- GOOGLEPAY
- PANENTRY
- PAYPAL
paymentConfigurations:
PAYPAL:
vaultingEnabled: true
tokenizedPaymentMethod:
usageType: MERCHANT
usagePattern: IMMEDIATE
allowMultipleTokens: true
description: Token for recurring payment
industryType: P2P
country: US
locale: en_US
completeMandate:
type: PREFER_AUTH
data:
orderInformation:
amountDetails:
totalAmount: '21.60'
currency: USD
taxAmount: '1.60'
lineItems:
- productName: Summer Occasion Top - Embroidered Tulle
quantity: 1
productDescription: The perfect elevated summer staple
unitPrice: '20.00'
taxAmount: '1.60'
totalAmount: '20.00'
typeOfSupply: '01'
productSku: SKU_123_SummerOT
parentTag: Unified Checkout with Alternate Payments (Wallets)
example13:
summary: Generate Unified Checkout V1 Capture Context (Venmo (US Only))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- GOOGLEPAY
- PANENTRY
- CHECK
- VENMO
country: US
locale: en_US
completeMandate:
type: PREFER_AUTH
data:
orderInformation:
amountDetails:
totalAmount: '21.60'
currency: USD
taxAmount: '1.60'
lineItems:
- productName: Summer Occasion Top - Embroidered Tulle
quantity: 1
productDescription: The perfect elevated summer staple
unitPrice: '20.00'
taxAmount: '1.60'
totalAmount: '20.00'
typeOfSupply: '01'
productSku: SKU_123_SummerOT
parentTag: Unified Checkout with Alternate Payments (Wallets)
example14:
summary: Generate Unified Checkout V1 Capture Context ($ Afterpay (US))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- AFTERPAY
country: US
locale: en_US
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- US
- CA
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: USD
billTo:
email: john.doe@visa.com
firstName: John
lastName: Doe
address1: 277 Galleria Road
administrativeArea: TX
buildingNumber: '2'
country: US
locality: Houston
postalCode: '22096'
shipTo:
firstName: Joe
lastName: Sims
address1: 15-17 Gloucester Street
administrativeArea: AL
buildingNumber: '2'
country: CA
locality: Calgary
postalCode: T2B 4N3
parentTag: Unified Checkout with Alternate Payments (Buy Now, Pay Later)
example15:
summary: Generate Unified Checkout V1 Capture Context (Afterpay (CAN))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- AFTERPAY
country: CA
locale: en_US
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- US
- CA
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: CAD
billTo:
email: john.doe@visa.com
firstName: John
lastName: Doe
address1: 277 Galleria Road
administrativeArea: AL
buildingNumber: '2'
country: CA
locality: Calgary
postalCode: T2B 4N3
shipTo:
firstName: Joe
lastName: Sims
address1: 15-17 Gloucester Street
administrativeArea: AL
buildingNumber: '2'
country: CA
locality: Calgary
postalCode: T2B 543
parentTag: Unified Checkout with Alternate Payments (Buy Now, Pay Later)
example16:
summary: Generate Unified Checkout V1 Capture Context (Clearpay (GB))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- AFTERPAY
country: GB
locale: en_GB
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- GB
- ES
- IT
- PT
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: GBP
billTo:
email: john.doe@visa.com
firstName: John
lastName: Doe
address1: 277 Square Street
administrativeArea: Devon
buildingNumber: '2'
country: GB
locality: Plymouth
postalCode: PL1 1AS
shipTo:
firstName: Joe
lastName: Sims
address1: 15-17 Gloucester Street
administrativeArea: NIR
buildingNumber: '2'
country: GB
locality: Belfast
postalCode: BT6 8JW
parentTag: Unified Checkout with Alternate Payments (Buy Now, Pay Later)
example17:
summary: Generate Unified Checkout V1 Capture Context (Afterpay (AU))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- AFTERPAY
country: AU
locale: en_GB
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- AU
- NZ
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: AUD
billTo:
email: john.doe@visa.com
firstName: John
lastName: Doe
address1: 277 Ocean Road
administrativeArea: NSW
buildingNumber: '2'
country: AU
locality: Sydney
postalCode: '2000'
shipTo:
firstName: Joe
lastName: Sims
address1: 15-17 Springtown Road
administrativeArea: NSW
buildingNumber: '2'
country: AU
locality: Sydney
postalCode: '2000'
parentTag: Unified Checkout with Alternate Payments (Buy Now, Pay Later)
example18:
summary: Generate Unified Checkout V1 Capture Context (Afterpay (NZ))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- AFTERPAY
country: NZ
locale: en_GB
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- AU
- NZ
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: NZD
billTo:
email: john.doe@visa.com
firstName: John
lastName: Doe
address1: 277 Maranui Avenue
administrativeArea: NSW
buildingNumber: '2'
country: NZ
locality: Auckland
postalCode: '1022'
shipTo:
firstName: Joe
lastName: Sims
address1: 15-17 Springtown Road
administrativeArea: NSW
buildingNumber: '2'
country: AU
locality: Sydney
postalCode: '2000'
parentTag: Unified Checkout with Alternate Payments (Buy Now, Pay Later)
example19:
summary: Generate Unified Checkout V1 Capture Context (Tink Pay By Bank (DE))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- TINKPAYBYBANK
country: DE
locale: de_DE
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- DE
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: EUR
billTo:
email: john.doe@visa.com
firstName: John
lastName: Doe
address1: Unter den Linden 1
administrativeArea: Berlin
buildingNumber: '1'
country: DE
locality: Berlin
postalCode: '10117'
shipTo:
firstName: Joe
lastName: Sims
address1: Maximilianstraße 5
administrativeArea: Bayern
buildingNumber: '5'
country: DE
locality: München
postalCode: '80539'
parentTag: Unified Checkout with Alternate Payments (Online Bank Transfer)
example20:
summary: Generate Unified Checkout V1 Capture Context (Tink Pay By Bank (ES))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- TINKPAYBYBANK
country: ES
locale: es_ES
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- ES
- FR
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: EUR
billTo:
email: john.doe@visa.com
firstName: John
lastName: Doe
address1: Calle de Gran Vía 1
administrativeArea: Comunidad de Madrid
buildingNumber: '1'
country: ES
locality: Madrid
postalCode: '28013'
shipTo:
firstName: Joe
lastName: Sims
address1: La Rambla 10
administrativeArea: Cataluña
buildingNumber: '10'
country: ES
locality: Barcelona
postalCode: 08002
parentTag: Unified Checkout with Alternate Payments (Online Bank Transfer)
example21:
summary: Generate Unified Checkout V1 Capture Context (Tink Pay By Bank (FR))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- TINKPAYBYBANK
country: FR
locale: fr_FR
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- ES
- FR
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: EUR
billTo:
email: john.doe@visa.com
firstName: John
lastName: Doe
address1: Rue de la République
administrativeArea: Île-de-France
buildingNumber: '42'
country: FR
locality: Paris
postalCode: '75003'
shipTo:
firstName: Joe
lastName: Sims
address1: Avenue Jean Médecin
administrativeArea: Provence-Alpes-Côte d'Azur
buildingNumber: '7'
country: FR
locality: Nice
postalCode: '06000'
parentTag: Unified Checkout with Alternate Payments (Online Bank Transfer)
example22:
summary: Generate Unified Checkout V1 Capture Context (Tink Pay By Bank (GB))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- TINKPAYBYBANK
country: GB
locale: en_GB
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- GB
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: GBP
billTo:
email: john.doe@visa.com
firstName: John
lastName: Doe
address1: 277 Square Street
administrativeArea: Devon
buildingNumber: '2'
country: GB
locality: Plymouth
postalCode: PL1 1AS
shipTo:
firstName: Joe
lastName: Sims
address1: 15-17 Gloucester Street
administrativeArea: NIR
buildingNumber: '2'
country: GB
locality: Belfast
postalCode: BT6 8JW
parentTag: Unified Checkout with Alternate Payments (Online Bank Transfer)
example23:
summary: Generate Unified Checkout V1 Capture Context (Tink Pay By Bank (IE))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- TINKPAYBYBANK
country: IE
locale: en_IE
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- IE
- GB
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: EUR
billTo:
email: john.doe@visa.com
firstName: John
lastName: Doe
address1: 1 Grafton Street
administrativeArea: Leinster
buildingNumber: '1'
country: IE
locality: Dublin
postalCode: D02 VX79
shipTo:
firstName: Joe
lastName: Sims
address1: 20 St Patrick's Street
administrativeArea: Munster
buildingNumber: '20'
country: IE
locality: Cork
postalCode: T12 HY24
parentTag: Unified Checkout with Alternate Payments (Online Bank Transfer)
example24:
summary: Generate Unified Checkout V1 Capture Context (Tink Pay By Bank (NL))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- TINKPAYBYBANK
country: NL
locale: es_NL
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- NL
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: EUR
billTo:
email: john.doe@visa.com
firstName: John
lastName: Doe
address1: Damrak 1
administrativeArea: Noord-Holland
buildingNumber: '1'
country: NL
locality: Amsterdam
postalCode: 1012 LG
shipTo:
firstName: Joe
lastName: Sims
address1: Coolsingel 40
administrativeArea: Zuid-Holland
buildingNumber: '40'
country: NL
locality: Rotterdam
postalCode: 3011 AD
parentTag: Unified Checkout with Alternate Payments (Online Bank Transfer)
example25:
summary: Generate Unified Checkout V1 Capture Context (Bancontact (BE))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- BANCONTACT
country: BE
locale: fr_BE
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- BE
- NL
- FR
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: EUR
billTo:
email: jean.dupont@example.com
firstName: Jean
lastName: Dupont
address1: Avenue Louise 123
administrativeArea: Brussels
buildingNumber: '123'
country: BE
locality: Brussels
postalCode: '1050'
shipTo:
firstName: Marie
lastName: Dupont
address1: Rue de la Loi 200
administrativeArea: Brussels
buildingNumber: '200'
country: BE
locality: Brussels
postalCode: '1040'
parentTag: Unified Checkout with Alternate Payments (Online Bank Transfer)
example26:
summary: Generate Unified Checkout V1 Capture Context (DragonPay (PH))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- DRAGONPAY
country: PH
locale: en_PH
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- PH
- SG
- MY
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '121.00'
currency: PHP
billTo:
email: juan.dela.cruz@example.com
firstName: Juan
lastName: Dela Cruz
address1: 123 Ayala Avenue
administrativeArea: NCR
buildingNumber: '123'
country: PH
locality: Makati City
postalCode: '1226'
shipTo:
firstName: Maria
lastName: Dela Cruz
address1: 45 Ortigas Center
administrativeArea: NCR
buildingNumber: '45'
country: PH
locality: Pasig City
postalCode: '1605'
parentTag: Unified Checkout with Alternate Payments (Online Bank Transfer)
example27:
summary: Generate Unified Checkout V1 Capture Context (iDEAL (NL))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- IDEAL
country: NL
locale: en_NL
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- NL
- GB
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: EUR
billTo:
email: john.doe@visa.com
firstName: John
lastName: Doe
address1: Stationsstraat 12
administrativeArea: NL-NH
buildingNumber: '2'
country: NL
locality: Amsterdam
postalCode: 1071 JA
shipTo:
firstName: Joe
lastName: Sims
address1: 15-17 Gloucester Street
administrativeArea: NIR
buildingNumber: '2'
country: GB
locality: Belfast
postalCode: BT6 8JW
parentTag: Unified Checkout with Alternate Payments (Online Bank Transfer)
example28:
summary: Generate Unified Checkout V1 Capture Context (Multibanco (PT))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- MULTIBANCO
country: PT
locale: pt_PT
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- PT
- ES
- GB
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: EUR
billTo:
email: john.doe@visa.com
firstName: John
lastName: Doe
address1: Rua da Liberdade 10
administrativeArea: Mafra
buildingNumber: '2'
country: PT
locality: Lisboa
postalCode: 1234-567
shipTo:
firstName: Joe
lastName: Sims
address1: 15-17 Gloucester Street
administrativeArea: NIR
buildingNumber: '2'
country: GB
locality: Belfast
postalCode: BT6 8JW
parentTag: Unified Checkout with Alternate Payments (Online Bank Transfer)
example29:
summary: Generate Unified Checkout V1 Capture Context (MyBank (IT))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- MYBANK
country: IT
locale: it_IT
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- IT
- ES
- BE
- PT
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: EUR
billTo:
email: mario.rossi@example.com
firstName: Mario
lastName: Rossi
address1: Via Dante Alighieri 15
administrativeArea: MI
buildingNumber: '15'
country: IT
locality: Milano
postalCode: '20121'
shipTo:
firstName: Lucia
lastName: Rossi
address1: Corso Vittorio Emanuele II 8
administrativeArea: RM
buildingNumber: '8'
country: IT
locality: Roma
postalCode: 00186
parentTag: Unified Checkout with Alternate Payments (Online Bank Transfer)
example30:
summary: Generate Unified Checkout V1 Capture Context (Przelewy24|P24 (PL))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- PRZELEWY24
country: PL
locale: pl_PL
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- PL
- GB
- BE
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: EUR
billTo:
email: john.doe@visa.com
firstName: John
lastName: Doe
address1: Ulica Podhalanska 2
administrativeArea: Wroclaw
buildingNumber: '2'
country: PL
locality: Gdansk
postalCode: 80-322
shipTo:
firstName: Joe
lastName: Sims
address1: 15-17 Gloucester Street
administrativeArea: NIR
buildingNumber: '2'
country: GB
locality: Belfast
postalCode: BT6 8JW
parentTag: Unified Checkout with Alternate Payments (Online Bank Transfer)
example31:
summary: Generate Unified Checkout V1 Capture Context (Konbini (JP))
value:
targetOrigins:
- https://yourCheckoutPage.com
allowedCardNetworks:
- VISA
- MASTERCARD
- AMEX
allowedPaymentTypes:
- APPLEPAY
- CHECK
- CLICKTOPAY
- GOOGLEPAY
- PANENTRY
- PAZE
- KONBINI
country: JP
locale: ja_JP
captureMandate:
billingType: FULL
requestEmail: true
requestPhone: true
requestShipping: true
shipToCountries:
- JP
- US
showAcceptedNetworkIcons: true
completeMandate:
type: PREFER_AUTH
decisionManager: true
consumerAuthentication: 3DS
data:
orderInformation:
amountDetails:
totalAmount: '21.00'
currency: JPY
billTo:
email: taro.suzuki@example.jp
firstName: Taro
lastName: Suzuki
address1: 1-9-1 Marunouchi
administrativeArea: Tokyo
buildingNumber: '1'
country: JP
locality: Chiyoda-ku
postalCode: 100-0005
phoneNumber: 0312345678
shipTo:
firstName: Hanako
lastName: Suzuki
address1: 3-1-1 Umeda
administrativeArea: Osaka
buildingNumber: '3'
country: JP
locality: Kita-ku
postalCode: 530-0001
parentTag: Unified Checkout with Alternate Payments (Post-Pay Reference)
responses:
'201':
description: Capture Context Created
schema:
type: string
examples:
application/jwt: eyJraWQiOiJ6dSIsImFsZyI6IlJTMjU2In0.eyJmbHgiOnsicGF0aCI6Ii9mbGV4L3YyL3Rva2VucyIsImRhdGEiOiJaNHVqZEZ3S1dsVWlGUTFWQWtydmF4QUFFQzdTOGJOVWs2ZWgzbXVXZm51U0dxM2FHdEdTUUsrS1dXMlNtaVg5RlBMWE5sc3VjbXV2SHk3R1A5eFR1Q3hXRXFlU3ZIWHMrYkhhWUhMcGhaVnZpb0lcdTAwM2QiLCJvcmlnaW4iOiJodHRwczovL3Rlc3RmbGV4LmN5YmVyc291cmNlLmNvbSIsImp3ayI6eyJrdHkiOiJSU0EiLCJlIjoiQVFBQiIsInVzZSI6ImVuYyIsIm4iOiJpMHZtSDBmQTNVaTZWN0NvbmhvVHdwV01PeFhWdk5aUlVpWWFZSjktR0hKbmZlMUdYVERTLXk5bG1ibVFVUGZpMlVRakNoU3EyclNrZ2pxTExtRzFsRkZ5TjFINVFLSkVlUzhXWEdmeWdVNDBPc05YdDd2X1g0Mmo0a0RXVmNuV0xucGlsYndYZjhwRTh4NmUyWHBoVG5tRmZMR1phbGtUN21PYXVPdmNwdFlXUVZlVGU3bmZrWlZYZTFFN0ZmZ2taNXFkMnY1OVJ2Z1NhQmhkMko4ankyUVZidE5RNTZxMTlfc2h3bEJIYWc3dFdxbzg2S1Iwd0V3dkQyWmNENTFvZGtteFdudFVJaU1tT3VXUUFGTmVaQXBDYklySlc1SFVSdTNHM1g4M2pLM3h1NHZVQjI0WGRIdlExS215dW13RlJJWFRLZFB1TmtTOUtWRHMyemZvaVEiLCJraWQiOiIwOHhzd05TV2xDUnVzeWFHQklJRkVSOEN5M0JTNXB6ZCJ9fSwiY3R4IjpbeyJkYXRhIjp7ImFsbG93ZWRQYXltZW50VHlwZXMiOlt7InBhZ2UiOjEsInR5cGUiOiJQQU5FTlRSWSJ9LHsicGFnZSI6MiwidHlwZSI6IlNSQ1ZJU0EifSx7InBhZ2UiOjMsInR5cGUiOiJTUkNNQVNURVJDQVJEIn1dLCJwYXltZW50Q29uZmlndXJhdGlvbnMiOnsiU1JDVklTQSI6eyJvcmlnaW4iOiJodHRwczovL3NhbmRib3gtYXNzZXRzLnNlY3VyZS5jaGVja291dC52aXNhLmNvbSIsInBhdGgiOiIvY2hlY2tvdXQtd2lkZ2V0L3Jlc291cmNlcy9qcy9zcmMtaS1hZGFwdGVyL3Zpc2FTZGsuanMiLCJwYW5FbmNyeXB0aW9uS2V5Ijp7ImtpZCI6IlY2WVBMMERGSjJWNTZISUg2UTNGMTMzZmJaV3lBeUlIaldWU2VjeDZLTUY2aVRIR00iLCJlIjoiQVFBQiIsIm4iOiJzWlBJdXNEZjd5UW5uaEJrVTltdTE0Vk9PM0NydWkzYjdyQWYyS1llb2JVUm1YQTE3YjFKWDlqZzBDZC12Z3BtdXlUcnhCVVNjLTRiMC1VUGdTd0dGcVBXVXB4MDhFeHFyd1BET3ZGb2pCb3Uyd2x5cThiY3kwVXMtQmZlQ3pTRTVsTVZkU1hUWFhYY05xdS1xYjIyakNDQ0pBTHB4c0Fyc2JvTU9Yc0xlZGgzTTRYTlE1WEdBdFJmN2ItLXVUWTVEcjlLTFl5VXZaS0FuWTA0TUtKUEVPNTRZaUlGTTVEVEFoTk9tczA4OWpkTWR4LVVSSUtKalBVMi1ScEhHMXU4TENHMDI4UlRJcFBzTmJSYW51UzVUQVlfemx4RGdiMWhLSjM2WWJaRU5ITGc5UFhUQmhkT01sVTkwRFRMbGZjYkxUYS1EN0RnbGpBYVdDdXZ6TFBhR3cifSwicGFyYW1ldGVycyI6eyJzcmNJbml0aWF0b3JJZCI6IkpGQ1o4UVZPSkE3Nk5YWjY4RlpEMjFSWUl4ajN5UFpkaVV4a2ROdWliQmx4Z3dhUDQiLCJzcmNpRHBhSWQiOiJiOTIyY2VmMC0yOGQ5LTQ3OWUtYWFhZi0wOGI2MWYzM2VlN2IiLCJzcmNpVHJhbnNhY3Rpb25JZCI6ImJjOWZmNzgyLTM3NTctNDEyMS1hNGM4LTdkMDhkOGY3ZGQ4NiIsImRwYVRyYW5zYWN0aW9uT3B0aW9ucyI6eyJkcGFMb2NhbGUiOiJlbl9VUyIsInBheWxvYWRUeXBlSW5kaWNhdG9yIjoiRlVMTCIsInJldmlld0FjdGlvbiI6ImNvbnRpbnVlIiwiZHBhQWNjZXB0ZWRCaWxsaW5nQ291bnRyaWVzIjpbXSwiZHBhQWNjZXB0ZWRTaGlwcGluZ0NvdW50cmllcyI6WyJVUyIsIkdCIl0sImRwYUJpbGxpbmdQcmVmZXJlbmNlIjoiQUxMIiwiZHBhU2hpcHBpbmdQcmVmZXJlbmNlIjoiQUxMIiwiY29uc3VtZXJOYW1lUmVxdWVzdGVkIjp0cnVlLCJjb25zdW1lckVtYWlsQWRkcmVzc1JlcXVlc3RlZCI6dHJ1ZSwiY29uc3VtZXJQaG9uZU51bWJlclJlcXVlc3RlZCI6dHJ1ZSwidHJhbnNhY3Rpb25BbW91bnQiOnsidHJhbnNhY3Rpb25BbW91bnQiOiIyMS4wMCIsInRyYW5zYWN0aW9uQ3VycmVuY3lDb2RlIjoiVVNEIn0sInBheW1lbnRPcHRpb25zIjp7ImRwYVBhblJlcXVlc3RlZCI6dHJ1ZX19fX0sIlNSQ01BU1RFUkNBUkQiOnsib3JpZ2luIjoiaHR0cHM6Ly9zYW5kYm94LnNyYy5tYXN0ZXJjYXJkLmNvbSIsInBhdGgiOiIvc2RrL3NyY3Nkay5tYXN0ZXJjYXJkLmpzIiwicGFuRW5jcnlwdGlvbktleSI6eyJrdHkiOiJSU0EiLCJlIjoiQVFBQiIsInVzZSI6ImVuYyIsImtpZCI6IjE0OTEyMy1zcmMtZnBhbi1lbmNyeXB0aW9uIiwia2V5X29wcyI6WyJ3cmFwS2V5IiwiZW5jcnlwdCJdLCJhbGciOiJSU0EtT0FFUC0yNTYiLCJuIjoidnQ0bkRTUFN0VGxNMU5OY3ljdklxVWY0eDE0STRqaVRxTVRLUGpHdGF5MHlmYTF2QnlOQ2htdXBwRHdFVDVnR0dscEw4Y2NqM1lWc0JpOV9iV29lX2FwcGtQd2h4ZDd3UjlSeXdWM3ptV3VNSWhNd2xrMGxuSEFNTDY1bnNIVk0zb0VwRXZDZkFQczFOWGx0VHlmam5rZ0ZFTkkzdEhxdHdkdE04ZVAwMnBwMGp2VzY5ZnlidnlWaEx6WHdTT2dKbnRqdGpSVjdoUXI1bGVkX2pXYjV6elhJNDhPVlRUX0Y5aWluRGR0WDV5M0UtaWY1V3RHWlVGRVRiX3RaRlpZbk1MYUxsSHd2YjZaa3I4NFJTd3dzTWYybkFMXzR6UDJVYWhNd3phbWhCb09TYXF5eEd4RXE2N0hyMVU4ekFDNWhsOUQ4TmJnU3dwV3hzT0RVckh4OXJ3In0sInBhcmFtZXRlcnMiOnsic3JjaVRyYW5zYWN0aW9uSWQiOiJiYzlmZjc4Mi0zNzU3LTQxMjEtYTRjOC03ZDA4ZDhmN2RkODYiLCJzcmNpRHBhSWQiOiJiOTIyY2VmMC0yOGQ5LTQ3OWUtYWFhZi0wOGI2MWYzM2VlN2IiLCJzcmNJbml0aWF0b3JJZCI6Ijg0NGY3ZTNkLTA3ZjAtNDRiMS1hMjM3LWU2NDI0NDRlMDUxMiIsImRwYVRyYW5zYWN0aW9uT3B0aW9ucyI6eyJ0cmFuc2FjdGlvblR5cGUiOiJQVVJDSEFTRSIsImRwYUxvY2FsZSI6ImVuX1VTIiwiZHBhQWNjZXB0ZWRTaGlwcGluZ0NvdW50cmllcyI6WyJVUyIsIkdCIl0sImNvbnN1bWVyRW1haWxBZGRyZXNzUmVxdWVzdGVkIjp0cnVlLCJjb25zdW1lclBob25lTnVtYmVyUmVxdWVzdGVkIjp0cnVlLCJ0cmFuc2FjdGlvbkFtb3VudCI6eyJ0cmFuc2FjdGlvbkFtb3VudCI6IjIxLjAwIiwidHJhbnNhY3Rpb25DdXJyZW5jeUNvZGUiOiJVU0QifSwiZHBhQWNjZXB0ZWRCaWxsaW5nQ291bnRyaWVzIjpbXSwiZHBhQmlsbGluZ1ByZWZlcmVuY2UiOiJGVUxMIiwiZHBhU2hpcHBpbmdQcmVmZXJlbmNlIjoiRlVMTCIsImNvbnN1bWVyTmFtZVJlcXVlc3RlZCI6dHJ1ZSwicGF5bG9hZFR5cGVJbmRpY2F0b3IiOiJGVUxMIn19fX0sImNhcHR1cmVNYW5kYXRlIjp7ImJpbGxpbmdUeXBlIjoiRlVMTCIsInJlcXVlc3RFbWFpbCI6dHJ1ZSwicmVxdWVzdFBob25lIjp0cnVlLCJyZXF1ZXN0U2hpcHBpbmciOnRydWUsInNoaXBUb0NvdW50cmllcyI6WyJVUyIsIkdCIl0sInNob3dBY2NlcHRlZE5ldHdvcmtJY29ucyI6dHJ1ZX0sIm9yZGVySW5mb3JtYXRpb24iOnsiYW1vdW50RGV0YWlscyI6eyJ0b3RhbEFtb3VudCI6IjIxLjAwIiwiY3VycmVuY3kiOiJVU0QifSwiYmlsbFRvIjp7ImFkZHJlc3MxIjoiMjc3IFBhcmsgQXZlbnVlIiwiYWRkcmVzczIiOiI1MHRoIEZsb29yIiwiYWRkcmVzczMiOiJEZXNrIE5ZLTUwMTEwIiwiYWRkcmVzczQiOiJhZGRyZXNzNCIsImFkbWluaXN0cmF0aXZlQXJlYSI6Ik5ZIiwiYnVpbGRpbmdOdW1iZXIiOiJidWlsZGluZ051bWJlciIsImNvdW50cnkiOiJVUyIsImRpc3RyaWN0IjoiZGlzdHJpY3QiLCJsb2NhbGl0eSI6Ik5ldyBZb3JrIiwicG9zdGFsQ29kZSI6IjEwMTcyIiwiY29tcGFueSI6eyJhZGRyZXNzMSI6IjkwMCBNZXRybyBDZW50ZXIgQmx2ZCIsImFkZHJlc3MyIjoiYWRkcmVzczIiLCJhZGRyZXNzMyI6ImFkZHJlc3MzIiwiYWRkcmVzczQiOiJhZGRyZXNzNCIsImFkbWluaXN0cmF0aXZlQXJlYSI6IkNBIiwiYnVpbGRpbmdOdW1iZXIiOiIxIiwiY291bnRyeSI6IlVTIiwiZGlzdHJpY3QiOiJkaXN0cmljdCIsImxvY2FsaXR5IjoiRm9zdGVyIENpdHkiLCJwb3N0YWxDb2RlIjoiOTQ0MDQiLCJuYW1lIjoiVmlzYSBJbmMifSwiZW1haWwiOiJqb2huLmRvZUB2aXNhLmNvbSIsImZpcnN0TmFtZSI6IkpvaG4iLCJsYXN0TmFtZSI6IkRvZSIsIm1pZGRsZU5hbWUiOiJGIiwibmFtZVN1ZmZpeCI6IkpyIiwidGl0bGUiOiJNciIsInBob25lTnVtYmVyIjoiMTIzNDU2Nzg5MCIsInBob25lVHlwZSI6InBob25lVHlwZSJ9LCJzaGlwVG8iOnsiYWRkcmVzczEiOiJDeWJlclNvdXJjZSIsImFkZHJlc3MyIjoiVmljdG9yaWEgSG91c2UiLCJhZGRyZXNzMyI6IjE1LTE3IEdsb3VjZXN0ZXIgU3RyZWV0IiwiYWRkcmVzczQiOiJzdHJpbmciLCJhZG1pbmlzdHJhdGl2ZUFyZWEiOiJDQSIsImJ1aWxkaW5nTnVtYmVyIjoic3RyaW5nIiwiY291bnRyeSI6IkdCIiwiZGlzdHJpY3QiOiJzdHJpbmciLCJsb2NhbGl0eSI6IkJlbGZhc3QiLCJwb3N0YWxDb2RlIjoiQlQxIDRMUyIsImZpcnN0TmFtZSI6IkpvZSIsImxhc3ROYW1lIjoiU29hcCJ9fSwidGFyZ2V0T3JpZ2lucyI6WyJodHRwczovL3RoZS11cC1kZW1vLmFwcHNwb3QuY29tIl0sImlmcmFtZXMiOnsibWNlIjoiL21jZS9pZnJhbWUuaHRtbCIsImJ1dHRvbnMiOiIvYnV0dG9ubGlzdC9pZnJhbWUuaHRtbCIsInNyYyI6Ii9zZWN1cmUtcmVtb3RlLWNvbW1lcmNlL3NyYy5odG1sIiwiZ29vZ2xlcGF5IjoiL2dvb2dsZXBheS9nb29nbGVwYXkuaHRtbCJ9LCJjbGllbnRWZXJzaW9uIjoiMC4xMSIsImNvdW50cnkiOiJVUyIsImxvY2FsZSI6ImVuX1VTIiwiYWxsb3dlZENhcmROZXR3b3JrcyI6WyJWSVNBIiwiTUFTVEVSQ0FSRCIsIkFNRVgiXSwiY3IiOiJaX1c0NldGZlNqWXFZY3FCb19sZGVnQ0Z4RUpnUzlKNWJZT2c2cmtZd2VkaEhpV3M2elowaFZEbU5mMmgxVUQ0eWx6OWJsOThUb0c1SC10bFZjQm54YnZZc0dBSVRDT0g5LTNNZHYyc1g0X3ZFMVY2eFpCeVU5SVcwaFEiLCJzZXJ2aWNlT3JpZ2luIjoiaHR0cHM6Ly9hcGl0ZXN0LmN5YmVyc291cmNlLmNvbSIsImNsaWVudExpYnJhcnkiOiJodHRwczovL2FwaXRlc3QuY3liZXJzb3VyY2UuY29tL3VwL3YxL2Fzc2V0cy8wLjExLjAvU2VjdXJlQWNjZXB0YW5jZS5qcyIsImFzc2V0c1BhdGgiOiIvdXAvdjEvYXNzZXRzLzAuMTEuMCIsImNsaWVudExpYnJhcnlJbnRlZ3JpdHkiOiJzaGEyNTYtSm1SY1QxVFpPaThpWlRTMEZWSFdOanR2REorN1ZsdnNPTXRTZ0tMZUtLTVx1MDAzZCJ9LCJ0eXBlIjoiZ2RhLTAuNy4wIn1dLCJpc3MiOiJGbGV4IEFQSSIsImV4cCI6MTY1OTEyMTk2MSwiaWF0IjoxNjU5MTIxMDYxLCJqdGkiOiJjZ0dBaG9hSFBhbWsxM2d3In0.GSYHGM3941-HLPFjSQT2m6Zus19L4H7tSJIHLuFCKRH_bY1bxFIZRGaI-994BdmhKgzlcE6XK8HQd2lJaD7JnJXAHkmjitg0XV0NVYGbrK7V4cOvT8VKWbMV794NWAAY26_UTjLAR5PGOvyTVOyRuHsItmVMgZ0TFc7x6LeWmjyveN1VeeRemkZHh02nETXh2NpqMk_5a_vXOgoOr56MClo4OqqvSHinXZhxNjIH4h6QwksmuIHKpvoXMWsghozn3va4VEXjp4OJ96NvHkcXGAWcPpLUQOAMks4fd7EoQz4-aFOcrqnV9Ut9p82CmoclWGhvjrakB_MUAabykcmXDA
'400':
description: Bad Request
examples:
application/json:
correlationId: 08b69ffe-f79b-4e09-991f-b030058e21f4
informationLink: https://vdp.visa.com/docs/errors/invalid_merchant_configuration
message: Merchant APIKEY is invalid
reason: INVALID_APIKEY
schema:
type: object
properties:
correlationId:
type: string
details:
type: array
items:
type: object
properties:
location:
type: string
message:
type: string
informationLink:
type: string
message:
type: string
reason:
type: string
description: 'Possible values:
- INVALID_APIKEY
- INVALID_SHIPPING_INPUT_PARAMS
- CAPTURE_CONTEXT_INVALID
- CAPTURE_CONTEXT_EXPIRED
- SDK_XHR_ERROR
- UNIFIEDPAYMENTS_VALIDATION_PARAMS
- UNIFIEDPAYMENTS_VALIDATION_FIELDS
- UNIFIEDPAYMENT_PAYMENT_PARAMITERS
- CREATE_TOKEN_TIMEOUT
- CREATE_TOKEN_XHR_ERROR
- SHOW_LOAD_CONTAINER_SELECTOR
- SHOW_LOAD_INVALID_CONTAINER
- SHOW_TOKEN_TIMEOUT
- SHOW_TOKEN_XHR_ERROR
- SHOW_PAYMENT_TIMEOUT'
required:
- message
- reason
x-components: {}
x-devcenter-metaData:
categoryTagArray:
- name: Payments
description: For more information about Payments transactions, see the [Payments Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html).
- name: Transaction_Batches
description: For more information about Transaction Batches, see the [Transaction Batches Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-transaction-batch-api/txn_batch_api_intro.html).
- name: eCheck_AVS
description: For more information about eCheck Account Validation, see the [Account Validation Developer Guides Page](https://...).
- name: Token_Management
description: For more information about the Token Management Service (TMS) see the [Token Management Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/tms/developer/all/rest/tms/tms-overview.html)
- name: Flex_Microform
description: Microform Integration is a lightweight acceptance solution designed to safely and securely accept payment information within your web page. Microform is designed to a be embedded seamlessly within your existing webpage experience, blending in with your existing acceptance form. This solution allows for the replacement of sensitive payment date with a transient token (a short lived reference to the sensitive payment data). For more information about Flex Microform transactions, see the [Flex Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-flex/SAFlexibleToken.html). For examples on how to integrate Flex Microform within your webpage please see our [GitHub Flex Samples](https://github.com/CyberSource?q=flex&type=&language=)
- name: Flex_API
description: For more information about Flex API, please see [Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/digital-accept-flex/developer/all/rest/digital-accept-flex/da-flex-api-intro.html).
- name: Risk_Management
- name: Payouts
description: 'For more information about Payouts, see the [Payouts Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-payouts/Introduction.html).
'
- name: Installments
description: For more information about Installment contact Cybersource Support. For Visa installments contact VISthroughCYBS@visa.com
- name: Recurring_Billing_Subscriptions
description: For more information about Recurring Billing, see the [Recurring Billing Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/recurring-billing/developer/all/rest/recurring-billing-developer/recur-bill-services-intro.html).
- name: BIN_Lookup
description: 'The BIN Lookup Service is a versatile business tool that provides card network agnostic solution designed to ensure frictionless transaction experience by utilizing up-to-date Bank Identification Number (BIN) attributes sourced from multiple global and regional data sources.
This service helps to improve authorization rates by helping to route transactions to the best-suited card network, minimizes fraud through card detail verification and aids in regulatory compliance by identifying card properties. The service is flexible and provides businesses with a flexible choice of inputs such as primary account number (PAN), network token from major networks (such as Visa, American Express, Discover and regional networks) which includes device PAN (DPAN), and all types of tokens generated via CyberSource Token Management Service (TMS).
Currently, the range of available credentials is contingent on the networks enabled for the business entity. Therefore, the network information specified in this documentation is illustrative and subject to personalized offerings for each reseller or merchant.
'
- name: Transaction_Details
description: For more information about Transaction Details, see the [Transaction Details Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn_details_api.html).
- name: Transaction_Search
description: For more information about Transaction Search, see the [Transaction Search Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn_search_api.html).
- name: Reporting
description: 'For more information about Reporting, see the [Reporting Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-reporting-rest-api-dev-guide-102718/reporting_api.html).
'
- name: Secure_File_Share
description: For more information about Secure File Share, see the [Secure File Share Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-secure-file-share-api-102718/secure_file_share_api_intro.html).
- name: Invoices
description: For more information about Invoicing, see the [Invoicing Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/invoicing/developer/all/rest/invoicing/Introduction.html).
- name: Pay_By_Link
description: For more information about PayByLink, see the [PBL Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/boarding/user/all/rest/boarding/templates-matrix-intro/templates-matrix-pay-by-link.html).
- name: User_Management
description: For more information about User Management, see the [User Managment Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-user-management-api-102718/user_management_api_intro.html).
- name: Value_Added_Service
- name: Fee Service
- name: Merchant_Boarding
description: For more information about Merchant Boarding, please see [Developer Guides Page](https://developer.cybersource.com/api/developer-guides/Merchant-Boarding-API_ditamap/Merchant-Boarding-API.html).
- name: Webhooks
description: For more information about Webhooks, please see [Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html).
- name: Unified_Checkout
description: For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html).
- name: Unified_Checkoutv1
description: For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-about-guide.html).
- name: Account_Updater
description: For more information about Account Updater, see the [Account Updater Developer Guides Page:](https://developer.cybersource.com/library/documentation/dev_guides/Account_Updater_UG/html/index.html).
- name: Visa_Bank_Account_Validation
description: 'The Visa Bank Account Validation Service is a new standalone product designed to validate customer''s routing and bank account number combination for ACH transactions. Merchant''s can use this standalone product to validate their customer''s account prior to processing an ACH transaction against the customer''s account to comply with Nacha''s account validation mandate for Web-debit transactions.
'
- name: Currency Conversion
description: 'Empower global transactions with transparency and choice. Our Dynamic Currency Conversion API lets merchants offer customers the option to pay in their home currency at checkout, delivering real-time exchange rates and clear cost disclosure.
**Key Benefits:**
- **Enhanced Customer Experience:** Provide clarity and convenience for international shoppers.
- **Real-Time Rates:** Accurate currency conversion with all the data required for acquirers and their merchants to maintain compliance with card network rules.
- **Seamless Integration:** Flexible API endpoints for rate lookup, authorization, and capture.
- **Regulatory Compliance:** Provides the data required for acquirers and merchants to meet and maintain card scheme requirements for disclosure and consent.
Ideal for merchants and payment partners seeking to boost trust and conversion in cross-border commerce.
**Key Features:**
- **Rate Lookup:** Retrieves the most up-to-date exchange rate for eligible cards before authorization.
- **Currency Choice:** Enables the merchant to offer customers the option to select between the merchant''s local currency and their card''s billing currency.
- **Compliance:** Ensures merchants have the data required to adhere to card network regulations; exchange rates, markups, etc.
**Supported Scenarios:**
- Dynamic Currency Conversion when cardholder''s billing currency differs from merchant''s pricing currency.
- Merchant and acquirer must support the cardholder''s billing currency.
**Core API Endpoints:**
**Currency Conversion API**
Returns eligibility and exchange rate details, including:
- exchangeRate
- marginRate
- reconciliationId and Id (for subsequent payment requests)
**Payment Authorization with DCC***
POST /pts/v2/payments
Required fields include:
- orderInformation.amountDetails.currency
- orderInformation.amountDetails.originalCurrency
- orderInformation.amountDetails.originalAmount
- orderInformation.amountDetails.exchangeRate
- currencyConversion.indicator (e.g., 1 = Converted, 2 = Nonconvertible, 3 = Declined)
**Capture with DCC***
POST /pts/v2/payments/{id}/captures
Maps from original authorization and includes original and converted amounts.
**Refund with DCC***
POST /pts/v2/captures/{id}/refunds
Maps from original authorization and includes original and converted amounts.
*Note: DCC is only supported on select processors. Contact your acquirer or account manager for more information.
**Compliance & Disclosure:**
Merchants must:
- Adhere to card network rules for Dynamic Currency Conversion (DCC) transactions.
- Display the converted amount, exchange rate, and markup percentage and other required disclosures.
- Obtain explicit cardholder consent before applying DCC.
- Work with your acquirer to obtain full set of compliance requirements.
For more information, see the [Currency Conversion Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/currency-conversion/developer/all/rest/currency-conversion/cc-intro.html).
'
- name: Intelligent_Commerce_Connect
description: For more information about Intelligent Commerce Cross Network Service API, please see [Developer Guides](https://developer.cybersource.com/docs/cybs/en-us/intelligent-commerce/developer/all/rest/intelligent-commerce/intelligent-commerce-about-guide.html).