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 Merchant Boarding API
host: apitest.cybersource.com
basePath: /
schemes:
- https
consumes:
- application/json;charset=utf-8
produces:
- application/hal+json;charset=utf-8
tags:
- name: Merchant Boarding
description: Manage Boarding Registrations
paths:
/boarding/v1/registrations:
post:
tags:
- Merchant Boarding
x-devcenter-metaData:
categoryTag: Merchant_Boarding
isJstreeExpansionLimited: true
disableProcessorDropDown: true
authorizationType:
- Json Web Token
overrideMerchantCredential: apitester00
developerGuides: https://developer.cybersource.com/api/developer-guides/Merchant-Boarding-API_ditamap/Merchant-Boarding-API.html
summary: Create a boarding registration
description: 'Boarding Product is specifically for resellers who onboard merchants to resell their services to merchants and help integrate REST API into their systems.
The Boarding API is designed to simplify and streamline the onboarding process of merchants by enabling administrators and developers to:
1. Enable and Configure Products: The API helps in adding new products to an existing organization and configuring them to suit specific needs.
2. Update Merchant Information: The API allows for updating an organization''s information efficiently.
3. Manage Payment Integration: It provides templates for secure payment integration and management.
'
operationId: postRegistration
consumes:
- application/json
produces:
- application/json
parameters:
- in: header
name: v-c-idempotency-id
type: string
description: defines idempotency of the request
required: false
- in: body
name: postRegistrationBody
description: Boarding registration data
required: true
schema:
type: object
properties:
registrationInformation:
type: object
properties:
boardingRegistrationId:
type: string
maxLength: 60
example: '1234124'
readOnly: true
submitTimeUtc:
type: string
format: date-time
example: '2019-06-11T22:47:57Z'
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
readOnly: true
status:
type: string
readOnly: true
description: "The status of Registration request\nPossible Values:\n - 'PROCESSING': This status is for Registrations that are still in Progress, you can get the latest status by calling the GET endpoint using the Registration Id\n - 'SUCCESS': This status is for Registrations that were successfull on every step of the on boarding process.\n - 'FAILURE': This status is for Registrations that fail before the Organization was created; please refer to the details section in the reponse for more information.\n - 'PARTIAL': This status is for Registrations that created the Organization successfully but fail in at least on step while configuring it; please refer to the details section in the response for more information.\n"
boardingPackageId:
type: string
maxLength: 60
example: 1004001
boardingFlow:
type: string
description: "Determines the boarding flow for this registration.\nPossible Values:\n - 'ENTERPRISE'\n - 'SMB'\n - 'ADDPRODUCT'\n"
mode:
type: string
description: "In case mode is not provided the API will use COMPLETE as default\nPossible Values:\n - 'COMPLETE'\n - 'PARTIAL'\n"
salesRepId:
type: string
maxLength: 60
example: Rep1
integrationInformation:
type: object
properties:
oauth2:
type: array
items:
type: object
properties:
client_id:
type: string
maxLength: 32
example: client123
state:
type: string
maxLength: 20
example: test123
required:
- client_id
tenantConfigurations:
type: array
description: tenantConfigurations is an array of objects that includes the tenant information this merchant is associated with.
items:
type: object
properties:
solutionId:
type: string
maxLength: 8
minLength: 8
pattern: ^[0-9a-zA-Z_]+$
description: 'The solutionId is the unique identifier for this system resource.
Partner can use it to reference the specific solution through out the system.
'
example: YumSolution1
tenantInformation:
type: object
properties:
tenantId:
type: string
maxLength: 50
minLength: 1
description: The TenantId is an external Solution Identifier given by Tech Partners like SAP.
example: SAP123
required:
- solutionId
msd:
type: object
properties:
customerId:
type: string
maxLength: 15
minLength: 1
description: The customerId is an external customer Identifier given by MSD (MS Dynamics).
example: C1234567890
organizationInformation:
type: object
properties:
organizationId:
type: string
maxLength: 30
minLength: 6
pattern: ^[0-9a-zA-Z_]+$
example: merch-test1
parentOrganizationId:
type: string
description: 'This field is required for Organization Types: MERCHANT, TRANSACTING
'
maxLength: 30
minLength: 6
pattern: ^[0-9a-zA-Z_]+$
example: merch-test1-acct
childOrganizations:
readOnly: true
type: array
items:
type: string
maxLength: 30
minLength: 6
pattern: ^[0-9a-zA-Z_]+$
example: transactional-org
type:
type: string
description: "Determines the type of organization in the hirarchy that this registration will use to onboard this Organization\nPossible Values:\n - 'TRANSACTING'\n - 'STRUCTURAL'\n - 'MERCHANT'\n"
status:
type: string
description: "Determines the status that the organization will be after being onboarded\nPossible Values:\n - 'LIVE'\n - 'TEST'\n - 'DRAFT'\n"
configurable:
description: This denotes the one organization, with exception to the TRANSACTING types, that is allowed to be used for configuration purposes against products. Eventually this field will be deprecated and all organizations will be allowed for product configuration.
type: boolean
default: false
example: false
businessInformation:
type: object
properties:
name:
type: string
maxLength: 60
minLength: 1
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: Betos Restaurant
locale:
type: string
pattern: ^(de-de|en-gb|en-us|es-es|es-us|fr-ca|fr-fr|it-it|ja-jp|pt-br|zh-cn|zh-tw)$
example: en-us
localizedNames:
type: object
properties:
romaji:
type: string
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&|\\[\\]\\,\\(\\)!$;:?@\\#¡-\uFFFF]*$"
example: tenmei
katakana:
type: string
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&|\\[\\]\\,\\(\\)!$;:?@\\#¡-\uFFFF]*$"
example: ショップネーム
japanese:
type: string
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&|\\[\\]\\,\\(\\)!$;:?@\\#¡-\uFFFF]*$"
example: 店名
doingBusinessAs:
type: string
maxLength: 60
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: Betos Restaurant
description:
type: string
maxLength: 250
pattern: '[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\n\ra-zA-Z0-9().\-_#,;/\\@$:&!?%«»€₣«»€₣ ]{1,}$'
example: International food Restaurant
startDate:
type: string
format: date
pattern: ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$
example: '2019-06-11'
description: '`Format: YYYY-MM-DD`
Example 2016-08-11 equals August 11, 2016
'
address:
type: object
properties:
country:
type: string
maxLength: 2
minLength: 2
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: US
address1:
type: string
maxLength: 60
minLength: 1
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: 123 Fake st
address2:
type: string
maxLength: 60
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: apt 2
locality:
type: string
maxLength: 50
minLength: 1
pattern: "^[0-9a-zA-Z _\\-¡-\uFFFF]+$"
description: City of the billing address.
example: Bellevue
administrativeArea:
type: string
minLength: 1
maxLength: 50
pattern: "^[0-9a-zA-Z¡-\uFFFF ]*$"
description: State or province of the billing address. Required for United States and Canada.
example: WA
postalCode:
type: string
minLength: 1
maxLength: 20
pattern: ^[0-9a-zA-Z ]*$
description: Postal code for the billing address. The postal code must consist of 5 to 9 digits. Required for United States and Canada.
example: 6470
required:
- country
- address1
- locality
timeZone:
type: string
description: 'Merchant perferred time zone
Possible Values:
- ''Pacific/Pago_Pago''
- ''Pacific/Honolulu''
- ''America/Anchorage''
- ''America/Vancouver''
- ''America/Los_Angeles''
- ''America/Phoenix''
- ''America/Edmonton''
- ''America/Denver''
- ''America/Winnipeg''
- ''America/Mexico_City''
- ''America/Chicago''
- ''America/Bogota''
- ''America/Indianapolis''
- ''America/New_York''
- ''America/La_Paz''
- ''America/Halifax''
- ''America/St_Johns''
- ''America/Buenos_Aires''
- ''America/Godthab''
- ''America/Sao_Paulo''
- ''America/Noronha''
- ''Atlantic/Cape_Verde''
- ''GMT''
- ''Europe/Dublin''
- ''Europe/Lisbon''
- ''Europe/London''
- ''Africa/Tunis''
- ''Europe/Vienna''
- ''Europe/Brussels''
- ''Europe/Zurich''
- ''Europe/Prague''
- ''Europe/Berlin''
- ''Europe/Copenhagen''
- ''Europe/Madrid''
- ''Europe/Budapest''
- ''Europe/Rome''
- ''Africa/Tripoli''
- ''Europe/Monaco''
- ''Europe/Malta''
- ''Europe/Amsterdam''
- ''Europe/Oslo''
- ''Europe/Warsaw''
- ''Europe/Stockholm''
- ''Europe/Belgrade''
- ''Europe/Paris''
- ''Africa/Johannesburg''
- ''Europe/Minsk''
- ''Africa/Cairo''
- ''Europe/Helsinki''
- ''Europe/Athens''
- ''Asia/Jerusalem''
- ''Europe/Riga''
- ''Europe/Bucharest''
- ''Europe/Istanbul''
- ''Asia/Riyadh''
- ''Europe/Moscow''
- ''Asia/Dubai''
- ''Asia/Baku''
- ''Asia/Tbilisi''
- ''Asia/Calcutta''
- ''Asia/Katmandu''
- ''Asia/Dacca''
- ''Asia/Rangoon''
- ''Asia/Jakarta''
- ''Asia/Saigon''
- ''Asia/Bangkok''
- ''Australia/Perth''
- ''Asia/Hong_Kong''
- ''Asia/Macao''
- ''Asia/Kuala_Lumpur''
- ''Asia/Manila''
- ''Asia/Singapore''
- ''Asia/Taipei''
- ''Asia/Shanghai''
- ''Asia/Seoul''
- ''Asia/Tokyo''
- ''Asia/Yakutsk''
- ''Australia/Adelaide''
- ''Australia/Brisbane''
- ''Australia/Broken_Hill''
- ''Australia/Darwin''
- ''Australia/Eucla''
- ''Australia/Hobart''
- ''Australia/Lindeman''
- ''Australia/Sydney''
- ''Australia/Lord_Howe''
- ''Australia/Melbourne''
- ''Asia/Magadan''
- ''Pacific/Norfolk''
- ''Pacific/Auckland''
'
example: America/Chicago
websiteUrl:
type: string
maxLength: 100
pattern: "\\b((?:https?://|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?«»“â€\x9D‘’]))"
example: www.test.com
type:
type: string
description: "Business type\nPossible Values:\n - 'PARTNERSHIP'\n - 'SOLE_PROPRIETORSHIP'\n - 'CORPORATION'\n - 'LLC'\n - 'NON_PROFIT'\n - 'TRUST'\n"
taxId:
type: string
maxLength: 9
pattern: \d{9}
example: 254324
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
example: 4564561234
businessContact:
type: object
properties:
firstName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
middleName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
lastName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
example: 4567890398
email:
type: string
maxLength: 100
pattern: ^([a-zA-Z0-9_\-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\]?)$
example: test@test.com
required:
- firstName
- lastName
- phoneNumber
- email
technicalContact:
type: object
properties:
firstName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
middleName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
lastName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
example: 4567890398
email:
type: string
maxLength: 100
pattern: ^([a-zA-Z0-9_\-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\]?)$
example: test@test.com
required:
- firstName
- lastName
- phoneNumber
- email
emergencyContact:
type: object
properties:
firstName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
middleName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
lastName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
example: 4567890398
email:
type: string
maxLength: 100
pattern: ^([a-zA-Z0-9_\-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\]?)$
example: test@test.com
required:
- firstName
- lastName
- phoneNumber
- email
merchantCategoryCode:
type: string
maxLength: 4
pattern: ^\d{3,4}$
example: 5300
description: Industry standard Merchant Category Code (MCC)
required:
- name
KYC:
type: object
properties:
whenIsCustomerCharged:
type: string
example: ONETIMEBEFORE
description: 'Possible values:
- ONETIMEBEFORE
- ONETIMEAFTER
- OTHER'
whenIsCustomerChargedDescription:
type: string
maxLength: 100
offerSubscriptions:
type: boolean
example: true
monthlySubscriptionPercent:
type: number
format: decimal
pattern: ^((100)|(\d{0,2}))$
example: 30
quarterlySubscriptionPercent:
type: number
format: decimal
pattern: ^((100)|(\d{0,2}))$
example: 20
semiAnnualSubscriptionPercent:
type: number
format: decimal
pattern: ^((100)|(\d{0,2}))$
example: 50
annualSubscriptionPercent:
type: number
format: decimal
pattern: ^((100)|(\d{0,2}))$
example: 100
timeToProductDelivery:
type: string
description: 'Possible values:
- INSTANT
- UPTO2
- UPTO5
- UPTO10
- GREATERTHAN10'
estimatedMonthlySales:
type: number
format: currency
pattern: ^\d{1,8}(\.\d{1,2})?$
example: 10000.5
averageOrderAmount:
type: number
format: currency
pattern: ^\d{1,6}(\.\d{1,2})?$
example: 50.5
largestExpectedOrderAmount:
type: number
format: currency
pattern: ^\d{1,6}(\.\d{1,2})?$
example: 100.5
depositBankAccount:
type: object
properties:
accountHolderName:
type: string
maxLength: 40
pattern: ^[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/\\@$:&!?%«»€₣«»€₣ ]{1,}$
example: John Doe
accountType:
type: string
example: checking
description: 'Possible values:
- checking
- savings
- corporatechecking
- corporatesavings'
accountRoutingNumber:
type: string
maxLength: 9
pattern: \d{9}
accountNumber:
type: string
maxLength: 17
pattern: ^\d{5,17}$
required:
- accountHolderName
- accountType
- accountRoutingNumber
- accountNumber
required:
- whenIsCustomerCharged
- offerSubscriptions
- timeToProductDelivery
- estimatedMonthlySales
- averageOrderAmount
- largestExpectedOrderAmount
owners:
type: array
items:
type: object
properties:
firstName:
type: string
maxLength: 50
pattern: '[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\-_#,;/\\@$:&!?%«»€₣«»€₣ ]{1,}$'
example: John
middleName:
type: string
maxLength: 50
pattern: '[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\-_#,;/\\@$:&!?%«»€₣«»€₣ ]{1,}$'
example: John
lastName:
type: string
maxLength: 50
pattern: '[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\-_#,;/\\@$:&!?%«»€₣«»€₣ ]{1,}$'
example: John
birthDate:
type: string
format: date
pattern: ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$
example: '2016-08-11'
description: '`Format: YYYY-MM-DD`
Example 2016-08-11 equals August 11, 2016
'
isPrimary:
type: boolean
description: Determines whether the owner is the Primary owner of the organization
example: true
ssn:
type: string
maxLength: 12
pattern: ^\d{3}-\d{2}-\d{4}$|^\d{9,9}$
example: 123456789
description: Social Security Number
passportNumber:
type: string
maxLength: 12
pattern: ^(?!^0+$)[a-zA-Z0-9]{3,20}$
example: '1234556'
description: Passport number
passportCountry:
type: string
maxLength: 2
minLength: 2
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: US
jobTitle:
type: string
maxLength: 100
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: Director
hasSignificantResponsability:
type: boolean
description: Determines whether owner has significant responsibility to control, manage or direct the company
example: true
ownershipPercentage:
type: number
pattern: ^[0-9]$|^[1-9][0-9]$|^(100)$
description: Determines the percentage of ownership this owner has. For the primary owner the percentage can be from 0-100; for other owners the percentage can be from 25-100 and the sum of ownership accross owners cannot exceed 100
example: 25
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
example: 4567890398
email:
type: string
maxLength: 100
pattern: ^([a-zA-Z0-9_\-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\]?)$
example: test@test.com
address:
type: object
properties:
country:
type: string
maxLength: 2
minLength: 2
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: US
address1:
type: string
maxLength: 60
minLength: 1
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: 123 Fake st
address2:
type: string
maxLength: 60
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: apt 2
locality:
type: string
maxLength: 50
minLength: 1
pattern: "^[0-9a-zA-Z _\\-¡-\uFFFF]+$"
description: City of the billing address.
example: Bellevue
administrativeArea:
type: string
minLength: 1
maxLength: 50
pattern: "^[0-9a-zA-Z¡-\uFFFF ]*$"
description: State or province of the billing address. Required for United States and Canada.
example: WA
postalCode:
type: string
minLength: 1
maxLength: 20
pattern: ^[0-9a-zA-Z ]*$
description: Postal code for the billing address. The postal code must consist of 5 to 9 digits. Required for United States and Canada.
example: 6470
required:
- country
- address1
- locality
required:
- firstName
- lastName
- birthDate
- jobTitle
- hasSignificantResponsability
- ownershipPercentage
- phoneNumber
- email
- address
- isPrimary
required:
- businessInformation
productInformation:
type: object
properties:
selectedProducts:
type: object
properties:
payments:
title: paymentsProducts
type: object
properties:
cardProcessing:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
features:
type: object
description: "This is a map. The allowed keys are below. Value should be an object containing a sole boolean property - enabled.\n\n \n | cardPresent | \n
\n \n | cardNotPresent | \n
\n
\n"
additionalProperties:
x-devcenter-additional-properties:
- cardPresent
- cardNotPresent
type: object
properties:
enabled:
type: boolean
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
title: CardProcessingConfig
properties:
common:
type: object
properties:
processors:
type: object
description: 'e.g.
* amexdirect
* barclays2
* CUP
* EFTPOS
* fdiglobal
* gpngsapv3
* gpx
* smartfdc
* tsys
* vero
* VPC
For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request.
e.g. replace VPC with <your vpc processor>
'
additionalProperties:
x-devcenter-additional-properties:
- amexdirect
- barclays2
- CUP
- EFTPOS
- fdiglobal
- gpngsapv3
- gpx
- smartfdc
- tsys
- vero
- VPC
type: object
properties:
batchGroup:
type: string
description: 'Determines the batching group that separates merchants for special batching times. Batching groups can separate merchant batches by the following criteria:
* Timezone
* Merchant deadlines
* Large merchants (top 10)
* Merchants with Service-Level Agreements
Applicable for Chase Paymentech Salem (chasepaymentechsalem), Streamline (streamline2), Six (six), Barclays (barclays2), Paymentech Tampa (paymentechtampa), CMCIC (cmcic), FDC Nashville (smartfdc), RUPAY, American Express Direct (amexdirect), GPN (gpn), VPC, GPX (gpx), CB2A, Barclays HISO (barclayshiso), TSYS (tsys) and FDI Global (fdiglobal) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required |
|---|
| Barclays | cnp, cp, hybrid | Yes |
| Barclays HISO | cnp, cp, hybrid | Yes |
| American Express Direct | cnp, cp, hybrid | No |
'
businessApplicationId:
type: string
description: Indicates the type of money transfer used in the transaction. Applicable for VPC and GPX (gpx) processors.
merchantVerificationValue:
type: string
description: Identify merchants that participate in Select Merchant Fee (SMF) programs. Unique to the merchant. Applicable for GPX (gpx) and VPC processors.
abaNumber:
type: string
description: Routing Number to identify banks within the United States. Applicable for GPX (gpx) processors.
acquirer:
type: object
description: Identifies the financial institution acting as the acquirer of this customer transaction. The acquirer is the member or system user that signed the merchant.
properties:
institutionId:
type: string
description: 'Identifier of the acquirer. This number is usually assigned by Visa.
Applicable for VPC, GPX (gpx), CMCIC (cmcic), EFTPOS, CB2A, CUP, American Express Direct (amexdirect) and Six (six) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex | Default Value |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | 1 | 13 | ^[0-9]+$ | 1111 |
'
interbankCardAssociationId:
type: string
description: Number assigned by MasterCard to banks to identify the member in transactions. Applicable for VPC and GPX (gpx) processors.
discoverInstitutionId:
type: string
description: Assigned by Discover to identify the acquirer. Applicable for VPC and GPX (gpx) processors.
unionPayInstitutionId:
type: string
description: Assigned by China Union Pay to identify the acquirer. Applicable for VPC processors.
dinersClubInstitutionId:
type: string
description: Assigned by Diners Club to identify the acquirer. Applicable for VPC processors.
countryCode:
type: string
description: ISO 4217 format. Applicable for VPC, GPX (gpx), EFTPOS, RUPAY, Prisma (prisma) and CUP processors.
fileDestinationBin:
type: string
description: The BIN to which this capturefile is sent. This field must contain a valid BIN. Applicable for VPC and GPX (gpx) processors.
acquirers:
type: object
description: Identifies the financial institution acting as the acquirer of this customer transaction. The acquirer is the member or system user that signed the merchant.
additionalProperties:
properties:
institutionId:
type: string
description: Identifier of the acquirer. This number is usually assigned by Visa.
interbankCardAssociationId:
type: string
description: Number assigned by MasterCard to banks to identify the member in transactions.
discoverInstitutionId:
type: string
description: Assigned by Discover to identify the acquirer.
countryCode:
type: string
description: ISO 4217 format.
fileDestinationBin:
type: string
description: The BIN to which this capturefile is sent. This field must contain a valid BIN.
merchantVerificationValue:
type: string
description: Identify merchants that participate in Select Merchant Fee (SMF) programs. Unique to the merchant.
merchantId:
type: string
description: Merchant ID assigned by an acquirer or a processor. Should not be overriden by any other party.
terminalId:
type: string
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
'
allowMultipleBills:
type: boolean
description: 'Allows multiple captures for a single authorization transaction.
'
enableTransactionReferenceNumber:
type: boolean
description: To enable merchant to send in transaction reference number (unique reconciliation ID).
paymentTypes:
type: object
description: 'Valid values are:
* VISA
* MASTERCARD
* AMERICAN_EXPRESS
* CUP
* EFTPOS
* DINERS_CLUB
* DISCOVER
* JCB
'
additionalProperties:
x-devcenter-additional-properties:
- VISA
- MASTERCARD
- AMERICAN_EXPRESS
- DISCOVER
- DINERS_CLUB
- JCB
- PIN_DEBIT
- JAYWAN
type: object
properties:
enabled:
type: boolean
currencies:
type: object
description: Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
additionalProperties:
x-devcenter-additional-properties:
- USD
- CAD
- GBP
- EUR
- CHF
- NGN
- ETB
- CUP
- AZN
- RWF
- DOP
- GMD
- BBD
- GTG
- NPR
- SHP
- BZD
- JMP
- PHP
- BRL
- TZS
- BAM
- ISK
- KWD
- RON
- ARS
- SBD
- NOK
- KRW
- TJS
- JOD
- MOP
- CLP
- SOS
- MGA
- LVL
- GIP
- PYG
- SAR
- PGK
- SGD
- ROL
- BSD
- TRY
- CDF
- SYP
- BMD
- MRO
- WST
- GHS
- BTN
- HNL
- MAD
- GAR
- SRD
- BDT
- KGS
- GNF
- CNY
- JPY
- LYD
- TTD
- CVE
- SZL
- ZMW
- KPW
- PEN
- YER
- VEB
- KHR
- VEF
- VUV
- SLL
- AFN
- SCR
- BOB
- COP
- LTL
- EGP
- HUF
- RSD
- AOA
- MYR
- MTL
- CYP
- FKP
- GYD
- PLN
- KMF
- SGD
- IQD
- DKK
- KES
- UZS
- TMM
- NZD
- LKR
- EEK
- SKK
- ANG
- INR
- UYU
- LSL
- TND
- STD
- HTG
- VND
- AED
- MZN
- BND
- KZT
- PKR
- XCD
- RUB
- MKD
- BWP
- AWG
- GEL
- MDL
- HKD
- MVR
- amd
- IRR
- NAD
- MWK
- MNT
- CRC
- XPF
- LAK
- HRK
- ALL
- TOP
- BIF
- MUR
- PAB
- FJD
- CZK
- ZWD
- KYD
- IDR
- BGN
- MXN
- UGX
- MMK
- UAH
- DZD
- XAF
- THB
- OMR
- XOF
- AUD
- ZAR
- LBP
- NIO
- DJF
- LRD
- TWD
- ERN
- BHD
- ILS
- SEK
- BYR
type: object
properties:
enabled:
type: boolean
enabledCardPresent:
type: boolean
description: Indicates whether the card-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardPresent will have the value of enabled.
enabledCardNotPresent:
type: boolean
description: Indicates whether the card-not-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardNotPresent will have the value of enabled.
merchantId:
type: string
description: Merchant ID assigned by an acquirer or a processor. Should not be overridden by any other party.
terminalId:
type: string
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
'
terminalIds:
type: array
items:
type: string
description: Applicable for Prisma (prisma) processor.
serviceEnablementNumber:
type: string
description: 'Service Establishment Number (a.k.a. SE Number) is a unique ten-digit number assigned by American Express to a merchant that accepts American Express cards.
10 digit number provided by acquirer currency. This may be unique for each currency, however it depends on the way the processor is set up for the merchant.
'
currencies:
type: object
description: Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
additionalProperties:
x-devcenter-additional-properties:
- USD
- CAD
- GBP
- EUR
- CHF
- NGN
- ETB
- CUP
- AZN
- RWF
- DOP
- GMD
- BBD
- GTG
- NPR
- SHP
- BZD
- JMP
- PHP
- BRL
- TZS
- BAM
- ISK
- KWD
- RON
- ARS
- SBD
- NOK
- KRW
- TJS
- JOD
- MOP
- CLP
- SOS
- MGA
- LVL
- GIP
- PYG
- SAR
- PGK
- SGD
- ROL
- BSD
- TRY
- CDF
- SYP
- BMD
- MRO
- WST
- GHS
- BTN
- HNL
- MAD
- GAR
- SRD
- BDT
- KGS
- GNF
- CNY
- JPY
- LYD
- TTD
- CVE
- SZL
- ZMW
- KPW
- PEN
- YER
- VEB
- KHR
- VEF
- VUV
- SLL
- AFN
- SCR
- BOB
- COP
- LTL
- EGP
- HUF
- RSD
- AOA
- MYR
- MTL
- CYP
- FKP
- GYD
- PLN
- KMF
- SGD
- IQD
- DKK
- KES
- UZS
- TMM
- NZD
- LKR
- EEK
- SKK
- ANG
- INR
- UYU
- LSL
- TND
- STD
- HTG
- VND
- AED
- MZN
- BND
- KZT
- PKR
- XCD
- RUB
- MKD
- BWP
- AWG
- GEL
- MDL
- HKD
- MVR
- amd
- IRR
- NAD
- MWK
- MNT
- CRC
- XPF
- LAK
- HRK
- ALL
- TOP
- BIF
- MUR
- PAB
- FJD
- CZK
- ZWD
- KYD
- IDR
- BGN
- MXN
- UGX
- MMK
- UAH
- DZD
- XAF
- THB
- OMR
- XOF
- AUD
- ZAR
- LBP
- NIO
- DJF
- LRD
- TWD
- ERN
- BHD
- ILS
- SEK
- BYR
type: object
properties:
enabled:
type: boolean
enabledCardPresent:
type: boolean
description: Indicates whether the card-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardPresent will have the value of enabled.
enabledCardNotPresent:
type: boolean
description: Indicates whether the card-not-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardNotPresent will have the value of enabled.
merchantId:
type: string
description: Merchant ID assigned by an acquirer or a processor. Should not be overridden by any other party.
terminalId:
type: string
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
'
terminalIds:
type: array
items:
type: string
description: Applicable for Prisma (prisma) processor.
serviceEnablementNumber:
type: string
description: 'Service Establishment Number (a.k.a. SE Number) is a unique ten-digit number assigned by American Express to a merchant that accepts American Express cards.
10 digit number provided by acquirer currency. This may be unique for each currency, however it depends on the way the processor is set up for the merchant.
'
merchantId:
type: string
description: 'Merchant ID assigned by an acquirer or a processor. Should not be overriden by any other party.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| Barclays HISO | cp, cnp, hybrid | Yes | 1 | 15 | ^[0-9a-zA-Z]+$ |
| Barclays | cp, cnp, hybrid | Yes | 1 | 11 | ^[0-9a-zA-Z]+$ |
'
terminalId:
type: string
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| Barclays HISO | cnp, hybrid | Yes | 1 | 16 | ^[0-9a-zA-Z]+$ |
| Barclays HISO | cp | No | 1 | 16 | ^[0-9a-zA-Z]+$ |
'
paymentTypes:
type: object
description: 'Valid values are:
* VISA
* MASTERCARD
* AMERICAN_EXPRESS
* CUP
* EFTPOS
* DINERS_CLUB
* DISCOVER
* JCB
'
additionalProperties:
x-devcenter-additional-properties:
- VISA
- MASTERCARD
- AMERICAN_EXPRESS
- DISCOVER
- DINERS_CLUB
- JCB
- PIN_DEBIT
- JAYWAN
type: object
properties:
enabled:
type: boolean
currencies:
type: object
description: Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
additionalProperties:
x-devcenter-additional-properties:
- USD
- CAD
- GBP
- EUR
- CHF
- NGN
- ETB
- CUP
- AZN
- RWF
- DOP
- GMD
- BBD
- GTG
- NPR
- SHP
- BZD
- JMP
- PHP
- BRL
- TZS
- BAM
- ISK
- KWD
- RON
- ARS
- SBD
- NOK
- KRW
- TJS
- JOD
- MOP
- CLP
- SOS
- MGA
- LVL
- GIP
- PYG
- SAR
- PGK
- SGD
- ROL
- BSD
- TRY
- CDF
- SYP
- BMD
- MRO
- WST
- GHS
- BTN
- HNL
- MAD
- GAR
- SRD
- BDT
- KGS
- GNF
- CNY
- JPY
- LYD
- TTD
- CVE
- SZL
- ZMW
- KPW
- PEN
- YER
- VEB
- KHR
- VEF
- VUV
- SLL
- AFN
- SCR
- BOB
- COP
- LTL
- EGP
- HUF
- RSD
- AOA
- MYR
- MTL
- CYP
- FKP
- GYD
- PLN
- KMF
- SGD
- IQD
- DKK
- KES
- UZS
- TMM
- NZD
- LKR
- EEK
- SKK
- ANG
- INR
- UYU
- LSL
- TND
- STD
- HTG
- VND
- AED
- MZN
- BND
- KZT
- PKR
- XCD
- RUB
- MKD
- BWP
- AWG
- GEL
- MDL
- HKD
- MVR
- amd
- IRR
- NAD
- MWK
- MNT
- CRC
- XPF
- LAK
- HRK
- ALL
- TOP
- BIF
- MUR
- PAB
- FJD
- CZK
- ZWD
- KYD
- IDR
- BGN
- MXN
- UGX
- MMK
- UAH
- DZD
- XAF
- THB
- OMR
- XOF
- AUD
- ZAR
- LBP
- NIO
- DJF
- LRD
- TWD
- ERN
- BHD
- ILS
- SEK
- BYR
type: object
properties:
enabled:
type: boolean
enabledCardPresent:
type: boolean
description: Indicates whether the card-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardPresent will have the value of enabled.
enabledCardNotPresent:
type: boolean
description: Indicates whether the card-not-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardNotPresent will have the value of enabled.
merchantId:
type: string
description: Merchant ID assigned by an acquirer or a processor. Should not be overridden by any other party.
terminalId:
type: string
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
'
terminalIds:
type: array
items:
type: string
description: Applicable for Prisma (prisma) processor.
serviceEnablementNumber:
type: string
description: 'Service Establishment Number (a.k.a. SE Number) is a unique ten-digit number assigned by American Express to a merchant that accepts American Express cards.
10 digit number provided by acquirer currency. This may be unique for each currency, however it depends on the way the processor is set up for the merchant.
'
currencies:
type: object
description: Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
additionalProperties:
x-devcenter-additional-properties:
- USD
- CAD
- GBP
- EUR
- CHF
- NGN
- ETB
- CUP
- AZN
- RWF
- DOP
- GMD
- BBD
- GTG
- NPR
- SHP
- BZD
- JMP
- PHP
- BRL
- TZS
- BAM
- ISK
- KWD
- RON
- ARS
- SBD
- NOK
- KRW
- TJS
- JOD
- MOP
- CLP
- SOS
- MGA
- LVL
- GIP
- PYG
- SAR
- PGK
- SGD
- ROL
- BSD
- TRY
- CDF
- SYP
- BMD
- MRO
- WST
- GHS
- BTN
- HNL
- MAD
- GAR
- SRD
- BDT
- KGS
- GNF
- CNY
- JPY
- LYD
- TTD
- CVE
- SZL
- ZMW
- KPW
- PEN
- YER
- VEB
- KHR
- VEF
- VUV
- SLL
- AFN
- SCR
- BOB
- COP
- LTL
- EGP
- HUF
- RSD
- AOA
- MYR
- MTL
- CYP
- FKP
- GYD
- PLN
- KMF
- SGD
- IQD
- DKK
- KES
- UZS
- TMM
- NZD
- LKR
- EEK
- SKK
- ANG
- INR
- UYU
- LSL
- TND
- STD
- HTG
- VND
- AED
- MZN
- BND
- KZT
- PKR
- XCD
- RUB
- MKD
- BWP
- AWG
- GEL
- MDL
- HKD
- MVR
- amd
- IRR
- NAD
- MWK
- MNT
- CRC
- XPF
- LAK
- HRK
- ALL
- TOP
- BIF
- MUR
- PAB
- FJD
- CZK
- ZWD
- KYD
- IDR
- BGN
- MXN
- UGX
- MMK
- UAH
- DZD
- XAF
- THB
- OMR
- XOF
- AUD
- ZAR
- LBP
- NIO
- DJF
- LRD
- TWD
- ERN
- BHD
- ILS
- SEK
- BYR
type: object
properties:
enabled:
type: boolean
enabledCardPresent:
type: boolean
description: 'Indicates whether the card-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardPresent will have the value of enabled.
'
enabledCardNotPresent:
type: boolean
description: 'Indicates whether the card-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardNotPresent will have the value of enabled.
'
merchantId:
description: 'Merchant ID assigned by an acquirer or a processor. Should not be overriden by any other party.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| Barclays | cp, cnp, hybrid | Yes | 1 | 11 | ^[0-9a-zA-Z]+$ |
'
terminalId:
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| Barclays | cp, cnp, hybrid | Yes | 8 | 8 | ^[0-9]+$ |
'
terminalIds:
type: array
items:
type: string
description: Applicable for Prisma (prisma) processor.
serviceEnablementNumber:
description: 'Service Establishment Number (a.k.a. SE Number) is a unique ten-digit number assigned by American Express to a merchant that accepts American Express cards.
10 digit number provided by acquirer currency. This may be unique for each currency, however it depends on the way the processor is set up for the merchant.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cp, cnp, hybrid | Yes | 10 | 10 | ^[0-9]+$ |
'
visaAggregatorId:
type: string
description: This field is used as aggregator Id when Visa payment type is selected
amexAggregatorId:
type: string
description: This field is used as aggregator Id when Amex payment type is selected
masterCardAggregatorId:
type: string
description: This field is used as aggregator Id when Master Card payment type is selected
sicCode:
type: string
description: The Standard Industrial Classification (SIC) are four-digit codes that categorize the industries that companies belong to based on their business activities. Standard Industrial Classification codes were mostly replaced by the six-digit North American Industry Classification System (NAICS). Applicable for VPC and GPX (gpx) processors.
allowMultipleBills:
type: boolean
description: 'Allows multiple captures for a single authorization transaction.
Applicable for Paymentech Tampa (paymentechtampa), VPC, American Express Direct (amexdirect) and GPX (gpx) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cp, hybrid | Yes | No |
| American Express Direct | cnp | No | No |
'
allowMerchantDescriptorOverride:
type: boolean
description: Enables partner to enable/disable merchant descriptors values. Applicable for VPC, EFTPOS and CUP processors.
enhancedData:
type: string
description: 'To enable airline transactions.
Applicable for TSYS (tsys), VPC, Elavon Americas (elavonamericas), FDI Global (fdiglobal), GPX (gpx), Barclays (barclays2) and American Express Direct (amexdirect) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required |
|---|
| Barclays | cnp, cp, hybrid | No |
| American Express Direct | cp, cnp, hybrid | No |
'
fireSafetyIndicator:
type: boolean
description: Indicates whether the merchant is compliant with Hotel and Motel Fire Safety Act of 1990. Applicable for GPX (gpx) and VPC processors.
quasiCash:
type: boolean
description: 'To enable quasi-cash transactions. A quasi-cash transaction is a cash-like transaction for the sale of items that are directly convertible to cash, such as:-
Casino gaming chips,
Money orders,
Wire transfers.
Applicable for GPX (gpx), TSYS (tsys), Barclays (barclays2) and VPC processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| Barclays | cnp, cp, hybrid | No | No |
'
acquirerMerchantId:
type: string
description: Identifier assigned by the acquirer. Applicable for RUPAY, VPC and Six (six) processors.
avsFormat:
type: string
description: "Enables Enhanced AVS/Automated Address Verification Plus (AAV+).\n\nValid values:\n\"basic\" - Standard address verification system.\n When a processor supports AVS for a transaction's card type, the issuing bank uses AVS to confirm that the customer has provided the correct billing address.\n When a customer provides incorrect information, the transaction might be fraudulent.\n\"basic + name\" - Enhanced address verification system.\n Consists of the standard AVS functionality plus verification of some additional fields.\n The additional fields that are verified for Enhanced AVS are:\n - customer_firstname\n - customer_lastname\n\"basic + name + shipto\" - Automated address verification plus.\n Consists of the Enhanced AVS functionality plus verification of some additional fields.\n AAV+ intended for merchants who deliver physical goods to a different address than the billing address.\n AAV+ verifies the additional fields only when the standard and Enhanced AVS tests pass first.\n For information about Enhanced AVS - The additional fields that are verified for AAV+ are:\n - ship_to_firstname\n - ship_to_lastname\n - ship_to_address1\n - ship_to_country\n - ship_to_zip\n - ship_to_phone\n - customer_phone(American Express Direct only)\n\nApplicable for American Express Direct (amexdirect) processor.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Default Value |
|---|
\n| American Express Direct | cnp, cp, hybrid | Yes | basic |
\n
\n"
enableLongTransRefNo:
type: boolean
description: 'Amex Direct specific merchant config value which determines what length (either 9 or Unique 12-char reference number) of reference number will be CYBS generated if the merchant does not pass in a trans_ref_no.
Can be any combination of alpha, numeric and special characters, and/or binary data in hexadecimal.
Applicable for American Express Direct (amexdirect) processor.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cp, cnp, hybrid | No | No |
'
enableLevel2:
type: boolean
description: 'Field that indicates whether merchant will send level 2 data for Amex cards.
Applicable for American Express Direct (amexdirect) processor.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cp, cnp, hybrid | No | No |
'
enableMultipleTransactionAdviceAddendum:
type: boolean
description: 'This flag related to multiple transaction advice addendum field. It is used to display descriptive information about a transaction on customer''s American Express card statement.
Applicable for American Express Direct (amexdirect) processor.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cp, cnp, hybrid | No | No |
'
amexTransactionAdviceAddendum1:
type: string
description: 'Advice addendum field. It is used to display descriptive information about a transaction on customer''s American Express card statement.
Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | No | 1 | 40 | ^[0-9a-zA-Z\-\s.]+$ |
'
enableMultiLineItems:
type: boolean
description: 'This flag is related to offer/line item details to be included instead of sending one line item, and a grand total. Example, offer0, offer 1...offer n.
Applicable for American Express Direct (amexdirect) and Elavon Americas (elavonamericas) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cp, cnp, hybrid | No | No |
'
enableTransactionReferenceNumber:
type: boolean
description: To enable merchant to send in transaction reference number (unique reconciliation ID). Applicable for VPC, Vero (vero), FDI Global (fdiglobal), Six (six), CB2A, CUP, VPC, Chase Paymentech Salem (chasepaymentechsalem), Fiserv (fiserv), Elavon Americas (elavonamericas) and EFTPOS processors.
enableAutoAuthReversalAfterVoid:
type: boolean
description: 'Enables to meet the Visa mandate requirements to reverse unused authorizations, benefitting the customer by releasing the hold on unused credit card funds.
Applicable for CB2A, Elavon Americas (elavonamericas), Six (six), VPC and American Express Direct (amexdirect) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cp, cnp, hybrid | No | No |
'
enableExpresspayPanTranslation:
type: boolean
description: When this is enabled, authorization responses from American Express expresspay transactions include the Primary Account Number (PAN) and expiration date of the card. Applicable for American Express Direct (amexdirect) processor.
enableCreditAuth:
type: boolean
description: Authorizes a credit. Reduces refund chargebacks and prevents customers from seeing the online update for credits which are otherwise offline settlements.
industryCode:
type: string
description: "Field used to identify the industry type of the merchant submitting the authorization request.\n\nValid values:\n`0` – unknown or unsure\n`A` – auto rental (EMV supported)\n`B` – bank/financial institution (EMV supported)\n`D` – direct marketing\n`F` – food/restaurant (EMV supported)\n`G` – grocery store/super market (EMV supported)\n`H` – hotel (EMV supported)\n`L` – limited amount terminal (EMV supported)\n`O` – oil company/automated fueling system (EMV supported)\n`P` – passenger transport (EMV supported)\n`R` – retail (EMV supported)\nApplicable for TSYS (tsys), RUPAY and Elavon Americas (elavonamericas) processors.\n \nPossible values:\n- 0\n- A\n- B\n- D\n- F\n- G\n- H\n- L\n- O\n- P\n- R"
sendAmexLevel2Data:
type: boolean
description: Field that indicates whether merchant will send level 2 data for Amex cards. Applicable for TSYS (tsys) processor.
softDescriptorType:
type: string
description: 'A soft descriptor is a text, rendered on a cardholder''s statement, describing a particular product or service, purchased by the cardholder.
Descriptors are intended to help the cardholder identify the products or services purchased.
Valid values:
`1` - trans_ref_no
`2` - merchant_descriptor
`3` - trans_ref_no and merchant_descriptor
Applicable for TSYS (tsys) processor.
'
vitalNumber:
type: string
description: V-number provided by TSYS info. The leading `V` must be replaced by a `7`. For example, replace `V1234567` with `71234567`. Applicable for TSYS (tsys) processor.
bankNumber:
type: string
description: 6 digit agent bank number provided by acquirer. Applicable for TSYS (tsys) processor.
chainNumber:
type: string
description: 6 digit chain number provided by acquirer. Applicable for TSYS (tsys) processor.
merchantBinNumber:
type: string
description: 6 digits acquirer bank identification number. Applicable for TSYS (tsys) processor.
merchantLocationNumber:
type: string
description: 5 digit merchant location number. Unless otherwise specified by merchant's bank or processor, this field should default to 00001. Applicable for TSYS (tsys) processor.
storeID:
type: string
description: 4 digits number used to identify a specific merchant store location within the member systems. Applicable for TSYS (tsys) processor.
travelAgencyCode:
type: string
description: Contains travel agency code if airline ticket was issued by a travel agency. Applicable for TSYS (tsys) processor.
travelAgencyName:
type: string
description: Contains travel agency name if airline ticket was issued by travel agency. Applicable for TSYS (tsys) processor.
settlementCurrency:
type: string
description: This field is used to indicate Merchant's settlement currency. [ISO 4217 ALPHA-3 Standard Currency Codes] Applicable for TSYS (tsys) and Streamline (streamline2) processors.
enableLeastCostRouting:
type: boolean
description: Indicates whether Least Cost Routing is enabled. Applicable for EFTPOS and CUP processors.
enableCVVResponseIndicator:
type: boolean
description: This field denotes EFTPOS Merchant's choice of receiving CVV Processing Response in return. Applicable for EFTPOS processors.
enableMultiCurrencyProcessing:
type: string
description: 'Applicable for Barclays (barclays2) processor.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| Barclays | cnp, cp, hybrid | No | Yes |
'
transactionTypeIdentifier:
type: string
maxLength: 3
minLength: 1
pattern: ^[0-9a-zA-Z]+$
description: Transaction Type Identifier (TTI) field for Mastercard AFT transactions. Maps to ISO field F104.65.32. Used to ensure compliance with Mastercard's requirements for money send transactions when wallet classifications differ between Visa and Mastercard schemes. Takes priority over BAI values for Mastercard AFT transactions when present.
subMerchantId:
type: string
maxLength: 55
minLength: 1
pattern: ^[0-9a-zA-Z\_\s]+$
description: The Sub merchant ID, sometimes referred to as the 'Seller ID' is generally used and *required for Aggregators and OptBlue participants. The 'Sub Merchant' is the Merchant whose transactions are submitted by a payment aggregator.
subMerchantEmail:
type: string
maxLength: 255
minLength: 0
pattern: ^([\w-]+(?:\.[\w-]+)*)@((?:[\w-]+\.)*\w[\w-]{0,70})\.([a-zA-Z]{2,6}(?:\.[a-zA-Z]{2})?)$
description: Sub Merchant Email of the Payment Facilitator's, OptBlue Participant
subMerchantPhoneNumber:
type: string
maxLength: 12
minLength: 1
pattern: ^[0-9a-zA-Z]+$
description: Sub Merchant Phone Number of the Payment Facilitator's, OptBlue Participant's
enablePosNetworkSwitching:
type: boolean
description: '''POS Network Switching'' or ''Alternate Routing'' means merchant can process PIN Debit transactions without a PIN. Set the value to ''Yes'' if it is supported. Applicable for FDI Global (fdiglobal) processor.'
enableDynamicCurrencyConversion:
type: boolean
description: Enable dynamic currency conversion for a merchant.
merchantTier:
type: string
maxLength: 3
minLength: 3
pattern: ^[0-9]+$
description: Merchant Tier defines the type of merchant, the numeric Merchant Tier value is allocated by EFTPOS. Applicable for EFTPOS processors.
required:
- merchantId
amexVendorCode:
type: string
description: Vendor code assigned by American Express. Applicable for TSYS (tsys) processor.
defaultAuthTypeCode:
type: string
description: "Authorization Finality indicator. Please note that the input can be in small case or capitals but response is in small case as of now. It will be made capitals everywhere in the next version.\nApplicable for Elavon Americas (elavonamericas), TSYS (tsys), Barclays (barclays2), Streamline (streamline2), Six (six), Barclays HISO (barclayshiso), GPN (gpn), FDI Global (fdiglobal), GPX (gpx), Paymentech Tampa (paymentechtampa), FDC Nashville (smartfdc), VPC and Chase Paymentech Salem (chasepaymentechsalem) processors.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Default Value |
|---|
\n| Barclays | cnp, cp, hybrid | No | FINAL |
\n| Barclays HISO | cnp, cp, hybrid | Yes | FINAL |
\n
\n \nPossible values:\n- PRE\n- FINAL\n- UNDEFINED"
masterCardAssignedId:
type: string
description: MAID aka MasterCard assigned ID, MasterCard equivalent of Merchant Verification Value by Visa. Applicable for VPC, GPX (gpx) and FDI Global (fdiglobal) processors.
enablePartialAuth:
type: boolean
description: 'Allow merchants to accept partial authorization approvals.
Applicable for Elavon Americas (elavonamericas), VPC, GPX (gpx), FDI Global (fdiglobal), FDC Nashville (smartfdc), GPN (gpn), TSYS (tsys), American Express Direct (amexdirect), Paymentech Tampa (paymentechtampa) and Chase Paymentech Salem (chasepaymentechsalem) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cnp, cp, hybrid | No | No |
'
merchantCategoryCode:
type: string
description: 'Indicates type of business product or service of the merchant.
Applicable for Chase Paymentech Salem (chasepaymentechsalem), FDI Global (fdiglobal), RUPAY, Elavon Americas (elavonamericas), American Express Direct (amexdirect), CMCIC (cmcic), GPX (gpx), VPC, TSYS (tsys), EFTPOS, CUP, Paymentech Tampa (paymentechtampa), CB2A, Barclays (barclays2), Prisma (prisma) and GPN (gpn) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| Barclays | cnp | No | 4 | 4 | ^[0-9]+$ |
| American Express Direct | cnp, cp, hybrid | Yes | 4 | 4 | ^[0-9]+$ |
'
sicCode:
type: string
description: The Standard Industrial Classification (SIC) are four-digit codes that categorize the industries that companies belong to based on their business activities. Standard Industrial Classification codes were mostly replaced by the six-digit North American Industry Classification System (NAICS). Applicable for VPC and GPX (gpx) processors.
foodAndConsumerServiceId:
type: string
description: Food and Consumer Service ID. Identifies the merchant as being certified and approved to accept Food Stamps. Applicable for GPX (gpx) processor.
enableSplitShipment:
type: boolean
description: 'Enables you to split an order into multiple shipments with multiple captures. This feature is provided by CyberSource and supports three different scenarios:
* multiple authorizations
* multiple captures
* multiple authorizations with multiple captures
Applicable for VPC processors.
'
enableInterchangeOptimization:
type: boolean
description: Reduces your interchange fees by using automatic authorization refresh and automatic partial authorization reversal. Applicable for VPC processors.
visaDelegatedAuthenticationId:
type: string
description: Identifier provided to merchants who opt for Visa's delegated authorization program. Applicable for VPC processors.
creditCardRefundLimitPercent:
type: string
description: Blocks over-refunds when the aggregated refund amount is higher than the percentage set for this field. Applicable for GPX (gpx), VPC and Chase Paymentech Salem (chasepaymentechsalem) processors.
businessCenterCreditCardRefundLimitPercent:
type: string
description: Limits refunds to the percentage set in this field. Applicable for GPX (gpx) and VPC processors.
allowCapturesGreaterThanAuthorizations:
type: boolean
description: Enables this merchant account to capture amounts greater than the authorization amount. Applicable for GPX (gpx), VPC, Paymentech Tampa (paymentechtampa) and Chase Paymentech Salem (chasepaymentechsalem) processors.
enableDuplicateMerchantReferenceNumberBlocking:
type: boolean
description: Helps prevent duplicate transactions. Applicable for VPC, GPX (gpx) and Chase Paymentech Salem (chasepaymentechsalem) processors.
domesticMerchantId:
type: boolean
description: This is a local merchant ID used by merchants in addition to the conventional merchant ID. This value is sent to the issuer. Applicable for VPC and Prisma (prisma) processors.
processLevel3Data:
type: string
description: 'Indicates whether merchant processes Level 3 transactions.
Applicable for TSYS (tsys), Barclays (barclays2), Paymentech Tampa (paymentechtampa), FDI Global (fdiglobal), Elavon Americas (elavonamericas) and Chase Paymentech Salem (chasepaymentechsalem) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required |
|---|
| Barclays | cnp | No |
'
subMerchantId:
type: string
description: 'The ID assigned to the sub-merchant.
Applicable for American Express Direct (amexdirect) processor.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | No | 1 | 20 | ^[0-9a-zA-Z\-\_\,\s.]+$ |
'
subMerchantBusinessName:
type: string
description: 'Sub-merchant''s business name.
Applicable for American Express Direct (amexdirect) processor.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | No | 1 | 37 | ^[0-9a-zA-Z\-\_\,\s.]+$ |
'
preferCobadgedSecondaryBrand:
type: boolean
description: It denotes merchant's preference on secondary brand for routing in case of co-branded cards. Applicable for EFTPOS processors.
merchantDescriptorInformation:
type: object
description: A merchant descriptor is the line of copy that identifies transactions on a cardholder's account activity and statement. If this information is not populated, the data will be retrieved from OMS.
properties:
name:
type: string
description: 'Applicable for TSYS (tsys), RUPAY, American Express Direct (amexdirect) and Elavon Americas (elavonamericas) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | 1 | 38 | ^[0-9a-zA-Z\s]+$ |
'
city:
type: string
description: 'Applicable for American Express Direct (amexdirect), TSYS (tsys), RUPAY and Elavon Americas (elavonamericas) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | 1 | 21 | ^[0-9a-zA-Z\s]+$ |
'
country:
type: string
description: 'Applicable for Six (six), Elavon Americas (elavonamericas), TSYS (tsys) and American Express Direct (amexdirect) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | 3 | 3 | ^[A-Z]+$ |
'
phone:
type: string
description: 'Applicable for RUPAY, Elavon Americas (elavonamericas), American Express Direct (amexdirect) and TSYS (tsys) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | 1 | 20 | ^[0-9a-zA-Z\s]+$ |
'
state:
type: string
description: 'Applicable for RUPAY, TSYS (tsys), Elavon Americas (elavonamericas) and American Express Direct (amexdirect) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | No | 1 | 3 | ^[A-Z]+$ |
'
street:
type: string
description: 'Applicable for American Express Direct (amexdirect), TSYS (tsys) and Elavon Americas (elavonamericas) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | 1 | 38 | ^[0-9a-zA-Z\s]+$ |
'
zip:
type: string
description: 'Applicable for Elavon Americas (elavonamericas), RUPAY, American Express Direct (amexdirect) and TSYS (tsys) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | 1 | 15 | ^[0-9a-zA-Z\s]+$ |
'
url:
type: string
description: 'Applicable for RUPAY and American Express Direct (amexdirect) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, hybrid | Yes | 1 | 40 | URL |
| American Express Direct | cp | No | 1 | 40 | URL |
'
countryOfOrigin:
type: string
description: Country Cf Origin of merchant is applicable for VPC Processors and is dependent on governmentControlled attribute.
acquirerAgreement:
type: object
description: Contains information about the acquirer agreement. The payload will have acquirerCode (example "Sumitomo") and its object containing all the acquirerAgreement fields.
properties:
acquirerCode:
type: object
description: Contains the specific configuration details for an acquirer.
properties:
acquirerAccountId:
type: string
description: Account number for the acquirer.
summerBonusStartDate:
type: string
description: Bonus start date for the summer period.
summerBonusEndDate:
type: string
description: Bonus end date for the summer period.
summerBonusMonth:
type: string
description: Bonus month for the summer period .
winterBonusStartDate:
type: string
description: Bonus start date for the winter period.
winterBonusEndDate:
type: string
description: Bonus end date for the winter period.
winterBonusMonth:
type: string
description: Bonus month for the winter period .
numberOfInstallments:
type: string
description: Comma-separated list of the number of installments.
paymentModes:
type: string
description: Comma-separated list of payment modes.
numberOfInstallmentPayments:
type: string
description: Comma-separated list of the number of installment payments.
numberOfIntegratedInstallments:
type: string
description: Comma-separated list of the number of integrated installments.
numberOfBonusPayments:
type: string
description: Comma-separated list of the number of bonus payments.
centerName:
type: string
description: Center name provided by the acquirer.
fbnIdentificationFlag:
type: string
description: FBN (For Benefit Of) Identification flag.
retailSupported:
type: boolean
description: Indicates if retail transactions are supported.
paymentOptions:
type: object
properties:
jpPaymentOptionType:
type: array
items:
type: string
description: An array of Japan-specific payment options.
governmentControlled:
type: boolean
description: Indicates whether the merchant is government controlled. Applicable for VPC processors.
dropBillingInfo:
type: boolean
description: This field is used to indicate whether the merchant wants to drop the billing information from the request. If this field is set to true, then the billing information will be dropped from the request. If this field is set to false, then the billing information will be sent in the request.
features:
type: object
properties:
cardNotPresent:
type: object
properties:
processors:
type: object
description: 'e.g.
* amexdirect
* barclays2
* CUP
* EFTPOS
* fdiglobal
* gpx
* smartfdc
* tsys
* vero
* VPC
For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request.
e.g. replace VPC with <your vpc processor>
'
additionalProperties:
x-devcenter-additional-properties:
- amexdirect
- barclays2
- CUP
- EFTPOS
- fdiglobal
- gpx
- smartfdc
- tsys
- VPC
type: object
properties:
relaxAddressVerificationSystem:
type: boolean
description: 'Enables you to submit the payment transaction without one or more of the fields for the billTo or card_expiration.
Applicable for Elavon Americas (elavonamericas), CB2A, Six (six), CMCIC (cmcic), GPX (gpx), GPN (gpn), VPC, Vero (vero), Fiserv (fiserv), American Express Direct (amexdirect), Chase Paymentech Salem (chasepaymentechsalem), RUPAY, FDI Global (fdiglobal) and Barclays HISO (barclayshiso) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| Barclays HISO | cp, cnp, hybrid | No | Yes |
| American Express Direct | cnp | No | No |
| American Express Direct | cp | No | Yes |
| American Express Direct | hybrid | Yes | Yes |
'
relaxAddressVerificationSystemAllowZipWithoutCountry:
type: boolean
description: 'Allows Zip code without country.
Applicable for American Express Direct (amexdirect), GPX (gpx), VPC, FDI Global (fdiglobal), Elavon Americas (elavonamericas), Chase Paymentech Salem (chasepaymentechsalem), RUPAY, GPN (gpn) and Barclays HISO (barclayshiso) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| Barclays HISO | cp, cnp, both | No | Yes |
| American Express Direct | cp, hybrid | No | Yes |
| American Express Direct | cnp | No | No |
'
relaxAddressVerificationSystemAllowExpiredCard:
type: boolean
description: 'Allows transactions that use an expired card.
Applicable for American Express Direct (amexdirect), GPN (gpn), Barclays HISO (barclayshiso), Elavon Americas (elavonamericas), VPC, FDI Global (fdiglobal), GPX (gpx), RUPAY, Six (six), Chase Paymentech Salem (chasepaymentechsalem) and CB2A processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| Barclays HISO | cp, cnp, hybrid | No | Yes |
| American Express Direct | cp, hybrid | No | Yes |
| American Express Direct | cnp | No | No |
'
enableEmsTransactionRiskScore:
type: boolean
description: MasterCard Expert Monitoring Solutions (EMS) provides a predictive, behavior-based fraud score in real time during authorizations for card-not-present (CNP) transactions on cards issued in the U.S. Applicable for GPX (gpx) and VPC processors.
prestigiousPropertyIndicator:
type: string
description: Applicable for VPC processors.
payouts:
type: object
properties:
reimbursementCode:
type: string
description: Applicable for VPC processors.
acquiringInstitutionId:
type: string
description: This code identifies the financial institution acting as the acquirer of this customer transaction. The acquirer is the member or system user that signed the merchant. This number is usually a Visa-assigned. Applicable for VPC processors.
businessApplicationId:
type: string
description: Transaction type. List of supported identifiers documented in the Developer Guide. Applicable for GPX (gpx) and VPC processors.
financialInstitutionId:
type: string
description: Applicable for GPX (gpx) and VPC processors.
merchantAbaNumber:
type: string
description: Routing Number to identify banks within the United States. Applicable for VPC processors.
networkOrder:
type: string
description: Order of the networks in which Visa should make routing decisions. Applicable for VPC processors.
currencies:
type: object
description: Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
additionalProperties:
x-devcenter-additional-properties:
- USD
- CAD
- GBP
- EUR
- CHF
- NGN
- ETB
- CUP
- AZN
- RWF
- DOP
- GMD
- BBD
- GTG
- NPR
- SHP
- BZD
- JMP
- PHP
- BRL
- TZS
- BAM
- ISK
- KWD
- RON
- ARS
- SBD
- NOK
- KRW
- TJS
- JOD
- MOP
- CLP
- SOS
- MGA
- LVL
- GIP
- PYG
- SAR
- PGK
- SGD
- ROL
- BSD
- TRY
- CDF
- SYP
- BMD
- MRO
- WST
- GHS
- BTN
- HNL
- MAD
- GAR
- SRD
- BDT
- KGS
- GNF
- CNY
- JPY
- LYD
- TTD
- CVE
- SZL
- ZMW
- KPW
- PEN
- YER
- VEB
- KHR
- VEF
- VUV
- SLL
- AFN
- SCR
- BOB
- COP
- LTL
- EGP
- HUF
- RSD
- AOA
- MYR
- MTL
- CYP
- FKP
- GYD
- PLN
- KMF
- SGD
- IQD
- DKK
- KES
- UZS
- TMM
- NZD
- LKR
- EEK
- SKK
- ANG
- INR
- UYU
- LSL
- TND
- STD
- HTG
- VND
- AED
- MZN
- BND
- KZT
- PKR
- XCD
- RUB
- MKD
- BWP
- AWG
- GEL
- MDL
- HKD
- MVR
- amd
- IRR
- NAD
- MWK
- MNT
- CRC
- XPF
- LAK
- HRK
- ALL
- TOP
- BIF
- MUR
- PAB
- FJD
- CZK
- ZWD
- KYD
- IDR
- BGN
- MXN
- UGX
- MMK
- UAH
- DZD
- XAF
- THB
- OMR
- XOF
- AUD
- ZAR
- LBP
- NIO
- DJF
- LRD
- TWD
- ERN
- BHD
- ILS
- SEK
- BYR
type: object
properties:
enabled:
type: boolean
enabledCardPresent:
type: boolean
description: 'Indicates whether the card-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardPresent will have the value of enabled.
'
enabledCardNotPresent:
type: boolean
description: 'Indicates whether the card-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardNotPresent will have the value of enabled.
'
merchantId:
type: string
description: Merchant ID assigned by an acquirer or a processor. Should not be overriden by any other party.
terminalId:
type: string
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
'
terminalIds:
type: array
items:
type: string
description: Applicable for Prisma (prisma) processor.
serviceEnablementNumber:
type: string
description: 'Service Establishment Number (a.k.a. SE Number) is a unique ten-digit number assigned by American Express to a merchant that accepts American Express cards.
10 digit number provided by acquirer currency. This may be unique for each currency, however it depends on the way the processor is set up for the merchant.
'
example:
USD:
enabled: true
enabledCardPresent: false
enabledCardNotPresent: true
merchantId: merchantId
terminalIds:
- '12345678'
- '12345678'
serviceEnablementNumber: serviceEnablementNumber
merchantId:
type: string
description: 'Merchant ID assigned by an acquirer or a processor. Should not be overridden by any other party.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| Barclays | cnp, hybrid | No | 1 | 11 | ^[0-9]+$ |
'
terminalId:
type: string
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| Barclays | cnp, hybrid | No | 1 | 255 | ^[0-9:\-]+$ |
'
ignoreAddressVerificationSystem:
type: boolean
description: Flag for a sale request that indicates whether to allow the capture service to run even when the authorization receives an AVS decline. Applicable for VPC, FDI Global (fdiglobal), GPX (gpx) and GPN (gpn) processors.
visaStraightThroughProcessingOnly:
type: boolean
description: Indicates if a merchant is enabled for Straight Through Processing - B2B invoice payments. Applicable for FDI Global (fdiglobal), TSYS (tsys), VPC and GPX (gpx) processors.
amexTransactionAdviceAddendum1:
type: string
description: Advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors.
installment:
type: object
properties:
enableInstallment:
type: boolean
description: 'This flag is to enable for installment plan programs.
Applicable for Fiserv (fiserv), Vero (vero) and American Express Direct (amexdirect) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cnp | No | No |
'
installmentPlan:
type: string
description: 'This indicates the type of funding for the installment plan associated with the payment.
Valid values:
"merchant" - Merchant-funded installment plan
"issuer" - Issuer-funded installment plan
Applicable for Fiserv (fiserv), American Express Direct (amexdirect) and Vero (vero) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required |
|---|
| American Express Direct | cnp | No |
'
cardPresent:
type: object
properties:
processors:
type: object
description: 'e.g.
* amexdirect
* barclays2
* CUP
* EFTPOS
* fdiglobal
* gpx
* smartfdc
* tsys
* vero
* VPC
For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request.
e.g. replace VPC with <your vpc processor>
'
additionalProperties:
x-devcenter-additional-properties:
- amexdirect
- barclays2
- CUP
- EFTPOS
- fdiglobal
- gpx
- smartfdc
- tsys
- VPC
type: object
properties:
defaultPointOfSaleTerminalId:
type: string
description: 'Default Terminal ID used for Card Present and Virtual Terminal transactions.
Applicable for VPC, GPX (gpx), American Express Direct (amexdirect) and Chase Paymentech Salem (chasepaymentechsalem) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex | Default Value |
|---|
| American Express Direct | cp | Yes | 4 | 8 | ^[0-9a-zA-Z]+$ | 1111 |
'
pointOfSaleTerminalIds:
type: array
items:
type: string
format: csv
description: For retail transactions, if merchant chooses to send the terminal id in the API, then that value has to be validated before being used. Holds a comma separated list of all possible terminal ids that the merchant is likely to send. Applicable for VPC processors.
disablePointOfSaleTerminalIdValidation:
type: boolean
description: Disables terminal ID validation. Applicable for VPC processors.
pinDebitNetworkOrder:
type: string
description: Order of the networks in which Visa should make routing decisions. Applicable for GPX (gpx) and VPC processors.
pinDebitReimbursementCode:
type: string
description: This attribute requests VIP to qualify a given PIN Debit transaction for a certain type of interchange program. Y = SMS supermarket, Z = SMS general merchant. Applicable for GPX (gpx) and VPC processors.
financialInstitutionId:
type: string
description: Acquirer Institution ID for the PIN Debit Transactions. Applicable for GPX (gpx) and VPC processors.
enablePinTranslation:
type: boolean
description: Enables CyberSource PIN Translation for Online PIN Transactions. Please ensure you have exchanged PIN keys with CyberSource to use this feature. Applicable for VPC processors.
enableTerminalIdLookup:
type: boolean
description: Used for Card Present and Virtual Terminal Transactions for Terminal ID lookup. Applicable for GPX (gpx) processor.
alternativePaymentMethods:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
configurationInformation:
type: object
properties:
configurations:
type: object
properties:
merchantCategoryCode:
type: string
description: 'Merchant Category Code (MCC) is a four-digit number assigned to a business by credit card companies
when the business first starts accepting credit cards as a form of payment. The MCC is used to
classify the business by the type of goods or services it provides.
'
processors:
type: object
description: "This is a map. The allowed keys are below. Value should be an object containing a sole boolean property - enabled.\n\n \n | klarna | \n
\n \n | payPal | \n
\n \n | alipay | \n
\n \n | bancontact | \n
\n \n | giropay | \n
\n \n | ideal | \n
\n
\n"
additionalProperties:
type: object
description: 'Processor configuration for the product.
'
properties:
paymentMethods:
type: object
description: 'Payment methods supported by the processor. The following values are supported:
- klarna
- CREDIT_CARD
- DEBIT_CARD
'
additionalProperties:
type: object
description: 'Payment method configuration for the product.
'
properties:
merchantId:
type: string
description: 'Merchant ID for the payment method. This is a unique identifier for the merchant.
example. mid12345678
'
logoUrl:
type: string
description: 'URL of the logo for the payment method. This is used for branding purposes.
example: http://www.test.com
'
redirectSuccessUrl:
type: string
description: 'URL to redirect to after a successful transaction. This is where the user will be sent after completing the payment.
example: http://www.test.com/success
'
redirectCancelUrl:
type: string
description: 'URL to redirect to if the user cancels the transaction. This is where the user will be sent if they choose to cancel the payment.
example: http://www.test.com/cancel
'
redirectFailureUrl:
type: string
description: 'URL to redirect to if the transaction fails. This is where the user will be sent if there is an error during the payment process.
example: http://www.test.com/failure
'
underwriting:
title: underwritingConfiguration
type: object
description: 'Underwriting configuration containing the complete VMES (Visa Merchant Evaluation Service) payload for merchant risk evaluation.
'
properties:
clientReferenceInformation:
type: object
properties:
clientRequestId:
description: 'client-generated request reference or tracking number. It is recommended that you send a unique value for each request so that you can perform meaningful searches for the request.
'
type: string
maxLength: 50
minLength: 1
pattern: ^[0-9a-zA-Z_]+$
example: merch-test1
applicationName:
type: string
maxLength: 50
description: "The name of the application (such as Boarding Workflow or Anet Boarding) that the client uses to send a request to merchant evaluation service. \n"
minLength: 1
pattern: ^[0-9a-zA-Z_]+$
example: merch-test1
merchantApplication:
type: object
required:
- products
properties:
applicationId:
type: string
readOnly: true
applicationStatus:
type: string
readOnly: true
products:
description: The product(s) that are being underwritten
type: array
items:
type: object
required:
- productShortName
properties:
productShortName:
description: 'Product Name
[PRODUCT1, PRODUCT2, PRODUCT3]
'
type: string
pattern: ^[a-zA-Z0-9-]{1,30}$
preferredAcquirer:
description: Override Acquirer Value
type: string
maxLength: 30
pattern: ^[a-zA-Z0-9-_]$
status:
readOnly: true
description: 'Product status
[]
'
type: string
campaignId:
description: Driver Campaign ID, identifies where the application came from
type: string
ocId:
description: Offer CampaignID, used by Sales
type: string
resellerId:
description: ResellerID, used by Sales
type: string
maxLength: 128
metadata:
type: object
metadataExternal:
type: object
organizationInformation:
type: object
properties:
parentOrganizationId:
type: string
minLength: 6
maxLength: 30
pattern: ^[0-9a-zA-Z_]+$
description: Parent Organization ID for the application
organizationId:
type: string
minLength: 6
maxLength: 30
pattern: ^[0-9a-zA-Z_]+$
description: Organization ID for the application
boardingPackageId:
type: string
maxLength: 60
description: Boarding Package ID for the application
businessInformation:
type: object
required:
- businessIdentifier
- countryRegistration
- legalName
- doingBusinessAs
- businessDescription
- startDate
- merchantCategoryCode
- businessType
- countryPhoneNumber
- phoneNumber
- email
properties:
businessIdentifier:
type: string
maxLength: 20
pattern: ^[a-zA-Z0-9]*$
description: Tax ID for the business
countryRegistration:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country where the business is registered. Two character country code, ISO 3166-1 alpha-2.
legalName:
type: string
minLength: 1
maxLength: 60
description: The legally registered name of the business
doingBusinessAs:
type: string
maxLength: 60
description: The DBA of the business.
businessDescription:
type: string
maxLength: 250
description: Short description of the Business
registrationNumber:
type: string
maxLength: 60
description: Registration ID for Enterprise Merchant
stockExchange:
type: string
maxLength: 60
description: Which stock exchange is the company trading in?
tickerSymbol:
type: string
maxLength: 10
pattern: ^[a-zA-Z0-9_.]*$
description: Stock Symbol on the exchange
startDate:
type: string
format: date
description: 'When did Business start. Format: YYYY-MM-DD Example 2016-08-11 equals August 11, 2016'
merchantCategoryCode:
type: string
maxLength: 4
pattern: ^\d{3,4}$
description: Industry standard Merchant Category Code (MCC)
mccDescription:
type: string
maxLength: 128
description: MCC Description
websiteURL:
type: string
maxLength: 100
description: Website for the Business
businessType:
type: string
description: "Business type \nPossible values:\n- PARTNERSHIP\n- SOLE_PROPRIETORSHIP\n- CORPORATION\n- LLC\n- NON_PROFIT\n- TRUST"
localMCC:
type: array
items:
type: string
countryPhoneNumber:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country of the Business phone number. Two character country code, ISO 3166-1 alpha-2.
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
description: Business Phone Number
email:
type: string
maxLength: 100
description: Business Email Address
whatYourCompanyDoes:
type: string
maxLength: 500
description: What your company does and how you market your service
address:
type: object
required:
- country
- address1
- locality
- administrativeArea
- postalCode
properties:
country:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country where the business is located. Two character country code, ISO 3166-1 alpha-2.
address1:
type: string
minLength: 1
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Business street address
address2:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Business street address continued
buildingName:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Building Name
locality:
type: string
minLength: 1
maxLength: 50
pattern: ^[0-9a-zA-Z _\-\u00A1-\uFFFF]+$
description: City of the billing address
administrativeArea:
type: string
minLength: 1
maxLength: 50
pattern: ^[0-9a-zA-Z _\-\u00A1-\uFFFF]+$
description: Business state (US) or province (Canada, others). Required for US and Canada.
postalCode:
type: string
minLength: 1
maxLength: 20
description: Business zip code (US) or postal code (Canada). The postal code must consist of 5 to 9 digits. Required for United States and Canada.
tradingAddress:
type: object
properties:
country:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country where the business is located. Two character country code, ISO 3166-1 alpha-2.
address1:
type: string
minLength: 1
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Business street address
address2:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Business street address continued
buildingName:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Building Name
locality:
type: string
minLength: 1
maxLength: 50
pattern: ^[0-9a-zA-Z _\-\u00A1-\uFFFF]+$
description: City of the billing address
administrativeArea:
type: string
minLength: 1
maxLength: 50
pattern: ^[0-9a-zA-Z _\-\u00A1-\uFFFF]+$
description: Business state (US) or province (Canada, others). Required for US and Canada.
postalCode:
type: string
minLength: 1
maxLength: 20
description: Business zip code (US) or postal code (Canada). The postal code must consist of 5 to 9 digits. Required for United States and Canada.
businessContact:
type: object
required:
- firstName
- lastName
- phoneNumber
- email
properties:
firstName:
type: string
maxLength: 50
description: Contact Person First Name
middleName:
type: string
maxLength: 50
description: Contact Person Middle Name
lastName:
type: string
maxLength: 50
description: Contact Person Last Name
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
description: Contact Person Phone Number
email:
type: string
maxLength: 100
description: Contact Persona Email
businessDetails:
type: object
required:
- interactionTypes
- percentageSplitByF2F
- percentageSplitByCNP
- whenIsCustomerCharged
- offerSubscriptions
properties:
customerType:
type: string
description: "Who is the business interacting with? Business to Business, Business to Consumer, Both \nPossible values:\n- B2B\n- B2C\n- Both"
percentageSplitByB2B:
type: number
minimum: 0
maximum: 100
default: 0
description: '% Split'
percentageSplitByB2C:
type: number
minimum: 0
maximum: 100
default: 0
description: '% Split'
interactionTypes:
type: string
description: "Merchant Facing: Face to Face, Card Not Present, Both \nPossible values:\n- F2F\n- CNP\n- Both"
percentageSplitByF2F:
type: number
minimum: 0
maximum: 100
default: 0
description: '% Split'
percentageSplitByCNP:
type: number
minimum: 0
maximum: 100
default: 0
description: '% Split'
whenIsCustomerCharged:
type: string
description: "When is the customer charged? \nPossible values:\n- OneTimeBeforeServiceDelivery\n- OneTimeAfterServiceDelivery\n- Other"
whenIsCustomerChargedDescription:
type: string
maxLength: 30
offerSubscriptions:
type: boolean
description: Does Merchant Offer Subscriptions?
monthlySubscriptionPercent:
type: number
minimum: 0
maximum: 100
default: 0
description: '% of business is monthly subscriptions'
quarterlySubscriptionPercent:
type: number
minimum: 0
maximum: 100
default: 0
description: '% of business is quarterly subscriptions'
semiannualSubscriptionPercent:
type: number
minimum: 0
maximum: 100
default: 0
description: '% of business is semi-annual subscriptions'
annualSubscriptionPercent:
type: number
minimum: 0
maximum: 100
default: 0
description: '% of business is annual subscriptions'
currencyType:
type: string
description: "Processing Currency. ISO 4217, 3 characters. \nPossible values:\n- USD\n- CAD\n- EUR\n- GBP\n- CHF"
estimatedMonthlySales:
type: number
description: Merchant's estimated monthly sales
averageOrderAmount:
type: number
description: Merchant's average order amount
largestExpectedOrderAmount:
type: number
description: Merchant's largest expected order amount
primaryAccountUsage:
type: string
description: "Primary purpose of account usage \nPossible values:\n- Paying for goods / services\n- Repatriating overseas earnings\n- Intercompany transfers\n- Collecting funds from clients\n- Liquidity / FX\n- Payment to an individual\n- Investment activity\n- Property purchase/sale\n- Other"
sourceOfFunds:
type: string
description: "Source of Funds \nPossible values:\n- Business revenue\n- External or shareholder investment\n- Loan, advance or other borrowing\n- Donations or grants\n- Inter-company transfers\n- Proceeds of sales of assests\n- Other"
receiveMoney3rdParties:
type: boolean
description: Will you recieve money from 3rd parties into your account?
receiveTransactionFrequency:
type: string
description: "Roughly how often do you expect to send or receive transactions? \nPossible values:\n- One-off or infrequently\n- 1-20 per month\n- 20-50 per month\n- 50-100 per month\n- 100+ per month"
estimatedMonthlySpend:
type: string
description: "What is your estimated total monthly spend? \nPossible values:\n- <$10,000\n- $10,000 - $50,000\n- $50,000 - $100,000\n- $100,000 - $500,000\n- $500,000+"
countryTransactions:
type: array
items:
type: string
currenciesIn:
type: array
items:
type: string
currenciesOut:
type: array
items:
type: string
productServicesSubscription:
type: array
items:
type: object
properties:
productServiceName:
type: string
maxLength: 255
description: Name of the product, service, or subscription.
productServicePercentage:
type: number
minimum: 0
maximum: 100
description: Percentage of business revenue from this product or service.
ownerInformation:
type: array
items:
type: object
required:
- firstName
- lastName
- birthDate
- isPrimary
- hasSignificantResponsibility
- nationalId
- ownershipPercentage
- nationality
- dueDiligenceRequired
- phoneNumberCountryCode
- phoneNumber
- email
properties:
firstName:
type: string
maxLength: 50
description: Owner's first name
middleName:
type: string
maxLength: 50
description: Owner's middle name
lastName:
type: string
maxLength: 50
description: Owner's last name
birthDate:
type: string
format: date
description: 'Owner''s date of birth. Format: YYYY-MM-DD Example 2016-08-11 equals August 11, 2016'
isPrimary:
type: boolean
description: Primary Owner or Non-Primary Owner
hasSignificantResponsibility:
type: boolean
description: If not an owner, is the user a Control Person
ownerDirector:
type: boolean
description: Is the owner a Director as well?
nationalId:
type: string
maxLength: 15
description: Identification value from ID document
idCountry:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country of the ID document. Two character country code, ISO 3166-1 alpha-2.
passportNumber:
type: string
maxLength: 12
description: Passport Number
passportCountry:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Passport Country. Two character country code, ISO 3166-1 alpha-2.
jobTitle:
type: string
maxLength: 100
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
description: Owner's Job Title
ownershipPercentage:
type: number
minimum: 1
maximum: 100
description: Percentage of the company that owner owns
nationality:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country of origin for the owner. Two character country code, ISO 3166-1 alpha-2.
dueDiligenceRequired:
type: boolean
description: Indicates if due diligence checks should be run for this owner
phoneNumberCountryCode:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Phone number country. Two character country code, ISO 3166-1 alpha-2.
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
description: Owner's phone number
email:
type: string
maxLength: 100
description: Email address for Owner
address:
type: object
required:
- country
- address1
- locality
- administrativeArea
- postalCode
properties:
country:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country where the owner resides. Two character country code.
address1:
type: string
minLength: 1
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Owner's street address.
address2:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Owner's street address Continued
buildingName:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Building Name
locality:
type: string
minLength: 1
maxLength: 50
pattern: ^[0-9a-zA-Z _\-\u00A1-\uFFFF]+$
description: Owner's city
administrativeArea:
type: string
minLength: 1
maxLength: 50
description: Owner's state (US) or province (Canada, others)
postalCode:
type: string
minLength: 1
maxLength: 20
description: Owner's zip code (US) or postal code (Canada)
directorInformation:
type: array
items:
type: object
properties:
firstName:
type: string
maxLength: 50
description: Director's first name
middleName:
type: string
maxLength: 50
description: Director's middle name
lastName:
type: string
maxLength: 50
description: Director's last name
birthDate:
type: string
format: date
description: 'Director''s date of birth. Format: YYYY-MM-DD Example 2016-08-11 equals August 11, 2016'
email:
type: string
maxLength: 100
description: Email address for Director
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
description: Owner's phone number
nationality:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country of origin for the owner. Two character country code, ISO 3166-1 alpha-2.
nationalId:
type: string
maxLength: 15
description: Identification value from ID document
idCountry:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country of the ID document. Two character country code, ISO 3166-1 alpha-2.
passportNumber:
type: string
maxLength: 12
description: Passport Number
address:
type: object
properties:
country:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country where the Director resides. Two character country code.
address1:
type: string
minLength: 1
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Director's street address.
address2:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Director's street address Continued
buildingName:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Building Name
locality:
type: string
minLength: 1
maxLength: 50
pattern: ^[0-9a-zA-Z _\-\u00A1-\uFFFF]+$
description: Director's city
administrativeArea:
type: string
minLength: 1
maxLength: 50
pattern: ^[0-9a-zA-Z _\-\u00A1-\uFFFF]+$
description: Director's state (US) or province (Canada, others)
postalCode:
type: string
minLength: 1
maxLength: 20
description: Director's zip code (US) or postal code (Canada)
deviceInformation:
type: object
properties:
ipAddress:
description: IP Address of the user that filled in the Merchant Application
type: string
fingerprintSessionId:
description: Info about the user that filled in the Merchant Application
type: string
userAgent:
description: Info about the user that filled in the Merchant Application
type: string
depositInformation:
type: object
properties:
bankAccountCountry:
description: Country of the Bank Account. Two character country code, ISO 3166-1 alpha-2.
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
example: US
accountHolderName:
description: Name on the Bank Account
type: string
maxLength: 150
example: Sarah Jane Smith
accountType:
description: 'Type of Account
Possible Values:
- CHECKING
- SAVINGS
- CORPORATECHECKING
- CORPORATESAVINGS
'
type: string
example: CORPORATECHECKING
accountRoutingNumber:
description: Routing Number, IBAN, Swift/BIC, etc
type: string
pattern: ^[0-9a-zA-Z\+\-]+$
maxLength: 15
example: 111111111111111
accountNumber:
description: Account Number
type: string
pattern: ^[0-9a-zA-Z\+\-]+$
maxLength: 17
example: 111111111111110
billingInformation:
type: object
properties:
bankAccountInformation:
type: object
properties:
bankAccountCountry:
description: Country of the Bank Account. Two character country code, ISO 3166-1 alpha-2.
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
example: US
accountHolderName:
description: Name on the checking account
type: string
maxLength: 150
example: Sarah Jane Smith
accountType:
description: 'Type of Account
Possible Values:
- CHECKING
- SAVINGS
- CORPORATECHECKING
- CORPORATESAVINGS
'
type: string
example: CORPORATECHECKING
accountRoutingNumber:
description: Routing Number, IBAN, Swift/BIC, etc
type: string
maxLength: 15
pattern: ^[0-9a-zA-Z\+\-]+$
example: 111111111111111
accountNumber:
description: Account Number
type: string
maxLength: 17
pattern: ^[0-9a-zA-Z\+\-]+$
example: 111111111111110
saleRepresentativeInformation:
type: object
required:
- salesRepId
- salesRepFirstName
- salesRepLastName
- salesRepEmail
- salesRepNumericPhoneNumberCountryCode
- salesRepPhoneNumber
properties:
salesRepId:
description: Sales rep Identifier
type: string
maxLength: 60
salesRepFirstName:
description: Sales rep First Name
type: string
maxLength: 50
example: John
salesRepLastName:
description: Sales Rep Last Name
type: string
maxLength: 50
example: Johnson
salesRepEmail:
description: Sales Rep eMail
type: string
maxLength: 100
example: test@test.com
salesRepNumericPhoneNumberCountryCode:
description: Sales Rep Phone Number Country. Two character country code, ISO 3166-1 alpha-2.
type: string
minLength: 2
maxLength: 2
example: US
salesRepPhoneNumber:
description: Sales Rep Phone
type: string
maxLength: 20
example: 4567890398
fileAttachmentInformation:
type: object
properties:
fileGroupId:
description: The unique identifier for the file group
type: string
additionalConfigurations:
type: array
maxItems: 10
description: 'Additional configurations for the payment method. This can include various settings specific to the payment method.
'
items:
type: object
description: 'Additional configuration for the payment method.
'
properties:
key:
type: string
description: 'Key for the additional configuration. This is used to identify the specific setting.
example: serviceProviderId
'
value:
type: string
description: 'Value for the additional configuration. This is the actual setting being configured.
example: svcId
'
cardPresentConnect:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- NOT_SELF_SERVICEABLE"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
properties:
partnerSolutionIdentifier:
type: string
description: Solution identifier used to associate a partner organization with the Merchant that is on-boarded.
cybsReadyTerminal:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- NOT_SELF_SERVICEABLE"
eCheck:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
mode:
type: array
items:
type: string
description: Indicates what mode the product is expected to behave at boarding and transaction flows. Ex, Acquirer/Gateway/Other.
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
title: ECheckConfig
properties:
common:
type: object
properties:
processors:
type: object
additionalProperties:
type: object
description: Payment Processing connection used to support eCheck, aka ACH, payment methods. Example - "bofaach"
properties:
companyEntryDescription:
type: string
maxLength: 10
description: '*EXISTING* Company (merchant) defined description of entry to receive. For e.g. PAYROLL, GAS BILL, INS PREM. This field is alphanumeric'
companyId:
type: string
maxLength: 10
description: '*EXISTING* company ID assigned to merchant by Acquiring bank. This field is alphanumeric'
batchGroup:
type: string
description: '*EXISTING* Capture requests are grouped into a batch bound for your payment processor. The batch time can be identified by reading the last 2-digits as military time. E.g., _16 = your processing cutoff is 4PM PST. Please note if you are in a different location you may then need to convert time zone as well.'
enableAccuityForAvs:
type: boolean
default: true
description: '*NEW* Accuity is the original validation service that checks the account/routing number for formatting issues. Used by WF and set to "Yes" unless told otherwise'
accuityCheckType:
type: string
default: ALWAYS
description: "*NEW* \nPossible values:\n- ALWAYS"
setCompletedState:
type: boolean
default: false
description: '*Moved* When set to Yes we will automatically update transactions to a completed status X-number of days after the transaction comes through; if no failure notification is received. When set to No means we will not update transaction status in this manner. For BAMS/Bank of America merchants, they should be set to No unless we are explicitly asked to set a merchant to YES.'
required:
- companyEntryDescription
internalOnly:
type: object
properties:
displayEcheckInfo:
type: boolean
default: true
description: '*NEW* Used by EBC UI always set to true'
processors:
type: object
description: '*NEW* Payment Processing connection used to support eCheck, aka ACH, payment methods.
Example
* "bofaach"
* "wellsfargoach"
'
additionalProperties:
x-devcenter-additional-properties:
- bofaach
- wellsfargoach
type: object
description: Name of the payment processor. Example - "wellsfargoach"
properties:
enableCCS:
type: boolean
description: '*NEW* Flag to indicate whether the processor is migrated to the Common Connectivity Services Platform.
Applicable for VPC and amexdirect processors.
'
terminalId:
type: string
description: '*NEW* The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
Applicable for VPC processors.
'
enable15anTransactionReferenceNumber:
type: boolean
default: true
description: '*NEW* This ensures the transaction reference # contains an identifier that can be viewed in CYBS'
portalSupportedPaytypes:
type: string
default: CHECK
description: '*NEW* This is used by the EBC2 application'
settlementMethod:
type: string
default: BEST_GUESS
description: "*NEW* \nPossible values:\n- BEST_GUESS"
verificationLevel:
type: string
default: VALIDATION
description: "*NEW* \nPossible values:\n- VALIDATION"
setCompletedState:
type: boolean
default: false
description: '*Moved* When set to Yes we will automatically update transactions to a completed status X-number of days after the transaction comes through; if no failure notification is received. When set to No means we will not update transaction status in this manner. For BAMS/Bank of America merchants, they should be set to No unless we are explicitly asked to set a merchant to YES.'
accountHolderName:
type: string
maxLength: 22
description: "Mandatory \nName on Merchant's Bank Account\nOnly ASCII (Hex 20 to Hex 7E)\n"
accountType:
type: string
description: "Mandatory \nType of account for Merchant's Bank Account\nPossible values:\n- checking\n- savings\n- corporatechecking\n- corporatesavings\n"
accountRoutingNumber:
type: string
maxLength: 9
description: "Mandatory \nRouting number for Merchant's Bank Account\nUS Account Routing Number\n"
accountNumber:
type: string
maxLength: 17
description: "Mandatory \nAccount number for Merchant's Bank Account\n"
required:
- accountHolderName
- accountType
- accountRoutingNumber
- accountNumber
underwriting:
type: object
properties:
standardEntryClassCodes:
type: string
default: CCD,PPD,TEL,WEB
description: "Mandatory \nFree-text (csv) \nPossible values (combination):\n\nCCD — Cash Concentration or Disbursement, or CCD, is a charge or refund against a business checking account. One-time or recurring CCD transactions are fund transfers to or from a corporate entity. A standing authorization is required for recurring transactions.\nPPD — Prearranged Payment and Deposit Entry, or PPD, is a charge or refund against a customer's checking or savings account. PPD entries can only be originated when payment and deposit terms between the merchant and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions.\nTEL — Telephone-Initiated Entry, or TEL, is a one-time charge against a customer's checking or savings account. TEL transactions can only be originated when a business relationship between the merchant and the customer already exists; or if a relationship does not exist, then only when the customer initiates the telephone call to the merchant. Payment authorization is obtained from the customer by telephone.\nWEB — Internet-Initiated Entry or WEB is a charge against a customer's checking or savings account. One-time or recurring WEB transactions are originated through the Internet. Payment authorization is also obtained from the customer through the Internet.\n"
enableHold:
type: boolean
default: true
description: "Mandatory \nDetermines whether CYBS has placed the merchant on a funding hold\nThis will often be set to True for new merchants until the risk team has completed additional verification of their first transaction. It will be switched to \"false\" once underwriting review is completed and we are ready to start funding the merchant.\n"
monthlyTotalTransactionAmountLimit:
type: number
format: currency
description: "Mandatory \nMonthly Maximum total Transaction Amount\n12 digit including decimal\n"
holdingDays:
type: number
format: integer
default: 7
description: "Mandatory \nFunds Hold Days (Number of days funds will be held before it will be deposited into merchant account)\n3 digits\n"
enableCredits:
type: boolean
description: "Optional \nAllow Credits (True/False)\n"
transactionAmountLimit:
type: number
format: currency
description: "Mandatory \nMaximum total Transaction Amount\nThis is a per transaction limit. For example, the merchant is limited to processing transactions under $100\n12 digits (including decimal - USD only)\n"
riskReserveMethod:
type: string
description: "Mandatory\nReserve Method \nPossible value:\n- fixed\n- none\nMost merchants do not have a reserve attached to their account so the default value would be \"none.\" \n\nFor a Fixed Reserve, the reserve balance is established by either, (1) a receipt of a lump\nsum deposit from a merchant, or (2) withholding funds at a Reserve Rate established for\nthe account from each batch settlement until the reserve balance is equal to a set\nReserve Target. A Fixed Reserve may also be established by a combination of lump\nsum deposit and withholding of settlement funds.\n\nA Rolling Reserve balance is established by withholding from a merchant's available\nsettlement funds at a Reserve Rate (percentage) and no Reserve Target is specified.\nRather, each amount withheld is retained for a specified number of Reserve Holding\nDays and then released back to the merchant.\n"
riskReserveRate:
type: number
format: decimal
description: "Mandatory \nReserve Rate (% of TPV)=> Relevant for Rolling Reserve and Fixed Reserve\nThe percentage rate at which risk funds are withheld from each\neCheck.Net batch settlement.\n"
riskReserveTargetAmount:
type: number
format: currency
description: "Mandatory \nReserve Target (fixed $ amount)=> Relevant for Fixed Reserve ONLY\n\nThe maximum dollar amount that can be held in Risk Reserve for a\nfixed reserve. Once risk withholdings reach the Reserve Target established for the\neCheck.Net account, a portion of available funds will be deposited to the merchant's\nbank account\n12 digit including decimal\n"
solutionOrganizationId:
type: string
description: Solution organization id
required:
- standardEntryClassCodes
- enableHold
- monthlyTotalTransactionAmountLimit
- holdingDays
- transactionAmountLimit
- riskReserveMethod
- riskReserveRate
- riskReserveTargetAmount
features:
type: object
properties:
accountValidationService:
type: object
properties:
internalOnly:
type: object
properties:
processors:
type: object
description: '*NEW* Payment Processing connection used to support eCheck, aka ACH, payment methods.
Example
* "bofaach"
* "wellsfargoach"
'
additionalProperties:
x-devcenter-additional-properties:
- bofaach
- wellsfargoach
type: object
description: Name of the payment processor. Example - "wellsfargoach"
properties:
avsVersion:
type: string
default: '2'
description: "*NEW* \nPossible values:\n- 2"
processors:
type: object
description: '*NEW* Payment Processing connection used to support eCheck, aka ACH, payment methods.
Example
* "bofaach"
* "wellsfargoach"
'
additionalProperties:
type: object
description: '*NEW* Name of the payment processor. Example - "wellsfargoach"'
properties:
avsAccountOwnershipService:
type: boolean
description: '*NEW* Determined in WF eTicket if account has opted into the Account Ownership Service.'
avsAccountStatusService:
type: boolean
description: '*NEW* Determined in WF eTicket if account has opted into the Account Status Service.'
avsSignedAgreement:
type: boolean
description: '*NEW* Taken from Addendum Agreement Column in boarding form.'
avsCalculatedResponseBehavior:
type: string
default: continue
description: "*NEW* \nPossible values:\n- continue"
avsAdditionalId:
type: string
description: '*NEW* Also known as the Additional ID. Taken from the boarding form.'
enableAvs:
type: boolean
default: true
description: '*NEW*'
avsEntityId:
type: string
description: '*NEW* Also known as the AVS Gateway Entity ID.'
avsResultMode:
type: string
description: "*NEW* \nPossible values:\n- FULL_RESPONSE\n- LOGIC_BOX"
enableAvsTokenCreation:
type: boolean
default: false
description: '*NEW* Applicable if the merchant wants to run AVS on token creation requests only.'
payerAuthentication:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
title: PayerAuthConfig
properties:
cardTypes:
type: object
properties:
verifiedByVisa:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
masterCardSecureCode:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
amexSafeKey:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
jCBJSecure:
type: object
properties:
securePasswordForJCB:
type: string
minLength: 8
maxLength: 8
description: JSecure currency password for Japan Credit Bureau
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
dinersClubInternationalProtectBuy:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
ELO:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
UPI:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
CB:
type: object
properties:
requestorId:
type: string
minLength: 14
maxLength: 14
description: The value is for 3DS2.0 and is a Directory Server assigned 3DS Requestor ID value. If this field is passed in request, it will override Requestor Id value that is configured on the Merchant's profile.
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
digitalPayments:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
features:
type: object
description: "Allowed values are;\n\n \n | visaCheckout | \n
\n \n | applePay | \n
\n \n | samsungPay | \n
\n \n | googlePay | \n
\n
\n"
additionalProperties:
x-devcenter-additional-properties:
- visaCheckout
- applePay
- samsungPay
- googlePay
type: object
properties:
enabled:
type: boolean
secureAcceptance:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
title: SAConfig
properties:
parentProfileId:
type: string
description: You can group Secure Acceptance profiles under parent profiles. By changing the parent profile, you can update all profiles underneath that parent. Specify the Parent Profile ID here.
contactInformation:
type: object
description: Optional contact information to be associated with the Secure Acceptance profile - for example the developer of the integration to the Hosted Checkout.
properties:
phone:
type: string
companyName:
type: string
email:
type: string
name:
type: string
notifications:
type: object
properties:
merchantNotifications:
type: object
properties:
backofficePostEnabled:
type: boolean
description: Enables Webhook transaction confirmation messages sent to URL defined in backofficePostUrl. Usually enabled by web developers integrating to Secure Acceptance.
backofficeEmailAddress:
type: string
description: Email address to receive transaction confirmation messages.
backofficeEmailEnabled:
type: boolean
description: Enables email transaction confirmation messages, sent to the address specified in backofficeEmailAddress.
backofficePostUrl:
type: string
description: Webhook URL to which transaction confirmation is sent. Usually completed by the web developers integrating to Secure Acceptance.
cardNumberFormat:
type: string
description: "Format in which the card number should be masked in the notifications. \n\nValid values:\n`1` - Display first 6 digits only (e.g. \"444433**********\")\n\n`2` - Display last four digits only (e.g. \"************1111\")\n\n`3` - Display First six and last four digits (e.g. \"444433******1111\")\n"
customerNotifications:
type: object
description: Features relating to notifications being sent directly to the payer using the Hosted Checkout.
properties:
customReceiptPageEnabled:
type: boolean
description: Toggles the custom receipt page, where merchants can receive the results of the transaction and display appropriate messaging. Usually set by web developers integrating to Secure Acceptance.
receiptEmailAddress:
type: string
description: Email address where a copy of the payer's receipt email is sent, when notificationReceiptEmailEnabled is true.
customerReceiptEmailEnabled:
type: boolean
description: Toggles an email receipt sent to the payer's email address on payment success.
customCancelPage:
type: string
description: URL to which transaction results are POSTed when the payer clicks 'Cancel' on the Hosted Checkout. Triggered when customCancelPageEnabled is true. Usually set by web developers integrating to Secure Acceptance.
customReceiptPage:
type: string
description: URL to which transaction results are POSTed when the payer requests a payment on the Hosted Checkout. Triggered when customCancelPageEnabled is true. Usually set by web developers integrating to Secure Acceptance.
customCancelPageEnabled:
type: boolean
description: Toggles the custom cancel page, where merchants can receive notice that the payer has canceled, and display appropriate messaging and direction. Usually set by web developers integrating to Secure Acceptance.
notificationReceiptEmailEnabled:
type: boolean
description: Toggles whether merchant receives a copy of the payer's receipt email.
service:
type: object
properties:
decisionManagerVerboseEnabled:
type: boolean
description: Toggles whether verbose Decision Manager results should be present in the Secure Acceptance response. As this response passes through the browser, it is recommended to set this to "false" outside of debugging.
declinedRetryLimit:
type: number
description: Defines the number of retries a payer is presented with on payment declines on Hosted Checkout. Valid values are between 0 and 5.
decisionManagerEnabled:
type: boolean
description: Toggles whether Decision Manager is enabled or not for Secure Acceptance transactions. Requires the transacting MID to be enabled and configured for Decicion Manager.
tokenizationEnabled:
type: boolean
description: Toggles whether Tokenization is enabled or not for Secure Acceptance transactions. Requires the transacting MID to be enabled and configured for Tokenization.
reverseAuthOnAddressVerificationSystemFailure:
type: boolean
description: Toggles whether or not an approved Authorization that fails AVS should be automatically reversed.
deviceFingerprintEnabled:
type: boolean
description: Toggles whether or not fraud Device Fingerprinting is enabled on the Hosted Checkout. This simplifies enablement for Decision Manager.
reverseAuthOnCardVerificationNumberFailure:
type: boolean
description: Toggles whether or not an approved Authorization that fails CVN check that should be automatically reversed.
paymentMethods:
type: object
properties:
enabledPaymentMethods:
type: array
items:
type: string
description: 'Possible values:
- CARD
- ECHECK
- VISACHECKOUT
- PAYPAL'
checkout:
type: object
properties:
displayTaxAmount:
type: boolean
description: Toggles whether or not the tax amount is displayed on the Hosted Checkout.
templateType:
type: string
description: "Specifies whether the Hosted Checkout is displayed as a single page form or multi page checkout. \n\nValid values: \n`multi` \n`single`\n"
returnToMerchantSiteUrl:
type: string
description: URL of the website linked to from the Secure Acceptance receipt page. Only used if the profile does not have custom receipt pages configured.
paymentTypes:
type: object
description: Object containing Payment Types supported
properties:
cardTypes:
type: object
properties:
discover:
type: object
description: Object containing supported Card Types and settings
properties:
cardVerificationNumberSupported:
type: boolean
description: Dictates whether or Card Verification Number is supported by the card type. Usually this is set at system level.
cardVerificationNumberDisplay:
type: boolean
description: Toggles whether or Card Verification Number is displayed on the Hosted Checkout.
payerAuthenticationSupported:
type: boolean
description: Dictates whether or Payer Authentication is supported by the card type. Usually this is set at system level.
supportedCurrencies:
type: array
description: Array of the supported ISO 4217 alphabetic currency codes.
items:
type: string
method:
type: string
cardVerificationNumberRequired:
type: boolean
payerAuthenticationEnabled:
type: boolean
amex:
type: object
description: Object containing supported Card Types and settings
properties:
cardVerificationNumberSupported:
type: boolean
description: Dictates whether or Card Verification Number is supported by the card type. Usually this is set at system level.
cardVerificationNumberDisplay:
type: boolean
description: Toggles whether or Card Verification Number is displayed on the Hosted Checkout.
payerAuthenticationSupported:
type: boolean
description: Dictates whether or Payer Authentication is supported by the card type. Usually this is set at system level.
supportedCurrencies:
type: array
description: Array of the supported ISO 4217 alphabetic currency codes.
items:
type: string
method:
type: string
cardVerificationNumberRequired:
type: boolean
payerAuthenticationEnabled:
type: boolean
masterCard:
type: object
description: Object containing supported Card Types and settings
properties:
cardVerificationNumberSupported:
type: boolean
description: Dictates whether or Card Verification Number is supported by the card type. Usually this is set at system level.
cardVerificationNumberDisplay:
type: boolean
description: Toggles whether or Card Verification Number is displayed on the Hosted Checkout.
payerAuthenticationSupported:
type: boolean
description: Dictates whether or Payer Authentication is supported by the card type. Usually this is set at system level.
supportedCurrencies:
type: array
description: Array of the supported ISO 4217 alphabetic currency codes.
items:
type: string
method:
type: string
cardVerificationNumberRequired:
type: boolean
payerAuthenticationEnabled:
type: boolean
visa:
type: object
description: Object containing supported Card Types and settings
properties:
cardVerificationNumberSupported:
type: boolean
description: Dictates whether or Card Verification Number is supported by the card type. Usually this is set at system level.
cardVerificationNumberDisplay:
type: boolean
description: Toggles whether or Card Verification Number is displayed on the Hosted Checkout.
payerAuthenticationSupported:
type: boolean
description: Dictates whether or Payer Authentication is supported by the card type. Usually this is set at system level.
supportedCurrencies:
type: array
description: Array of the supported ISO 4217 alphabetic currency codes.
items:
type: string
method:
type: string
cardVerificationNumberRequired:
type: boolean
payerAuthenticationEnabled:
type: boolean
virtualTerminal:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
title: VTConfig
properties:
cardNotPresent:
type: object
properties:
globalPaymentInformation:
type: object
properties:
basicInformation:
type: object
properties:
defaultStandardEntryClassCode:
type: string
defaultCountryCode:
type: string
description: ISO 4217 format
defaultCurrencyCode:
type: string
description: Three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
defaultTransactionType:
type: string
description: 'Possible values:
- AUTHORIZATION
- SALE'
defaultPaymentType:
type: string
description: 'Possible values:
- CREDIT_CARD
- ECHECK'
defaultTransactionSource:
type: string
displayRetail:
type: boolean
displayMoto:
type: boolean
displayInternet:
type: boolean
paymentInformation:
type: object
properties:
displayCardVerificationValue:
type: array
items:
type: string
description: 'Possible values:
- VISA
- MASTER_CARD
- AMEX
- DISCOVER
- DINERS_CLUB
- CARTE_BLANCHE
- JCB
- ENROUTE
- JAL
- SWITCH_SOLO
- DELTA
- VISA_ELECTRON
- DANKORT
- LASER
- CARTE_SBANCAIRES
- CARTASI
- MAESTRO_INTERNATIONAL
- GE_MONEY_UK_CARD
- HIPER_CARD
- ELO'
requireCardVerificationValue:
type: array
items:
type: string
description: 'Possible values:
- VISA
- MASTER_CARD
- AMEX
- DISCOVER
- DINERS_CLUB
- CARTE_BLANCHE
- JCB
- ENROUTE
- JAL
- SWITCH_SOLO
- DELTA
- VISA_ELECTRON
- DANKORT
- LASER
- CARTE_SBANCAIRES
- CARTASI
- MAESTRO_INTERNATIONAL
- GE_MONEY_UK_CARD
- HIPER_CARD
- ELO'
acceptedCardTypes:
type: array
items:
type: string
description: 'Possible values:
- VISA
- MASTER_CARD
- AMEX
- DISCOVER
- DINERS_CLUB
- CARTE_BLANCHE
- JCB
- ENROUTE
- JAL
- SWITCH_SOLO
- DELTA
- VISA_ELECTRON
- DANKORT
- LASER
- CARTE_SBANCAIRES
- CARTASI
- MAESTRO_INTERNATIONAL
- GE_MONEY_UK_CARD
- HIPER_CARD
- ELO'
displayCreditCards:
type: boolean
displayEchecks:
type: boolean
displayDebtIndicator:
type: boolean
displayBillPayment:
type: boolean
enableEchecks:
type: boolean
displayIgnoreECheckAvsCheckbox:
type: boolean
firstNameRequired:
type: boolean
lastNameRequired:
type: boolean
displayFirstName:
type: boolean
displayLastName:
type: boolean
merchantDefinedDataFields:
type: object
properties:
displayMerchantDefinedData1:
type: boolean
displayMerchantDefinedData2:
type: boolean
displayMerchantDefinedData3:
type: boolean
displayMerchantDefinedData4:
type: boolean
displayMerchantDefinedData5:
type: boolean
merchantDefinedData1DefaultValue:
type: string
merchantDefinedData1Label:
type: string
requireMerchantDefinedData1:
type: boolean
merchantDefinedData2DefaultValue:
type: string
merchantDefinedData2Label:
type: string
requireMerchantDefinedData2:
type: boolean
merchantDefinedData3DefaultValue:
type: string
merchantDefinedData3Label:
type: string
requireMerchantDefinedData3:
type: boolean
merchantDefinedData4DefaultValue:
type: string
merchantDefinedData4Label:
type: string
requireMerchantDefinedData4:
type: boolean
merchantDefinedData5DefaultValue:
type: string
merchantDefinedData5Label:
type: string
requireMerchantDefinedData5:
type: boolean
merchantDefinedData1DisplayOnReceipt:
type: boolean
merchantDefinedData2DisplayOnReceipt:
type: boolean
merchantDefinedData3DisplayOnReceipt:
type: boolean
merchantDefinedData4DisplayOnReceipt:
type: boolean
merchantDefinedData5DisplayOnReceipt:
type: boolean
receiptInformation:
type: object
properties:
header:
type: object
properties:
virtualTerminalReceiptHeader:
type: string
orderInformation:
type: object
properties:
emailAliasName:
type: string
customReplyToEmailAddress:
type: string
emailReceipt:
type: object
properties:
sendersEmailAddress:
type: string
cardPresent:
type: object
properties:
globalPaymentInformation:
type: object
properties:
basicInformation:
type: object
properties:
defaultStandardEntryClassCode:
type: string
defaultCountryCode:
type: string
description: ISO 4217 format
defaultCurrencyCode:
type: string
description: Three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
defaultTransactionType:
type: string
description: 'Possible values:
- AUTHORIZATION
- SALE'
defaultPaymentType:
type: string
description: 'Possible values:
- CREDIT_CARD
- ECHECK'
defaultTransactionSource:
type: string
displayRetail:
type: boolean
displayMoto:
type: boolean
displayInternet:
type: boolean
paymentInformation:
type: object
properties:
displayCardVerificationValue:
type: array
items:
type: string
description: 'Possible values:
- VISA
- MASTER_CARD
- AMEX
- DISCOVER
- DINERS_CLUB
- CARTE_BLANCHE
- JCB
- ENROUTE
- JAL
- SWITCH_SOLO
- DELTA
- VISA_ELECTRON
- DANKORT
- LASER
- CARTE_SBANCAIRES
- CARTASI
- MAESTRO_INTERNATIONAL
- GE_MONEY_UK_CARD
- HIPER_CARD
- ELO'
requireCardVerificationValue:
type: array
items:
type: string
description: 'Possible values:
- VISA
- MASTER_CARD
- AMEX
- DISCOVER
- DINERS_CLUB
- CARTE_BLANCHE
- JCB
- ENROUTE
- JAL
- SWITCH_SOLO
- DELTA
- VISA_ELECTRON
- DANKORT
- LASER
- CARTE_SBANCAIRES
- CARTASI
- MAESTRO_INTERNATIONAL
- GE_MONEY_UK_CARD
- HIPER_CARD
- ELO'
acceptedCardTypes:
type: array
items:
type: string
description: 'Possible values:
- VISA
- MASTER_CARD
- AMEX
- DISCOVER
- DINERS_CLUB
- CARTE_BLANCHE
- JCB
- ENROUTE
- JAL
- SWITCH_SOLO
- DELTA
- VISA_ELECTRON
- DANKORT
- LASER
- CARTE_SBANCAIRES
- CARTASI
- MAESTRO_INTERNATIONAL
- GE_MONEY_UK_CARD
- HIPER_CARD
- ELO'
displayCreditCards:
type: boolean
displayEchecks:
type: boolean
displayDebtIndicator:
type: boolean
displayBillPayment:
type: boolean
enableEchecks:
type: boolean
displayIgnoreECheckAvsCheckbox:
type: boolean
firstNameRequired:
type: boolean
lastNameRequired:
type: boolean
displayFirstName:
type: boolean
displayLastName:
type: boolean
merchantDefinedDataFields:
type: object
properties:
displayMerchantDefinedData1:
type: boolean
displayMerchantDefinedData2:
type: boolean
displayMerchantDefinedData3:
type: boolean
displayMerchantDefinedData4:
type: boolean
displayMerchantDefinedData5:
type: boolean
merchantDefinedData1DefaultValue:
type: string
merchantDefinedData1Label:
type: string
requireMerchantDefinedData1:
type: boolean
merchantDefinedData2DefaultValue:
type: string
merchantDefinedData2Label:
type: string
requireMerchantDefinedData2:
type: boolean
merchantDefinedData3DefaultValue:
type: string
merchantDefinedData3Label:
type: string
requireMerchantDefinedData3:
type: boolean
merchantDefinedData4DefaultValue:
type: string
merchantDefinedData4Label:
type: string
requireMerchantDefinedData4:
type: boolean
merchantDefinedData5DefaultValue:
type: string
merchantDefinedData5Label:
type: string
requireMerchantDefinedData5:
type: boolean
merchantDefinedData1DisplayOnReceipt:
type: boolean
merchantDefinedData2DisplayOnReceipt:
type: boolean
merchantDefinedData3DisplayOnReceipt:
type: boolean
merchantDefinedData4DisplayOnReceipt:
type: boolean
merchantDefinedData5DisplayOnReceipt:
type: boolean
receiptInformation:
type: object
properties:
header:
type: object
properties:
virtualTerminalReceiptHeader:
type: string
orderInformation:
type: object
properties:
emailAliasName:
type: string
customReplyToEmailAddress:
type: string
emailReceipt:
type: object
properties:
sendersEmailAddress:
type: string
currencyConversion:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
properties:
processors:
type: object
additionalProperties:
x-devcenter-additional-properties:
- six
- cmcic
- fdiglobal
- fdcsouth
type: object
properties:
provider:
type: string
description: The name of the provider.
merchantId:
type: string
description: A unique identifier value assigned to each merchant. Assigned by the provider.
acquirerId:
type: string
description: This code identifies the financial institution acting as the acquirer.
tax:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
customerInvoicing:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
recurringBilling:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
paymentOrchestration:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
payouts:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
configurations:
type: object
properties:
common:
type: object
properties:
paymentTypes:
type: array
description: 'List of card types supported by this merchant.
'
items:
type: string
minLength: 1
maxLength: 30
description: 'Possible values:
- VISA
- MASTERCARD'
businessApplicationId:
type: array
description: 'List of supported Business Application Indicators.
'
items:
type: string
minLength: 2
maxLength: 2
description: 'Possible values:
- AA
- BB
- BI
- BP
- CB
- CD
- CI
- CO
- CP
- FD
- FT
- GD
- GP
- LA
- LO
- MD
- MI
- MP
- OG
- PD
- PG
- PP
- PS
- RP
- TU
- WT'
defaultBusinessApplicationId:
type: string
minLength: 2
maxLength: 2
description: "Default Business Application Indicator. Must match one of the values in businessApplicationId array.\n \nPossible values:\n- AA\n- BB\n- BI\n- BP\n- CB\n- CD\n- CI\n- CO\n- CP\n- FD\n- FT\n- GD\n- GP\n- LA\n- LO\n- MD\n- MI\n- MP\n- OG\n- PD\n- PG\n- PP\n- PS\n- RP\n- TU\n- WT"
aggregator:
type: object
properties:
id:
type: string
pattern: ^[a-zA-Z0-9_]+$
minLength: 1
maxLength: 11
description: Marketplace or payment facilitator ID.
name:
type: string
pattern: ^[A-Za-z0-9!@#$%^&*(),.?":{}|<>]+$
minLength: 1
maxLength: 25
description: Acceptor's legal business name associated with the card acceptor identification code.
subMerchantId:
type: string
pattern: ^[a-zA-Z0-9_]+$
minLength: 1
maxLength: 15
description: Sub-merchant ID
processors:
type: object
additionalProperties:
description: 'string [1 .. 40] characters
The name of the Payouts processor.
'
pattern: ^[A-Za-z0-9]+$
allOf:
- type: object
properties:
enabled:
type: boolean
description: 'Indicates if the payment route is enabled. Allows the acquirer to enable/disable processing based on the config setting but to retain the configuration profile.
'
acquirer:
type: object
properties:
acquiringId:
type: string
pattern: ^\d+$
minLength: 6
maxLength: 11
description: 'This code identifies the financial institution acting as the acquirer.
Also known as:
- Acquiring BIN
- Acquiring Institution Identification Code
'
country:
type: string
description: "The acquirer's [ISO 3166-1](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html) alpha-2 country code. \nPossible values:\n- US\n- AF\n- AX\n- AL\n- DZ\n- AD\n- AO\n- AI\n- AQ\n- AG\n- AR\n- AM\n- AW\n- AU\n- AS\n- AT\n- AZ\n- BS\n- BH\n- BD\n- BB\n- BY\n- BE\n- BZ\n- BJ\n- BM\n- BT\n- BO\n- BA\n- BQ\n- BW\n- BV\n- BR\n- IO\n- VG\n- BN\n- BG\n- BF\n- BI\n- KH\n- CM\n- CA\n- CV\n- CW\n- KY\n- CF\n- TD\n- CL\n- CN\n- CX\n- CC\n- CO\n- KM\n- CD\n- CG\n- CK\n- CR\n- CI\n- HR\n- CU\n- CY\n- CZ\n- DK\n- DJ\n- DM\n- DO\n- EC\n- EG\n- SV\n- GQ\n- ER\n- EE\n- ET\n- FK\n- FO\n- FJ\n- FI\n- FR\n- GF\n- PF\n- TF\n- GA\n- GM\n- GE\n- DE\n- GH\n- GI\n- GR\n- GL\n- GD\n- GP\n- GU\n- GT\n- GG\n- GN\n- GW\n- GY\n- HT\n- HM\n- HN\n- HK\n- HU\n- IS\n- IN\n- ID\n- IR\n- IQ\n- IE\n- IM\n- IL\n- IT\n- JM\n- JP\n- JE\n- JO\n- KZ\n- KE\n- KI\n- KW\n- KG\n- LA\n- LV\n- LB\n- LS\n- LR\n- LY\n- LI\n- LT\n- LU\n- MO\n- MK\n- MG\n- MW\n- MY\n- MV\n- ML\n- MT\n- MH\n- MQ\n- MR\n- MU\n- YT\n- MX\n- FM\n- MD\n- MC\n- MN\n- ME\n- MS\n- MA\n- MZ\n- MM\n- NA\n- NR\n- NP\n- NL\n- AN\n- NC\n- NZ\n- NI\n- NE\n- NG\n- NU\n- NF\n- KP\n- MP\n- NO\n- OM\n- PK\n- PW\n- PS\n- PA\n- PG\n- PY\n- PE\n- PH\n- PN\n- PL\n- PT\n- PR\n- QA\n- RE\n- RO\n- RU\n- RW\n- BL\n- SH\n- KN\n- LC\n- MF\n- PM\n- VC\n- WS\n- SM\n- SS\n- ST\n- SX\n- SA\n- SN\n- RS\n- SC\n- SL\n- SG\n- SK\n- SI\n- SB\n- SO\n- ZA\n- GS\n- KR\n- ES\n- LK\n- SD\n- SR\n- SJ\n- SZ\n- SE\n- CH\n- SY\n- TW\n- TJ\n- TZ\n- TH\n- TL\n- TG\n- TK\n- TO\n- TT\n- TN\n- TR\n- TM\n- TC\n- TV\n- UG\n- UA\n- AE\n- GB\n- UM\n- UY\n- UZ\n- VU\n- VA\n- VE\n- VN\n- VI\n- WF\n- KV\n- EH\n- YE\n- ZM\n- ZW"
currencies:
type: array
description: List of supported [ISO 4217](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html) alpha-3 currency codes.
items:
type: string
minLength: 3
maxLength: 3
description: 'Possible values:
- USD
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BOX
- BRL
- BSD
- BTN
- BWP
- BYR
- BYN
- BZD
- CAD
- CDF
- CHF
- CLF
- CLP
- CNY
- COP
- COU
- CRC
- CSK
- CUC
- CUP
- CVE
- CZK
- DJF
- DFF
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GWP
- GYD
- HKD
- HNL
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- HMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LRD
- LSL
- LTV
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SHP
- SLE
- SOS
- SRD
- SSP
- STD
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- UYU
- VEF
- VND
- VUV
- WST
- XAF
- XCD
- XOF
- XPF
- YER
- ZAR
- ZMK
- ZMW
- ZWD
- ZWL'
countries:
type: array
description: List of [ISO 3166-1](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html) alpha-2 country codes
items:
type: string
minLength: 2
maxLength: 2
description: 'Possible values:
- US
- AF
- AX
- AL
- DZ
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AS
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BA
- BQ
- BW
- BV
- BR
- IO
- VG
- BN
- BG
- BF
- BI
- KH
- CM
- CA
- CV
- CW
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CD
- CG
- CK
- CR
- CI
- HR
- CU
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MK
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- AN
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MP
- NO
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- SS
- ST
- SX
- SA
- SN
- RS
- SC
- SL
- SG
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- ES
- LK
- SD
- SR
- SJ
- SZ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- UY
- UZ
- VU
- VA
- VE
- VN
- VI
- WF
- KV
- EH
- YE
- ZM
- ZW'
merchantId:
type: string
pattern: ^[A-Za-z0-9!@#$%^&*(),.?":{}|<>]+$
minLength: 1
maxLength: 15
description: A unique identifier value assigned by Visa for each merchant included in the identification program.
terminalId:
type: string
pattern: ^[A-Za-z0-9!@#$%^&*(),.?":{}|<>]+$
minLength: 1
maxLength: 8
description: This field contains a code that identifies a terminal at the card acceptor location. This field is used in all messages related to a transaction. If sending transactions from a card not present environment, use the same value for all transactions.
businessCategoryValidation:
type: boolean
description: 'Default: false
Override Business Application Indicator and Merchant Category Code validations for payout transaction types.
'
payoutsTransactionTypes:
type: array
description: 'The supported Payouts transaction types for the processor.
'
items:
type: string
minLength: 19
maxLength: 20
description: 'Possible values:
- PULL_FUNDS_TRANSFER
- PUSH_FUNDS_TRANSFER'
merchantPseudoAbaNumber:
type: string
pattern: ^[A-Za-z0-9!@#$%^&*(),.?":{}|<>]+$
minLength: 9
maxLength: 9
description: 'This is a number that uniquely identifies the merchant for PPGS transactions.
'
binLookupEligibilityCheck:
type: array
description: 'List of transaction types eligible for BIN Lookup Payouts Eligibility Check.
Supports "PULL_FUNDS_TRANSFER" and "PUSH_FUNDS_TRANSFER".
'
items:
type: string
minLength: 19
maxLength: 19
description: 'Possible values:
- PULL_FUNDS_TRANSFER
- PUSH_FUNDS_TRANSFER'
- type: object
allOf:
- properties:
feeProgramId:
type: string
pattern: ^[A-Za-z0-9]+$
minLength: 3
maxLength: 3
description: 'This field identifies the interchange fee program applicable to each financial transaction. Fee program indicator (FPI) values correspond to the fee descriptor and rate for each existing fee program.
This field can be regarded as informational only in all authorization messages.
'
cpsAuthorizationCharacteristicsId:
type: string
pattern: ^[A-Za-z]+$
minLength: 1
maxLength: 1
description: The Authorization Characteristics Indicator (ACI) is a code used by the acquirer to request CPS qualification. If applicable, Visa changes the code to reflect the results of its CPS evaluation.
nationalReimbursementFee:
type: string
pattern: ^[A-Za-z0-9!@#$%^&*(),.?":{}|<>]+$
minLength: 1
maxLength: 12
description: A client-supplied interchange amount.
settlementServiceId:
type: string
description: "This flag enables the merchant to request for a particular settlement service to be used for settling the transaction. \nNote: The default value is VIP. This field is only relevant for specific countries where the acquirer has to select National Settlement in order to settle in the national net settlement service.change\n \nPossible values:\n- INTERNATIONAL_SETTLEMENT\n- VIP_TO_DECIDE\n- NATIONAL_SETTLEMENT"
sharingGroupCode:
type: string
minLength: 6
maxLength: 16
description: "This U.S.-only field is optionally used by PIN Debit Gateway Service participants (merchants and acquirers) to specify the network access priority. VisaNet checks to determine if there are issuer routing preferences for a network specified by the sharing group code. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on issuer preference. If an preference exists for multiple specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on acquirer routing priorities. \nPossible values:\n- ACCEL_EXCHANGE_E\n- CU24_C\n- INTERLINK_G\n- MAESTRO_8\n- NYCE_Y\n- NYCE_F\n- PULSE_S\n- PULSE_L\n- PULSE_H\n- STAR_N\n- STAR_W\n- STAR_Z\n- STAR_Q\n- STAR_M\n- VISA_V"
allowCryptoCurrencyPurchase:
type: boolean
description: This field allows a merchant to send a flag that specifies whether the payment is for the purchase of cryptocurrency.
merchantMvv:
type: string
pattern: ^\d+$
minLength: 10
maxLength: 10
description: Merchant Verification Value (MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant.
electronicCommerceId:
type: string
minLength: 1
maxLength: 20
description: "This code identifies the level of security used in an electronic commerce transaction over an open network (for example, the Internet). \nPossible values:\n- INTERNET\n- RECURRING\n- RECURRING_INTERNET\n- VBV_FAILURE\n- VBV_ATTEMPTED\n- VBV\n- SPA_FAILURE\n- SPA_ATTEMPTED\n- SPA"
- type: object
allOf:
- properties:
merchantDescriptor:
type: object
properties:
name:
type: string
pattern: ^[A-Za-z0-9]+$
minLength: 22
maxLength: 22
description: The merchant statement descriptor. The statement descriptor is a string which will be displayed on the recipient's bank or card statement.
operatingEnvironment:
type: string
minLength: 1
maxLength: 22
description: "Initiation channel of the transfer request. \n \nPossible values:\n- WEB\n- MOBILE\n- BANK\n- KIOSK"
interchangeRateDesignator:
type: string
pattern: ^[A-Za-z0-9]+$
minLength: 2
maxLength: 2
description: The IRD used for clearing the transaction on the Mastercard network.
partnerIdentifier:
type: string
pattern: ^[A-Za-z0-9_\-]+$
minLength: 32
maxLength: 32
description: Mastercard-assigned unique ID for registered partner. Mastercard Send Only.
differentialFee:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
features:
type: object
properties:
surcharge:
type: object
properties:
enabled:
type: boolean
payByLink:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
unifiedCheckout:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
enablementStatus:
type: string
default: ENABLED_AND_USABLE
description: 'Possible values:
- PENDING
- ENABLED_AND_USABLE
- ENABLED_NOT_USABLE
- DISABLED'
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
features:
type: object
properties:
pazeForUnifiedCheckout:
type: object
properties:
enabled:
type: boolean
description: Enabling Paze under unified checkout
tokenManagement:
type: object
properties:
enabled:
type: boolean
description: Enabling Token Management under Unified Checkout
payPal:
type: object
properties:
enabled:
type: boolean
description: Enabling PayPal under Unified Checkout
venmo:
type: object
properties:
enabled:
type: boolean
description: Enabling Venmo under Unified Checkout
applePay:
type: object
properties:
enabled:
type: boolean
description: Enabling Apple Pay under Unified Checkout
googlePay:
type: object
properties:
enabled:
type: boolean
description: Enabling Google Pay under Unified Checkout
tinkPayByBank:
type: object
properties:
enabled:
type: boolean
description: Enabling Tink Pay by Bank under Unified Checkout
eCheck:
type: object
properties:
enabled:
type: boolean
description: Enabling eCheck under Unified Checkout
p24:
type: object
properties:
enabled:
type: boolean
description: Enabling p24 under Unified Checkout
myBank:
type: object
properties:
enabled:
type: boolean
description: Enabling MyBank under Unified Checkout
konbini:
type: object
properties:
enabled:
type: boolean
description: Enabling Konbini under Unified Checkout
dragonPay:
type: object
properties:
enabled:
type: boolean
description: Enabling Dragon Pay under Unified Checkout
decisionManager:
type: object
properties:
enabled:
type: boolean
description: Enabling Decision Manager under Unified Checkout
payerAuthentication:
type: object
properties:
enabled:
type: boolean
description: Enabling Payer Authentication under Unified Checkout
afterPay:
type: object
properties:
enabled:
type: boolean
description: Enabling AfterPay under Unified Checkout
ideal:
type: object
properties:
enabled:
type: boolean
description: Enabling Ideal under Unified Checkout
multibanco:
type: object
properties:
enabled:
type: boolean
description: Enabling Multibanco under Unified Checkout
bancontact:
type: object
properties:
enabled:
type: boolean
description: Enabling Bancontact under Unified Checkout
clickToPay:
type: object
properties:
enabled:
type: boolean
description: Enabling Click to Pay under Unified Checkout
unifiedClickToPaySDK:
type: object
properties:
enabled:
type: boolean
description: Enabling Unified Click to Pay SDK under Unified Checkout
portfolioAccessofSensitiveData:
type: object
properties:
enabled:
type: boolean
description: Enabling Portfolio Access of Sensitive Data under Unified Checkout
configurationInformation:
type: object
properties:
configurations:
type: object
properties:
features:
type: object
properties:
paze:
type: object
properties:
financialInstitution:
type: string
description: "Indicates the financial institution with whom the contract has been signed \nPossible values:\n- BANKOFAMERICA\n- WELLSFARGO"
financialInstitutionContract:
type: boolean
description: Indicates if the contract has been signed with the selected bank
pazeEnabledInProfile:
type: boolean
description: Paze enabled in the profile for the merchants
description: Paze specific required configuration details under unified checkout
receivablesManager:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
serviceFee:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
configurations:
type: object
properties:
products:
type: object
description: 'Products enabled for this account. The following values are supported:
virtualTerminal
paymentTokenizationOtp
subscriptionsOtp
virtualTerminalCp
eCheck
'
additionalProperties:
type: object
properties:
serviceFeeEnabled:
type: boolean
description: Boolean flag to determine if service fee will be applied to the Product.
terminalId:
type: string
pattern: /^[a-zA-Z0-9]+$/
description: Identifier of the terminal at the retail location.
maxLength: 8
merchantId:
type: string
pattern: /^[a-zA-Z0-9]+$/
description: Identifier of a merchant account.
maxLength: 15
merchantInformation:
type: object
properties:
name:
type: string
description: Name of the merchant account.
maxLength: 25
contact:
type: string
pattern: /^\(?([0-9]{3})\)?[-. ]?([0-9]{3})[-. ]?([0-9]{4})$/
description: Phone number of the primary contact for the merchant account.
state:
type: string
description: 2-character ISO code for the U.S. state in which the merchant is registered
maxLength: 2
paymentInformation:
type: array
items:
type: object
properties:
paymentType:
type: string
description: "Payment types accepted by this merchant. The supported values are: MASTERDEBIT, MASTERCREDIT, VISACREDIT, VISADEBIT, DISCOVERCREDIT, AMEXCREDIT, ECHECK \nPossible values:\n- MASTERDEBIT\n- MASTERCREDIT\n- VISACREDIT\n- VISADEBIT\n- DISCOVERCREDIT\n- AMEXCREDIT\n- ECHECK"
feeType:
type: string
description: "Fee type for the selected payment type. Supported values are: Flat or Percentage.\n \nPossible values:\n- FLAT\n- PERCENTAGE"
feeAmount:
type: number
pattern: /^\d{0,8}(\.\d{0,2})?$/
description: 'Fee Amount of the selected payment type if you chose Flat fee type.
'
percentage:
type: number
description: 'Percentage of the selected payment type if you chose Percentage Fee type. Supported values use numbers with decimals. For example, 1.0
'
feeCap:
type: number
pattern: /^\d{0,8}(\.\d{0,2})?$/
description: 'Fee cap for the selected payment type. Supported values use numbers with decimals. For example, 1.0
'
batchUpload:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
transactGuard:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
microform:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
enablementStatus:
type: string
default: ENABLED_AND_USABLE
description: 'Possible values:
- PENDING
- ENABLED_AND_USABLE
- ENABLED_NOT_USABLE
- DISABLED'
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
features:
type: object
additionalProperties:
x-devcenter-additional-properties:
- cardPresent
- cardNotPresent
type: object
properties:
enabled:
type: boolean
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
properties:
features:
type: object
properties:
gatewayAgnostic:
type: object
properties:
merchantLevelEncryption:
type: boolean
risk:
title: riskProducts
type: object
properties:
fraudManagementEssentials:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
decisionManager:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
title: DmConfig
properties:
processingOptions:
type: object
properties:
stepUpAuthEnabled:
type: boolean
organization:
type: object
properties:
hierarchyGroup:
type: string
description: 'Must be one of the following : NO_GROUP, INCLUDE_IN_PARENTS_GROUP
'
example: NO_GROUP
portfolioControls:
type: object
properties:
hideRiskMenus:
type: boolean
hideRiskTransactionData:
type: boolean
thirdparty:
type: object
properties:
provider:
type: object
properties:
accurint:
type: object
properties:
enabled:
type: boolean
credentials:
type: object
properties:
username:
type: string
password:
type: string
credilink:
type: object
properties:
enabled:
type: boolean
enableRealTime:
type: boolean
useCybsCredentials:
type: boolean
credentials:
type: object
properties:
username:
type: string
password:
type: string
sigla:
type: string
ekata:
type: object
properties:
enabled:
type: boolean
enableRealTime:
type: boolean
useCybsCredentials:
type: boolean
credentials:
type: object
properties:
apiKey:
type: string
emailage:
type: object
properties:
enabled:
type: boolean
enableRealTime:
type: boolean
useCybsCredentials:
type: boolean
credentials:
type: object
properties:
username:
type: string
password:
type: string
perseuss:
type: object
properties:
enabled:
type: boolean
enableRealTime:
type: boolean
credentials:
type: object
properties:
username:
type: string
password:
type: string
signifyd:
type: object
properties:
enabled:
type: boolean
credentials:
type: object
properties:
teamId:
type: string
apiKey:
type: string
secretKeyid:
type: string
secretKey:
type: string
targus:
type: object
properties:
enabled:
type: boolean
useCybsCredentials:
type: boolean
credentials:
type: object
properties:
username:
type: string
password:
type: string
serviceId:
type: string
portfolioRiskControls:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
configurations:
type: object
properties:
profileId:
type: string
enhancedAuthentication:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
title: PayerAuthConfig
properties:
cardTypes:
type: object
properties:
verifiedByVisa:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
masterCardSecureCode:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
amexSafeKey:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
jCBJSecure:
type: object
properties:
securePasswordForJCB:
type: string
minLength: 8
maxLength: 8
description: JSecure currency password for Japan Credit Bureau
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
dinersClubInternationalProtectBuy:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
ELO:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
UPI:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
CB:
type: object
properties:
requestorId:
type: string
minLength: 14
maxLength: 14
description: The value is for 3DS2.0 and is a Directory Server assigned 3DS Requestor ID value. If this field is passed in request, it will override Requestor Id value that is configured on the Merchant's profile.
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
commerceSolutions:
title: commerceSolutionsProducts
type: object
properties:
tokenManagement:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
properties:
parentProfileId:
type: string
description: Specify the Vault ID to which transacting MID needs to be assigned.Provide Vault ID as seen on EBC Vault management page. If not provided , transacting MID will be assigned to the existing default Vault at merchant's level. If there are no Vaults at merchant level , a new Vault will be created and transacting MID will be assigned to it.
vault:
type: object
properties:
defaultTokenType:
type: string
description: "Default token type to be used.\nPossible Values: \n - 'CUSTOMER'\n - 'PAYMENT_INSTRUMENT'\n - 'INSTRUMENT_IDENTIFIER'\n"
example: CUSTOMER
location:
type: string
description: "Location where the vault will be stored.\n\nUse 'IDC' (the Indian Data Centre) when merchant is storing token data in India or 'GDC' (the Global Data Centre) for all other cases.\n\nPossible Values: \n - 'IDC'\n - 'GDC'\n"
example: GDC
tokenFormats:
title: tmsTokenFormats
type: object
properties:
customer:
type: string
description: "Format for customer tokens.\n\nPossible Values:\n - '16_DIGIT'\n - '19_DIGIT'\n - '22_DIGIT'\n - '32_HEX'\n"
example: 32_HEX
paymentInstrument:
type: string
description: "Format for payment instrument tokens.\n\nPossible Values:\n - '16_DIGIT'\n - '19_DIGIT'\n - '22_DIGIT'\n - '32_HEX'\n"
example: 32_HEX
instrumentIdentifierCard:
type: string
description: "Format for card based instrument identifier tokens.\n\nPossible Values:\n - '16_DIGIT'\n - '16_DIGIT_LAST_4'\n - '19_DIGIT'\n - '19_DIGIT_LAST_4'\n - '22_DIGIT'\n - '32_HEX'\n"
instrumentIdentifierBankAccount:
type: string
description: "Format for bank account based instrument identifier tokens.\n\nPossible Values: \n - '16_DIGIT'\n - '19_DIGIT'\n - '22_DIGIT'\n - '32_HEX'\n"
tokenPermissions:
title: TokenPermissions
type: object
properties:
create:
type: boolean
description: Indicates if tokens may be created
read:
type: boolean
description: Indicates if tokens may be read
update:
type: boolean
description: Indicates if tokens may be updated
delete:
type: boolean
description: Indicates if tokens may be deleted
sensitivePrivileges:
title: tmsSensitivePrivileges
type: object
properties:
cardNumberMaskingFormat:
type: string
description: "Indicates which digits of the card number will be unmasked.\n\nPossible Values: \n - 'FIRST_6_LAST_4'\n - 'LAST_4'\n - 'MASKED'\n"
nullify:
title: tmsNullify
type: object
properties:
instrumentIdentifierCardNumber:
type: boolean
description: Indicates if the card number should be nullified (i.e. not stored)
instrumentIdentifierCardExpiration:
type: boolean
description: Indicates if the expiration date associated to the instrument identifier should be nullified (i.e. not stored)
paymentInstrumentCardDetails:
type: boolean
description: Indicates if the card details should be nullified (i.e. not stored)
networkTokenServices:
title: tmsNetworkTokenServices
type: object
properties:
notifications:
type: object
properties:
enabled:
type: boolean
description: Indicates if lifecycle management (LCM) notifications are enabled
paymentCredentials:
type: object
properties:
enabled:
type: boolean
description: Indicates if Payment Credentials are enabled. If enabled, this provides access to the unredacted token and its associated cryptogram.
synchronousProvisioning:
type: object
properties:
enabled:
type: boolean
description: "Indicates if network tokens are provisioned synchronously (i.e. as part of the transaction flow) or asychronously (i.e. in parallel to the payment flow)\n\nNOTE: The synchronous provisioning feature is designed exclusively for aggregator merchants.\n\nDirect merchants should not enable synchronous provisioning as TMS manages the asynchronous creation of network tokens for direct clients. \n\nActivation of this feature by direct merchants will lead to latency in the authorization response.\n"
visaTokenService:
type: object
properties:
enableService:
type: boolean
description: Indicates if the service for network tokens for the Visa card association are enabled
enableTransactionalTokens:
type: boolean
description: Indicates if network tokens for the Visa card association are enabled for transactions
tokenRequestorId:
type: string
description: 'Token Requestor ID provided by Visa during the registration process for the Tokenization Service
Pattern: ^[0-9]{11}\\z$"
Min Length: 11
Max Length: 11
Example: "40000000082"
'
pattern: ^[0-9]{11}\\z$"
minLength: 11
maxLength: 11
relationshipId:
type: string
description: 'Relationship ID provided by visa
Min Length: 1
Max Length: 100
Example: "24681921-40000000082"
'
minLength: 1
maxLength: 100
mastercardDigitalEnablementService:
type: object
properties:
enableService:
type: boolean
description: Indicates if the service for network tokens for the Mastercard card association are enabled
enableTransactionalTokens:
type: boolean
description: Indicates if network tokens for the Mastercard card association are enabled for transactions
tokenRequestorId:
type: string
description: 'Token Requestor ID provided by Mastercard during the registration process for the Tokenization Service
Pattern: ^[0-9]{11}\\z$"
Min Length: 11
Max Length: 11
Example: "50162233570"
'
pattern: ^[0-9]{11}\\z$"
minLength: 11
maxLength: 11
americanExpressTokenService:
type: object
properties:
enableService:
type: boolean
description: Indicates if the service for network tokens for the American Express card association are enabled
enableTransactionalTokens:
type: boolean
description: Indicates if network tokens for the American Express card association are enabled for transactions
tokenRequestorId:
type: string
description: 'Token Requestor ID provided by American Express during the registration process for the Tokenization Service
Pattern: ^[0-9]{11}\\z$"
Min Length: 11
Max Length: 11
Example: "12345678912"
'
pattern: ^[0-9]{11}\\z$"
minLength: 11
maxLength: 11
seNumber:
type: string
minLength: 10
maxLength: 10
pattern: ^[0-9]{11}\z$
description: 'SE Number assigned by American Express for the merchant''s account
Pattern: "^[0-9]{11}\\z$"
Min Length: 10
Max Length: 10
Example: "9876543212"
'
networkTokenEnrollment:
title: networkTokenEnrollment
type: object
properties:
businessInformation:
title: tmsBusinessInformation
type: object
properties:
name:
type: string
maxLength: 60
minLength: 1
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
description: Name of the network token merchant.
example: NetworkTokenMerchant
doingBusinessAs:
type: string
maxLength: 60
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
description: Name the network token merchant does business as
example: NetworkTokenCo1
address:
type: object
properties:
country:
type: string
maxLength: 2
minLength: 2
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
description: Country of network token merchant.
example: US
locality:
type: string
maxLength: 50
minLength: 1
pattern: "^[0-9a-zA-Z _\\-¡-\uFFFF]+$"
description: City of network token merchant.
example: ORMOND BEACH
websiteUrl:
type: string
maxLength: 100
pattern: \b((?:https?://|www\d{0,3}[.]|[a-z0-9.\-]+[.][a-z]{2,4}/)(?:[^\s()<>]+|\(([^\s()<>]+|(\([^\s()<>]+\)))*\))+(?:\(([^\s()<>]+|(\([^\s()<>]+\)))*\)|[^\s`!()\[\]{};:'".,<>?«»“â€.‘’]))
description: Website of network token merchant.
example: https://www.NetworkTokenMerchant.com
businessIdentificationType:
type: string
description: 'The Identifier associated with the business type; required unless both acquirerId and acquirerMerchantId are provided.
'
maxLength: 15
businessIdentificationValue:
type: string
description: 'The value associated with the business identifier type; required unless both acquirerId and acquirerMerchantId are provided.
'
maxLength: 25
acquirer:
type: object
properties:
acquirerId:
type: string
description: 'Acquirer ID; required unless both businessIdentificationType and businessIdentificationValue are provided.
'
maxLength: 15
acquirerMerchantId:
type: string
description: 'Acquirer merchant ID; required unless both businessIdentificationType and businessIdentificationValue are provided.
'
maxLength: 25
networkTokenServices:
title: NetworkTokenServicesEnablement
type: object
properties:
visaTokenService:
type: object
properties:
enrollment:
type: boolean
description: Indicates if an enrollment to create a TRID for the Visa card association should be attempted
mastercardDigitalEnablementService:
type: object
properties:
enrollment:
type: boolean
description: Indicates if an enrollment to create a TRID for the MasterCard card association should be attempted
accountUpdater:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
properties:
masterCard:
type: object
properties:
merchantId:
type: string
description: MasterCard merchant identified number
interbankCardAssociationNumber:
type: string
description: Number assigned by MasterCard to a financial institution, third-party processor or other member to identify the member in transaction.
active:
type: boolean
required:
- merchantId
- interbankCardAssociationNumber
visa:
type: object
properties:
merchantId:
type: string
description: Visa merchant identified number
segmentId:
type: string
description: Visa assigned segment ID for each group of merchants participating in VAU.
active:
type: boolean
required:
- merchantId
- segmentId
amex:
type: object
properties:
mode:
type: string
description: Type of mode. Valid values are `tokenApi` or `dailyHarvest`.
seNumber:
type: string
subscriberId:
type: string
active:
type: boolean
preferredDay:
type: number
minimum: 1
maximum: 28
daysWindow:
type: number
minimum: 1
maximum: 3650
default: 31
binLookup:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
configurations:
type: object
properties:
isPayoutOptionsEnabled:
type: boolean
description: This flag indicates if the merchant is configured to make payout calls
isAccountPrefixEnabled:
type: boolean
description: This flag indicates if the merchant is configured to receive account prefix
agenticCommerce:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
valueAddedServices:
title: valueAddedServicesProducts
type: object
properties:
reporting:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
transactionSearch:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
bankAccountValidation:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
flexapi:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
webhooks:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
documentInformation:
type: object
properties:
signedDocuments:
type: array
items:
type: object
properties:
documentId:
type: string
maxLength: 200
example: TCProcessing
required:
- organizationInformation
responses:
'201':
description: Created
headers:
v-c-correlationid:
type: string
description: Unique identifier for this request
schema:
type: object
properties:
id:
type: string
maxLength: 60
example: '12351234'
submitTimeUtc:
type: string
format: date-time
example: '2019-06-11T22:47:57Z'
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
readOnly: true
status:
type: string
readOnly: true
description: "The status of Registration request\nPossible Values:\n - 'INITIALIZED'\n - 'RECEIVED'\n - 'PROCESSING'\n - 'SUCCESS'\n - 'FAILURE'\n - 'PARTIAL'\n"
registrationInformation:
type: object
properties:
boardingPackageId:
type: string
maxLength: 30
example: 1004001
readOnly: true
mode:
type: string
description: "In case mode is not provided the API will use COMPLETE as default\nPossible Values:\n - 'COMPLETE'\n - 'PARTIAL'\n"
salesRepId:
type: string
maxLength: 60
example: Rep1
integrationInformation:
type: object
properties:
tenantConfigurations:
type: array
description: tenantConfigurations is an array of objects that includes the tenant information this merchant is associated with.
items:
type: object
properties:
solutionId:
type: string
maxLength: 8
minLength: 8
pattern: ^[0-9a-zA-Z_]+$
description: 'The solutionId is the unique identifier for this system resource.
Partner can use it to reference the specific solution through out the system.
'
example: YumSolution1
tenantConfigurationId:
type: string
maxLength: 30
minLength: 6
pattern: ^[0-9a-zA-Z_]+$
description: 'The tenantConfigurationId is the unique identifier for this system resource.
You will see various places where it must be referenced in the URI path, or when
querying the hierarchy for ancestors or descendants.
'
status:
type: string
description: 'Possible values:
- LIVE
- INACTIVE
- TEST'
submitTimeUtc:
type: string
description: Time of request in UTC.
format: date-time
organizationInformation:
type: object
properties:
organizationId:
type: string
maxLength: 30
example: merch-test1
parentOrganizationId:
type: string
example: merch-test1-acct
childOrganizations:
type: array
items:
type: string
example: transactional-org
description: child Organizations is an array of strings. The values returned will be in array format ['string1','string2']
productInformationSetups:
type: array
items:
type: object
properties:
organizationId:
type: string
maxLength: 30
minLength: 6
pattern: ^[0-9a-zA-Z]+$
example: merch-test1
setups:
type: object
properties:
payments:
type: object
properties:
cardProcessing:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
alternativePaymentMethods:
type: object
properties:
configurationStatus:
type: object
properties:
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
message:
type: string
subscriptionStatus:
type: object
properties:
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
message:
type: string
status:
type: string
description: 'Possible values:
- PROCESSED
- PARTIAL_PROCESSED'
submitTimeUtc:
type: string
format: date-time
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example: 2024-09-08T09:37:38+0000
'
cardPresentConnect:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
eCheck:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
payerAuthentication:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
digitalPayments:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
secureAcceptance:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
virtualTerminal:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
currencyConversion:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
tax:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
customerInvoicing:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
recurringBilling:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
cybsReadyTerminal:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
paymentOrchestration:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
payouts:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
payByLink:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
unifiedCheckout:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
receivablesManager:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
serviceFee:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
batchUpload:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
transactGuard:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
microform:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
risk:
type: object
properties:
fraudManagementEssentials:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
decisionManager:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
enhancedAuthentication:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
commerceSolutions:
type: object
properties:
tokenManagement:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
accountUpdater:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
binLookup:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
agenticCommerce:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
valueAddedServices:
type: object
properties:
reporting:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
transactionSearch:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
bankAccountValidation:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
flexapi:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
webhooks:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
message:
type: string
example: Request was processed succesfully.
details:
type: object
additionalProperties:
type: array
items:
type: object
properties:
field:
type: string
description: This is the flattened JSON object field name/path that is either missing or invalid.
reason:
type: string
description: Possible reasons for the error.
example: MISSING_FIELD
value:
type: string
example: abc123
reference:
type: string
example: xyz
x-devcenter-additional-properties:
- organizationInformation
- productInformation
'400':
description: Bad Request
headers:
v-c-correlationid:
type: string
description: Unique identifier for this request
schema:
type: object
properties:
submitTimeUtc:
type: string
format: date-time
example: '2019-06-11T22:47:57Z'
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
readOnly: true
status:
type: string
description: The http status description of the submitted request.
example: BAD_REQUEST
reason:
type: string
description: "Documented reason codes. Client should be able to use the key for generating their own error message\nPossible Values:\n - 'INVALID_DATA'\n - 'SYSTEM_ERROR'\n - 'RESOURCE_NOT_FOUND'\n"
message:
type: string
description: Descriptive message for the error.
details:
type: array
items:
type: object
properties:
field:
type: string
description: This is the flattened JSON object field name/path that is either missing or invalid.
reason:
type: string
description: Possible reasons for the error.
example: MISSING_FIELD
'422':
description: Business Validations failed
headers:
v-c-correlationid:
type: string
description: Unique identifier for this request
schema:
type: object
properties:
submitTimeUtc:
type: string
format: date-time
example: '2019-06-11T22:47:57Z'
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
readOnly: true
status:
type: string
description: The http status description of the submitted request.
example: UNPROCESSABLE_ENTITY
reason:
type: string
description: "Documented reason codes. Client should be able to use the key for generating their own error message\nPossible Values:\n - 'INVALID_DATA'\n"
message:
type: string
description: Descriptive message for the error.
details:
type: array
items:
type: object
properties:
field:
type: string
description: This is the flattened JSON object field name/path that is either missing or invalid.
reason:
type: string
description: Possible reasons for the error.
example: MISSING_FIELD
'500':
description: Internal Server error
headers:
v-c-correlationid:
type: string
description: Unique identifier for this request
schema:
type: object
properties:
submitTimeUtc:
type: string
format: date-time
example: '2019-06-11T22:47:57Z'
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
readOnly: true
status:
type: string
description: The http status description of the submitted request.
example: INTERNAL_SERVER_ERROR
reason:
type: string
description: "Documented reason codes. Client should be able to use the key for generating their own error message\nPossible Values:\n - 'SYSTEM_ERROR'\n"
message:
type: string
description: Descriptive message for the error.
x-example:
example0:
summary: Create Registration
value:
organizationInformation:
parentOrganizationId: apitester00
type: MERCHANT
configurable: 'true'
businessInformation:
name: StuartWickedFastEatz
address:
country: US
address1: 123456 SandMarket
locality: ORMOND BEACH
administrativeArea: FL
postalCode: '32176'
websiteUrl: https://www.StuartWickedEats.com
phoneNumber: '6574567813'
businessContact:
firstName: Stuart
lastName: Stuart
phoneNumber: '6574567813'
email: svc_email_bt@corpdev.visa.com
merchantCategoryCode: '5999'
productInformation:
selectedProducts:
payments:
payerAuthentication:
subscriptionInformation:
enabled: true
configurationInformation:
configurations:
cardTypes:
verifiedByVisa:
currencies:
- currencyCodes:
- ALL
acquirerId: '469216'
processorMerchantId: '678855'
cardProcessing:
subscriptionInformation:
enabled: true
features:
cardNotPresent:
enabled: true
configurationInformation:
configurations:
common:
merchantCategoryCode: '1234'
merchantDescriptorInformation:
name: r4ef
city: Bellevue
country: US
phone: '4255547845'
state: WA
street: StreetName
zip: '98007'
processors:
tsys:
merchantId: '123456789101'
terminalId: '1231'
industryCode: D (Direct Marketing)
vitalNumber: '71234567'
merchantBinNumber: '123456'
merchantLocationNumber: '00001'
storeID: '1234'
settlementCurrency: USD
features:
cardNotPresent:
visaStraightThroughProcessingOnly: true
virtualTerminal:
subscriptionInformation:
enabled: 'true'
customerInvoicing:
subscriptionInformation:
enabled: 'true'
payouts:
subscriptionInformation:
enabled: 'true'
commerceSolutions:
tokenManagement:
subscriptionInformation:
enabled: 'true'
risk:
fraudManagementEssentials:
subscriptionInformation:
enabled: 'true'
configurationInformation:
templateId: E4EDB280-9DAC-4698-9EB9-9434D40FF60C
example1:
summary: Merchant Boarding with AmexDirect
value:
organizationInformation:
parentOrganizationId: apitester00
type: MERCHANT
configurable: 'true'
businessInformation:
name: StuartWickedFastEatz
address:
country: US
address1: 123456 SandMarket
locality: ORMOND BEACH
administrativeArea: FL
postalCode: '32176'
websiteUrl: https://www.StuartWickedEats.com
phoneNumber: '6574567813'
locale: en-us
localizedNames:
romaji: tenmei
katakana: ショップネーム
japanese: 店名
businessContact:
firstName: Stuart
lastName: Stuart
phoneNumber: '6574567813'
email: svc_email_bt@corpdev.visa.com
merchantCategoryCode: '5999'
productInformation:
selectedProducts:
payments:
cardProcessing:
subscriptionInformation:
enabled: true
features:
cardNotPresent:
enabled: true
cardPresent:
enabled: true
configurationInformation:
configurations:
common:
merchantCategoryCode: '1799'
merchantDescriptorInformation:
city: Cupertino
country: USA
name: Mer name
phone: '8885554444'
zip: '94043'
state: CA
street: mer street
url: www.test.com
subMerchantId: '123457'
subMerchantBusinessName: bus name
processors:
amexdirect:
acquirer: {}
currencies:
AED:
enabled: true
enabledCardPresent: false
enabledCardNotPresent: true
terminalId: ''
serviceEnablementNumber: '1234567890'
FJD:
enabled: true
enabledCardPresent: false
enabledCardNotPresent: true
terminalId: ''
serviceEnablementNumber: '1234567890'
USD:
enabled: true
enabledCardPresent: true
enabledCardNotPresent: true
terminalId: ''
serviceEnablementNumber: '1234567890'
paymentTypes:
AMERICAN_EXPRESS:
enabled: true
allowMultipleBills: false
avsFormat: basic
batchGroup: amexdirect_vme_default
enableAutoAuthReversalAfterVoid: false
enhancedData: disabled
enableLevel2: false
amexTransactionAdviceAddendum1: amex123
features:
cardNotPresent:
processors:
amexdirect:
relaxAddressVerificationSystem: true
relaxAddressVerificationSystemAllowExpiredCard: true
relaxAddressVerificationSystemAllowZipWithoutCountry: false
templateId: 2B80A3C7-5A39-4CC3-9882-AC4A828D3646
virtualTerminal:
subscriptionInformation:
enabled: true
configurationInformation:
templateId: 9FA1BB94-5119-48D3-B2E5-A81FD3C657B5
customerInvoicing:
subscriptionInformation:
enabled: true
risk: {}
commerceSolutions:
tokenManagement:
subscriptionInformation:
enabled: true
configurationInformation:
templateId: D62BEE20-DCFD-4AA2-8723-BA3725958ABA
valueAddedServices:
transactionSearch:
subscriptionInformation:
enabled: true
reporting:
subscriptionInformation:
enabled: true
example2:
summary: Merchant Boarding with Barclays
value:
organizationInformation:
parentOrganizationId: apitester00
type: MERCHANT
configurable: 'true'
businessInformation:
name: StuartWickedFastEatz
address:
country: US
address1: 123456 SandMarket
locality: ORMOND BEACH
administrativeArea: FL
postalCode: '32176'
websiteUrl: https://www.StuartWickedEats.com
phoneNumber: '6574567813'
locale: en-us
businessContact:
firstName: Stuart
lastName: Stuart
phoneNumber: '6574567813'
email: svc_email_bt@corpdev.visa.com
merchantCategoryCode: '5999'
productInformation:
selectedProducts:
payments:
cardProcessing:
subscriptionInformation:
enabled: true
features:
cardNotPresent:
enabled: true
cardPresent:
enabled: true
configurationInformation:
configurations:
common:
merchantCategoryCode: '5999'
defaultAuthTypeCode: FINAL
processors:
barclays2:
acquirer: {}
currencies:
AED:
enabled: true
enabledCardPresent: false
enabledCardNotPresent: true
merchantId: '1234'
terminalIds:
- '12351245'
serviceEnablementNumber: ''
USD:
enabled: true
enabledCardPresent: false
enabledCardNotPresent: true
merchantId: '1234'
terminalIds:
- '12351245'
serviceEnablementNumber: ''
paymentTypes:
MASTERCARD:
enabled: true
VISA:
enabled: true
batchGroup: barclays2_16
quasiCash: false
enhancedData: disabled
merchantId: '124555'
enableMultiCurrencyProcessing: false
features:
cardNotPresent:
processors:
barclays2:
payouts:
merchantId: '1233'
terminalId: '1244'
templateId: 0A413572-1995-483C-9F48-FCBE4D0B2E86
virtualTerminal:
subscriptionInformation:
enabled: true
configurationInformation:
templateId: 9FA1BB94-5119-48D3-B2E5-A81FD3C657B5
customerInvoicing:
subscriptionInformation:
enabled: true
risk: {}
commerceSolutions:
tokenManagement:
subscriptionInformation:
enabled: true
configurationInformation:
templateId: D62BEE20-DCFD-4AA2-8723-BA3725958ABA
valueAddedServices:
transactionSearch:
subscriptionInformation:
enabled: true
reporting:
subscriptionInformation:
enabled: true
example3:
summary: Merchant Boarding with CUP
value:
organizationInformation:
parentOrganizationId: apitester00
type: MERCHANT
configurable: 'true'
businessInformation:
name: StuartWickedFastEatz
address:
country: US
address1: 123456 SandMarket
locality: ORMOND BEACH
administrativeArea: FL
postalCode: '32176'
websiteUrl: https://www.StuartWickedEats.com
phoneNumber: '6574567813'
locale: en-us
businessContact:
firstName: Stuart
lastName: Stuart
phoneNumber: '6574567813'
email: svc_email_bt@corpdev.visa.com
merchantCategoryCode: '5999'
productInformation:
selectedProducts:
payments:
cardProcessing:
subscriptionInformation:
enabled: true
features:
cardNotPresent:
enabled: true
cardPresent:
enabled: true
configurationInformation:
configurations:
common:
merchantCategoryCode: '1799'
processors:
CUP:
acquirer:
countryCode: 344_hongkong
institutionId: '22344'
currencies:
HKD:
enabled: true
enabledCardPresent: false
enabledCardNotPresent: true
merchantId: '112233'
terminalId: '11224455'
serviceEnablementNumber: ''
AUD:
enabled: true
enabledCardPresent: false
enabledCardNotPresent: true
merchantId: '112233'
terminalId: '11224455'
serviceEnablementNumber: ''
USD:
enabled: true
enabledCardPresent: true
enabledCardNotPresent: true
merchantId: '112233'
terminalId: '11224455'
serviceEnablementNumber: ''
paymentTypes:
CUP:
enabled: true
templateId: 1D8BC41A-F04E-4133-87C8-D89D1806106F
virtualTerminal:
subscriptionInformation:
enabled: true
configurationInformation:
templateId: 9FA1BB94-5119-48D3-B2E5-A81FD3C657B5
customerInvoicing:
subscriptionInformation:
enabled: true
risk: {}
commerceSolutions:
tokenManagement:
subscriptionInformation:
enabled: true
configurationInformation:
templateId: D62BEE20-DCFD-4AA2-8723-BA3725958ABA
valueAddedServices:
transactionSearch:
subscriptionInformation:
enabled: true
reporting:
subscriptionInformation:
enabled: true
example4:
summary: Merchant Boarding with EFTPOS
value:
organizationInformation:
parentOrganizationId: apitester00
type: MERCHANT
configurable: 'true'
businessInformation:
name: StuartWickedFastEatz
address:
country: US
address1: 123456 SandMarket
locality: ORMOND BEACH
administrativeArea: FL
postalCode: '32176'
websiteUrl: https://www.StuartWickedEats.com
phoneNumber: '6574567813'
locale: en-us
businessContact:
firstName: Stuart
lastName: Stuart
phoneNumber: '6574567813'
email: svc_email_bt@corpdev.visa.com
merchantCategoryCode: '5999'
productInformation:
selectedProducts:
payments:
cardProcessing:
subscriptionInformation:
enabled: true
features:
cardNotPresent:
enabled: true
cardPresent:
enabled: false
configurationInformation:
configurations:
common:
merchantCategoryCode: '5999'
preferCobadgedSecondaryBrand: true
processors:
EFTPOS:
acquirer:
countryCode: 344_hongkong
institutionId: '22344'
currencies:
AUD:
enabled: true
merchantId: '12345612344'
terminalId: '12121212'
paymentTypes:
EFTPOS:
enabled: true
enableCVVResponseIndicator: true
enableLeastCostRouting: true
merchantTier: '000'
features: {}
templateId: 1F9B7F6E-F0DB-44C8-BF8E-5013E34C0F87
example5:
summary: Merchant Boarding with FDIGlobal
value:
organizationInformation:
parentOrganizationId: apitester00
type: MERCHANT
configurable: 'true'
businessInformation:
name: StuartWickedFastEatz
address:
country: US
address1: 123456 SandMarket
locality: ORMOND BEACH
administrativeArea: FL
postalCode: '32176'
websiteUrl: https://www.StuartWickedEats.com
phoneNumber: '6574567813'
locale: en-us
businessContact:
firstName: Stuart
lastName: Stuart
phoneNumber: '6574567813'
email: svc_email_bt@corpdev.visa.com
merchantCategoryCode: '5999'
productInformation:
selectedProducts:
payments:
cardProcessing:
subscriptionInformation:
enabled: true
features:
cardNotPresent:
enabled: true
cardPresent:
enabled: true
configurationInformation:
configurations:
common:
merchantCategoryCode: '0742'
defaultAuthTypeCode: PRE
processLevel3Data: ignored
masterCardAssignedId: '123456789'
enablePartialAuth: true
processors:
fdiglobal:
acquirer: {}
currencies:
CHF:
enabled: true
enabledCardPresent: false
enabledCardNotPresent: true
merchantId: 123456789mer
terminalId: 12345ter
serviceEnablementNumber: ''
HRK:
enabled: true
enabledCardPresent: false
enabledCardNotPresent: true
merchantId: 123456789mer
terminalId: 12345ter
serviceEnablementNumber: ''
ERN:
enabled: true
enabledCardPresent: false
enabledCardNotPresent: true
merchantId: 123456789mer
terminalId: 12345ter
serviceEnablementNumber: ''
USD:
enabled: true
enabledCardPresent: true
enabledCardNotPresent: true
merchantId: 123456789mer
terminalId: 12345ter
serviceEnablementNumber: ''
paymentTypes:
MASTERCARD:
enabled: true
DISCOVER:
enabled: true
JCB:
enabled: true
VISA:
enabled: true
PIN_DEBIT:
enabled: true
currencies:
USD:
enabled: true
terminalId: pint123
merchantId: pinm123
serviceEnablementNumber: null
AMERICAN_EXPRESS:
enabled: true
DINERS_CLUB:
enabled: true
CUP:
enabled: true
batchGroup: fdiglobal_vme_default
enhancedData: disabled
enablePosNetworkSwitching: true
enableTransactionReferenceNumber: true
features:
cardNotPresent:
processors:
fdiglobal:
relaxAddressVerificationSystem: true
relaxAddressVerificationSystemAllowExpiredCard: true
relaxAddressVerificationSystemAllowZipWithoutCountry: true
visaStraightThroughProcessingOnly: true
amexTransactionAdviceAddendum1: amex12345
ignoreAddressVerificationSystem: true
templateId: 685A1FC9-3CEC-454C-9D8A-19205529CE45
example6:
summary: Merchant Boarding with GPX
value:
organizationInformation:
parentOrganizationId: apitester00
type: MERCHANT
configurable: 'true'
businessInformation:
name: StuartWickedFastEatz
address:
country: US
address1: 123456 SandMarket
locality: ORMOND BEACH
administrativeArea: FL
postalCode: '32176'
websiteUrl: https://www.StuartWickedEats.com
phoneNumber: '6574567813'
locale: en-us
businessContact:
firstName: Stuart
lastName: Stuart
phoneNumber: '6574567813'
email: svc_email_bt@corpdev.visa.com
merchantCategoryCode: '5999'
productInformation:
selectedProducts:
payments:
cardProcessing:
subscriptionInformation:
enabled: true
features:
cardNotPresent:
enabled: true
cardPresent:
enabled: true
configurationInformation:
configurations:
common:
merchantCategoryCode: '1799'
defaultAuthTypeCode: FINAL
foodAndConsumerServiceId: '1456'
masterCardAssignedId: '4567'
sicCode: '1345'
enablePartialAuth: false
allowCapturesGreaterThanAuthorizations: false
enableDuplicateMerchantReferenceNumberBlocking: false
creditCardRefundLimitPercent: '2'
businessCenterCreditCardRefundLimitPercent: '3'
processors:
gpx:
acquirer:
countryCode: 840_usa
fileDestinationBin: '123456'
interbankCardAssociationId: '1256'
institutionId: '113366'
discoverInstitutionId: '1567'
currencies:
AED:
enabled: true
enabledCardPresent: false
enabledCardNotPresent: true
terminalId: ''
serviceEnablementNumber: ''
paymentTypes:
MASTERCARD:
enabled: true
VISA:
enabled: true
PIN_DEBIT:
enabled: true
JCB:
enabled: true
DINERS_CLUB:
enabled: true
DISCOVER:
enabled: true
allowMultipleBills: true
batchGroup: gpx
businessApplicationId: AA
enhancedData: disabled
fireSafetyIndicator: false
abaNumber: '1122445566778'
merchantVerificationValue: '234'
quasiCash: false
merchantId: '112233'
terminalId: '112244'
features:
cardNotPresent:
processors:
gpx:
enableEmsTransactionRiskScore: true
relaxAddressVerificationSystem: true
relaxAddressVerificationSystemAllowExpiredCard: true
relaxAddressVerificationSystemAllowZipWithoutCountry: true
visaStraightThroughProcessingOnly: false
ignoreAddressVerificationSystem: false
cardPresent:
processors:
gpx:
financialInstitutionId: '1347'
pinDebitNetworkOrder: '23456'
pinDebitReimbursementCode: '43567'
defaultPointOfSaleTerminalId: '5432'
enableTerminalIdLookup: false
templateId: D2A7C000-5FCA-493A-AD21-469744A19EEA
virtualTerminal:
subscriptionInformation:
enabled: true
configurationInformation:
templateId: 9FA1BB94-5119-48D3-B2E5-A81FD3C657B5
customerInvoicing:
subscriptionInformation:
enabled: true
risk: {}
commerceSolutions:
tokenManagement:
subscriptionInformation:
enabled: true
configurationInformation:
templateId: D62BEE20-DCFD-4AA2-8723-BA3725958ABA
valueAddedServices:
transactionSearch:
subscriptionInformation:
enabled: true
reporting:
subscriptionInformation:
enabled: true
example7:
summary: Merchant Boarding with SmartFDC
value:
organizationInformation:
parentOrganizationId: apitester00
type: MERCHANT
configurable: 'true'
businessInformation:
name: StuartWickedFastEatz
address:
country: US
address1: 123456 SandMarket
locality: ORMOND BEACH
administrativeArea: FL
postalCode: '32176'
websiteUrl: https://www.StuartWickedEats.com
phoneNumber: '6574567813'
locale: en-us
businessContact:
firstName: Stuart
lastName: Stuart
phoneNumber: '6574567813'
email: svc_email_bt@corpdev.visa.com
merchantCategoryCode: '5999'
productInformation:
selectedProducts:
payments:
cardProcessing:
subscriptionInformation:
enabled: true
features:
cardNotPresent:
enabled: true
cardPresent:
enabled: true
configurationInformation:
configurations:
common:
merchantCategoryCode: '1799'
defaultAuthTypeCode: FINAL
enablePartialAuth: true
processors:
smartfdc:
acquirer: {}
paymentTypes:
MASTERCARD:
enabled: true
DISCOVER:
enabled: true
JCB:
enabled: true
VISA:
enabled: true
AMERICAN_EXPRESS:
enabled: true
DINERS_CLUB:
enabled: true
merchantId: '00001234567'
terminalId: '00007654321'
batchGroup: smartfdc_00
templateId: 3173DA78-A71E-405B-B79C-928C1A9C6AB2
virtualTerminal:
subscriptionInformation:
enabled: true
configurationInformation:
templateId: 9FA1BB94-5119-48D3-B2E5-A81FD3C657B5
customerInvoicing:
subscriptionInformation:
enabled: true
risk: {}
commerceSolutions:
tokenManagement:
subscriptionInformation:
enabled: true
configurationInformation:
templateId: D62BEE20-DCFD-4AA2-8723-BA3725958ABA
valueAddedServices:
transactionSearch:
subscriptionInformation:
enabled: true
reporting:
subscriptionInformation:
enabled: true
example8:
summary: Merchant Boarding with TSYS
value:
organizationInformation:
parentOrganizationId: apitester00
type: MERCHANT
configurable: 'true'
businessInformation:
name: StuartWickedFastEatz
address:
country: US
address1: 123456 SandMarket
locality: ORMOND BEACH
administrativeArea: FL
postalCode: '32176'
websiteUrl: https://www.StuartWickedEats.com
phoneNumber: '6574567813'
locale: en-us
businessContact:
firstName: Stuart
lastName: Stuart
phoneNumber: '6574567813'
email: svc_email_bt@corpdev.visa.com
merchantCategoryCode: '5999'
productInformation:
selectedProducts:
payments:
cardProcessing:
subscriptionInformation:
enabled: true
features:
cardNotPresent:
enabled: true
cardPresent:
enabled: true
configurationInformation:
configurations:
common:
merchantCategoryCode: '5999'
processLevel3Data: ignored
defaultAuthTypeCode: FINAL
merchantDescriptorInformation:
city: cpertino
country: USA
name: kumar
state: CA
phone: '888555333'
zip: '94043'
street: steet1
enablePartialAuth: false
amexVendorCode: '2233'
processors:
tsys:
acquirer: {}
currencies:
CAD:
enabled: true
enabledCardPresent: true
enabledCardNotPresent: true
terminalId: '1234'
serviceEnablementNumber: ''
paymentTypes:
MASTERCARD:
enabled: true
VISA:
enabled: true
bankNumber: '234576'
chainNumber: '223344'
batchGroup: vital_1130
enhancedData: disabled
industryCode: D (Direct Marketing)
merchantBinNumber: '765576'
merchantId: '834215123456'
merchantLocationNumber: '00001'
storeID: '2563'
vitalNumber: '71234567'
quasiCash: false
sendAmexLevel2Data: null
softDescriptorType: 1 - trans_ref_no
travelAgencyCode: '2356'
travelAgencyName: Agent
features:
cardNotPresent:
visaStraightThroughProcessingOnly: false
amexTransactionAdviceAddendum1: null
templateId: 818048AD-2860-4D2D-BC39-2447654628A1
virtualTerminal:
subscriptionInformation:
enabled: true
configurationInformation:
templateId: 9FA1BB94-5119-48D3-B2E5-A81FD3C657B5
customerInvoicing:
subscriptionInformation:
enabled: true
risk: {}
commerceSolutions:
tokenManagement:
subscriptionInformation:
enabled: true
configurationInformation:
templateId: D62BEE20-DCFD-4AA2-8723-BA3725958ABA
valueAddedServices:
transactionSearch:
subscriptionInformation:
enabled: true
reporting:
subscriptionInformation:
enabled: true
example9:
summary: Merchant Boarding with VPC
value:
organizationInformation:
parentOrganizationId: apitester00
type: MERCHANT
configurable: 'true'
businessInformation:
name: StuartWickedFastEatz
address:
country: US
address1: 123456 SandMarket
locality: ORMOND BEACH
administrativeArea: FL
postalCode: '32176'
websiteUrl: https://www.StuartWickedEats.com
phoneNumber: '6574567813'
locale: en-us
businessContact:
firstName: Stuart
lastName: Stuart
phoneNumber: '6574567813'
email: svc_email_bt@corpdev.visa.com
merchantCategoryCode: '5999'
productInformation:
selectedProducts:
payments:
cardProcessing:
subscriptionInformation:
enabled: true
features:
cardNotPresent:
enabled: true
cardPresent:
enabled: true
configurationInformation:
configurations:
common:
merchantCategoryCode: '1799'
defaultAuthTypeCode: FINAL
masterCardAssignedId: null
sicCode: null
enablePartialAuth: false
enableInterchangeOptimization: false
enableSplitShipment: false
visaDelegatedAuthenticationId: '123457'
domesticMerchantId: false
creditCardRefundLimitPercent: '2'
businessCenterCreditCardRefundLimitPercent: '3'
allowCapturesGreaterThanAuthorizations: false
enableDuplicateMerchantReferenceNumberBlocking: false
processors:
VPC:
acquirer:
countryCode: 840_usa
fileDestinationBin: '444500'
interbankCardAssociationId: '3684'
institutionId: '444571'
discoverInstitutionId: null
paymentTypes:
VISA:
enabled: true
currencies:
CAD:
enabled: true
enabledCardPresent: false
enabledCardNotPresent: true
terminalId: '113366'
merchantId: '113355'
serviceEnablementNumber: null
USD:
enabled: true
enabledCardPresent: true
enabledCardNotPresent: true
terminalId: '113366'
merchantId: '113355'
serviceEnablementNumber: null
acquirerMerchantId: '123456'
allowMultipleBills: false
batchGroup: vdcvantiv_est_00
businessApplicationId: AA
enableAutoAuthReversalAfterVoid: true
enableExpresspayPanTranslation: null
merchantVerificationValue: '123456'
quasiCash: false
enableTransactionReferenceNumber: true
features:
cardNotPresent:
processors:
VPC:
enableEmsTransactionRiskScore: null
relaxAddressVerificationSystem: true
relaxAddressVerificationSystemAllowExpiredCard: true
relaxAddressVerificationSystemAllowZipWithoutCountry: true
visaStraightThroughProcessingOnly: false
ignoreAddressVerificationSystem: true
cardPresent:
processors:
VPC:
defaultPointOfSaleTerminalId: '223344'
pointOfSaleTerminalIds: '223355'
templateId: D671CE88-2F09-469C-A1B4-52C47812F792
virtualTerminal:
subscriptionInformation:
enabled: true
configurationInformation:
templateId: 9FA1BB94-5119-48D3-B2E5-A81FD3C657B5
customerInvoicing:
subscriptionInformation:
enabled: true
risk: {}
commerceSolutions:
tokenManagement:
subscriptionInformation:
enabled: true
configurationInformation:
templateId: D62BEE20-DCFD-4AA2-8723-BA3725958ABA
valueAddedServices:
transactionSearch:
subscriptionInformation:
enabled: true
reporting:
subscriptionInformation:
enabled: true
example10:
summary: Merchant Boarding with binLookup
value:
organizationInformation:
parentOrganizationId: apitester00
type: MERCHANT
configurable: 'true'
businessInformation:
name: StuartWickedFastEatz
address:
country: US
address1: 123456 SandMarket
locality: ORMOND BEACH
administrativeArea: FL
postalCode: '32176'
websiteUrl: https://www.StuartWickedEats.com
phoneNumber: '6574567813'
locale: en-us
businessContact:
firstName: Stuart
lastName: Stuart
phoneNumber: '6574567813'
email: svc_email_bt@corpdev.visa.com
merchantCategoryCode: '5999'
productInformation:
selectedProducts:
payments: {}
risk: {}
commerceSolutions:
binLookup:
subscriptionInformation:
enabled: true
configurationInformation:
configuration:
isPayoutOptionsEnabled: false
isAccountPrefixEnabled: true
valueAddedServices: {}
example11:
summary: Merchant Boarding with TMS and Network Token Enablement
value:
organizationInformation:
parentOrganizationId: apitester00
type: MERCHANT
configurable: 'true'
businessInformation:
name: StuartWickedFastEatz
address:
country: US
address1: 123456 SandMarket
locality: ORMOND BEACH
administrativeArea: FL
postalCode: '32176'
websiteUrl: https://www.NetworkTokenMerchant.com
locale: en-us
businessContact:
firstName: Token
lastName: Man
phoneNumber: '6574567813'
email: networktokenman@visa.com
productInformation:
selectedProducts:
commerceSolutions:
tokenManagement:
subscriptionInformation:
enabled: true
configurationInformation:
configurations:
vault:
defaultTokenType: CUSTOMER
location: GDC
tokenFormats:
customer: 32_HEX
paymentInstrument: 32_HEX
instrumentIdentifierCard: 19_DIGIT_LAST_4
instrumentIdentifierBankAccount: 32_HEX
sensitivePrivileges:
cardNumberMaskingFormat: FIRST_6_LAST_4
networkTokenServices:
visaTokenService:
enableService: true
enableTransactionalTokens: true
tokenRequestorId: '40000000082'
relationshipId: 24681921-40000000082
mastercardDigitalEnablementService:
enableService: true
enableTransactionalTokens: true
tokenRequestorId: '50162233570'
americanExpressTokenService:
enableService: true
enableTransactionalTokens: true
tokenRequestorId: '12345678912'
seNumber: '9876543212'
notifications:
enabled: true
paymentCredentials:
enabled: true
synchronousProvisioning:
enabled: false
example12:
summary: Merchant Boarding with TMS and Network Token TRID Enrollment (Production Only)
value:
organizationInformation:
parentOrganizationId: apitester00
type: MERCHANT
configurable: 'true'
businessInformation:
name: StuartWickedFastEatz
address:
country: US
address1: 123456 SandMarket
locality: ORMOND BEACH
administrativeArea: FL
postalCode: '32176'
websiteUrl: https://www.NetworkTokenMerchant.com
locale: en-us
businessContact:
firstName: Token
lastName: Man
phoneNumber: '6574567813'
email: networktokenman@visa.com
productInformation:
selectedProducts:
commerceSolutions:
tokenManagement:
subscriptionInformation:
enabled: true
configurationInformation:
configurations:
vault:
defaultTokenType: CUSTOMER
location: GDC
tokenFormats:
customer: 32_HEX
paymentInstrument: 32_HEX
instrumentIdentifierCard: 19_DIGIT_LAST_4
instrumentIdentifierBankAccount: 32_HEX
sensitivePrivileges:
cardNumberMaskingFormat: FIRST_6_LAST_4
networkTokenServices:
visaTokenService:
enableService: true
enableTransactionalTokens: true
mastercardDigitalEnablementService:
enableService: true
enableTransactionalTokens: true
americanExpressTokenService:
enableService: true
enableTransactionalTokens: true
tokenRequestorId: '12345678912'
seNumber: '9876543212'
notifications:
enabled: true
paymentCredentials:
enabled: true
synchronousProvisioning:
enabled: false
networkTokenEnrollment:
businessInformation:
name: NetworkTokenMerchant
doingBusinessAs: NetworkTokenCo1
address:
country: US
locality: ORMOND BEACH
websiteUrl: https://www.NetworkTokenMerchant.com
acquirer:
acquirerId: '40010052242'
acquirerMerchantId: MerchantOrgID
networkTokenServices:
visaTokenService:
enrollment: true
mastercardDigitalEnablementService:
enrollment: true
/boarding/v1/registrations/{registrationId}:
get:
x-devcenter-metaData:
categoryTag: Merchant_Boarding
disableProcessorDropDown: true
authorizationType:
- Json Web Token
overrideMerchantCredential: apitester00
developerGuides: https://developer.cybersource.com/api/developer-guides/Merchant-Boarding-API_ditamap/Merchant-Boarding-API.html
tags:
- Merchant Boarding
summary: Gets all the information on a boarding registration
description: 'This end point will get all information of a boarding registration
'
operationId: getRegistration
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: registrationId
type: string
description: Identifies the boarding registration to be updated
required: true
responses:
'200':
description: OK
headers:
v-c-correlationid:
type: string
description: Unique identifier for this request
schema:
type: object
properties:
registrationInformation:
type: object
properties:
boardingRegistrationId:
type: string
maxLength: 60
example: '1234124'
readOnly: true
submitTimeUtc:
type: string
format: date-time
example: '2019-06-11T22:47:57Z'
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
readOnly: true
status:
type: string
readOnly: true
description: "The status of Registration request\nPossible Values:\n - 'PROCESSING': This status is for Registrations that are still in Progress, you can get the latest status by calling the GET endpoint using the Registration Id\n - 'SUCCESS': This status is for Registrations that were successfull on every step of the on boarding process.\n - 'FAILURE': This status is for Registrations that fail before the Organization was created; please refer to the details section in the reponse for more information.\n - 'PARTIAL': This status is for Registrations that created the Organization successfully but fail in at least on step while configuring it; please refer to the details section in the response for more information.\n"
boardingPackageId:
type: string
maxLength: 60
example: 1004001
boardingFlow:
type: string
description: "Determines the boarding flow for this registration.\nPossible Values:\n - 'ENTERPRISE'\n - 'SMB'\n - 'ADDPRODUCT'\n"
mode:
type: string
description: "In case mode is not provided the API will use COMPLETE as default\nPossible Values:\n - 'COMPLETE'\n - 'PARTIAL'\n"
salesRepId:
type: string
maxLength: 60
example: Rep1
integrationInformation:
type: object
properties:
oauth2:
type: array
items:
type: object
properties:
client_id:
type: string
maxLength: 32
example: client123
state:
type: string
maxLength: 20
example: test123
required:
- client_id
tenantConfigurations:
type: array
description: tenantConfigurations is an array of objects that includes the tenant information this merchant is associated with.
items:
type: object
properties:
solutionId:
type: string
maxLength: 8
minLength: 8
pattern: ^[0-9a-zA-Z_]+$
description: 'The solutionId is the unique identifier for this system resource.
Partner can use it to reference the specific solution through out the system.
'
example: YumSolution1
tenantConfigurationId:
type: string
maxLength: 30
minLength: 6
pattern: ^[0-9a-zA-Z_]+$
description: 'The tenantConfigurationId is the unique identifier for this system resource.
You will see various places where it must be referenced in the URI path, or when
querying the hierarchy for ancestors or descendants.
'
status:
type: string
description: 'Possible values:
- LIVE
- INACTIVE
- TEST'
submitTimeUtc:
type: string
description: Time of request in UTC.
format: date-time
tenantInformation:
type: object
properties:
tenantId:
type: string
maxLength: 50
minLength: 1
description: The TenantId is an external Solution Identifier given by Tech Partners like SAP.
example: SAP123
msd:
type: object
properties:
customerId:
type: string
maxLength: 15
minLength: 1
description: The customerId is an external customer Identifier given by MSD (MS Dynamics).
example: C1234567890
organizationInformation:
type: object
properties:
organizationId:
type: string
maxLength: 30
minLength: 6
pattern: ^[0-9a-zA-Z_]+$
example: merch-test1
parentOrganizationId:
type: string
description: 'This field is required for Organization Types: MERCHANT, TRANSACTING
'
maxLength: 30
minLength: 6
pattern: ^[0-9a-zA-Z_]+$
example: merch-test1-acct
childOrganizations:
readOnly: true
type: array
items:
type: string
maxLength: 30
minLength: 6
pattern: ^[0-9a-zA-Z_]+$
example: transactional-org
type:
type: string
description: "Determines the type of organization in the hirarchy that this registration will use to onboard this Organization\nPossible Values:\n - 'TRANSACTING'\n - 'STRUCTURAL'\n - 'MERCHANT'\n"
status:
type: string
description: "Determines the status that the organization will be after being onboarded\nPossible Values:\n - 'LIVE'\n - 'TEST'\n - 'DRAFT'\n"
configurable:
description: This denotes the one organization, with exception to the TRANSACTING types, that is allowed to be used for configuration purposes against products. Eventually this field will be deprecated and all organizations will be allowed for product configuration.
type: boolean
default: false
example: false
businessInformation:
type: object
properties:
name:
type: string
maxLength: 60
minLength: 1
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: Betos Restaurant
locale:
type: string
pattern: ^(de-de|en-gb|en-us|es-es|es-us|fr-ca|fr-fr|it-it|ja-jp|pt-br|zh-cn|zh-tw)$
example: en-us
localizedNames:
type: object
properties:
romaji:
type: string
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&|\\[\\]\\,\\(\\)!$;:?@\\#¡-\uFFFF]*$"
example: tenmei
katakana:
type: string
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&|\\[\\]\\,\\(\\)!$;:?@\\#¡-\uFFFF]*$"
example: ショップネーム
japanese:
type: string
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&|\\[\\]\\,\\(\\)!$;:?@\\#¡-\uFFFF]*$"
example: 店名
doingBusinessAs:
type: string
maxLength: 60
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: Betos Restaurant
description:
type: string
maxLength: 250
pattern: '[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\n\ra-zA-Z0-9().\-_#,;/\\@$:&!?%«»€₣«»€₣ ]{1,}$'
example: International food Restaurant
startDate:
type: string
format: date
pattern: ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$
example: '2019-06-11'
description: '`Format: YYYY-MM-DD`
Example 2016-08-11 equals August 11, 2016
'
address:
type: object
properties:
country:
type: string
maxLength: 2
minLength: 2
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: US
address1:
type: string
maxLength: 60
minLength: 1
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: 123 Fake st
address2:
type: string
maxLength: 60
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: apt 2
locality:
type: string
maxLength: 50
minLength: 1
pattern: "^[0-9a-zA-Z _\\-¡-\uFFFF]+$"
description: City of the billing address.
example: Bellevue
administrativeArea:
type: string
minLength: 1
maxLength: 50
pattern: "^[0-9a-zA-Z¡-\uFFFF ]*$"
description: State or province of the billing address. Required for United States and Canada.
example: WA
postalCode:
type: string
minLength: 1
maxLength: 20
pattern: ^[0-9a-zA-Z ]*$
description: Postal code for the billing address. The postal code must consist of 5 to 9 digits. Required for United States and Canada.
example: 6470
required:
- country
- address1
- locality
timeZone:
type: string
description: 'Merchant perferred time zone
Possible Values:
- ''Pacific/Pago_Pago''
- ''Pacific/Honolulu''
- ''America/Anchorage''
- ''America/Vancouver''
- ''America/Los_Angeles''
- ''America/Phoenix''
- ''America/Edmonton''
- ''America/Denver''
- ''America/Winnipeg''
- ''America/Mexico_City''
- ''America/Chicago''
- ''America/Bogota''
- ''America/Indianapolis''
- ''America/New_York''
- ''America/La_Paz''
- ''America/Halifax''
- ''America/St_Johns''
- ''America/Buenos_Aires''
- ''America/Godthab''
- ''America/Sao_Paulo''
- ''America/Noronha''
- ''Atlantic/Cape_Verde''
- ''GMT''
- ''Europe/Dublin''
- ''Europe/Lisbon''
- ''Europe/London''
- ''Africa/Tunis''
- ''Europe/Vienna''
- ''Europe/Brussels''
- ''Europe/Zurich''
- ''Europe/Prague''
- ''Europe/Berlin''
- ''Europe/Copenhagen''
- ''Europe/Madrid''
- ''Europe/Budapest''
- ''Europe/Rome''
- ''Africa/Tripoli''
- ''Europe/Monaco''
- ''Europe/Malta''
- ''Europe/Amsterdam''
- ''Europe/Oslo''
- ''Europe/Warsaw''
- ''Europe/Stockholm''
- ''Europe/Belgrade''
- ''Europe/Paris''
- ''Africa/Johannesburg''
- ''Europe/Minsk''
- ''Africa/Cairo''
- ''Europe/Helsinki''
- ''Europe/Athens''
- ''Asia/Jerusalem''
- ''Europe/Riga''
- ''Europe/Bucharest''
- ''Europe/Istanbul''
- ''Asia/Riyadh''
- ''Europe/Moscow''
- ''Asia/Dubai''
- ''Asia/Baku''
- ''Asia/Tbilisi''
- ''Asia/Calcutta''
- ''Asia/Katmandu''
- ''Asia/Dacca''
- ''Asia/Rangoon''
- ''Asia/Jakarta''
- ''Asia/Saigon''
- ''Asia/Bangkok''
- ''Australia/Perth''
- ''Asia/Hong_Kong''
- ''Asia/Macao''
- ''Asia/Kuala_Lumpur''
- ''Asia/Manila''
- ''Asia/Singapore''
- ''Asia/Taipei''
- ''Asia/Shanghai''
- ''Asia/Seoul''
- ''Asia/Tokyo''
- ''Asia/Yakutsk''
- ''Australia/Adelaide''
- ''Australia/Brisbane''
- ''Australia/Broken_Hill''
- ''Australia/Darwin''
- ''Australia/Eucla''
- ''Australia/Hobart''
- ''Australia/Lindeman''
- ''Australia/Sydney''
- ''Australia/Lord_Howe''
- ''Australia/Melbourne''
- ''Asia/Magadan''
- ''Pacific/Norfolk''
- ''Pacific/Auckland''
'
example: America/Chicago
websiteUrl:
type: string
maxLength: 100
pattern: "\\b((?:https?://|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?«»“â€\x9D‘’]))"
example: www.test.com
type:
type: string
description: "Business type\nPossible Values:\n - 'PARTNERSHIP'\n - 'SOLE_PROPRIETORSHIP'\n - 'CORPORATION'\n - 'LLC'\n - 'NON_PROFIT'\n - 'TRUST'\n"
taxId:
type: string
maxLength: 9
pattern: \d{9}
example: 254324
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
example: 4564561234
businessContact:
type: object
properties:
firstName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
middleName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
lastName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
example: 4567890398
email:
type: string
maxLength: 100
pattern: ^([a-zA-Z0-9_\-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\]?)$
example: test@test.com
required:
- firstName
- lastName
- phoneNumber
- email
technicalContact:
type: object
properties:
firstName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
middleName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
lastName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
example: 4567890398
email:
type: string
maxLength: 100
pattern: ^([a-zA-Z0-9_\-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\]?)$
example: test@test.com
required:
- firstName
- lastName
- phoneNumber
- email
emergencyContact:
type: object
properties:
firstName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
middleName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
lastName:
type: string
maxLength: 50
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
example: John
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
example: 4567890398
email:
type: string
maxLength: 100
pattern: ^([a-zA-Z0-9_\-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\]?)$
example: test@test.com
required:
- firstName
- lastName
- phoneNumber
- email
merchantCategoryCode:
type: string
maxLength: 4
pattern: ^\d{3,4}$
example: 5300
description: Industry standard Merchant Category Code (MCC)
required:
- name
KYC:
type: object
properties:
whenIsCustomerCharged:
type: string
example: ONETIMEBEFORE
description: 'Possible values:
- ONETIMEBEFORE
- ONETIMEAFTER
- OTHER'
whenIsCustomerChargedDescription:
type: string
maxLength: 100
offerSubscriptions:
type: boolean
example: true
monthlySubscriptionPercent:
type: number
format: decimal
pattern: ^((100)|(\d{0,2}))$
example: 30
quarterlySubscriptionPercent:
type: number
format: decimal
pattern: ^((100)|(\d{0,2}))$
example: 20
semiAnnualSubscriptionPercent:
type: number
format: decimal
pattern: ^((100)|(\d{0,2}))$
example: 50
annualSubscriptionPercent:
type: number
format: decimal
pattern: ^((100)|(\d{0,2}))$
example: 100
timeToProductDelivery:
type: string
description: 'Possible values:
- INSTANT
- UPTO2
- UPTO5
- UPTO10
- GREATERTHAN10'
estimatedMonthlySales:
type: number
format: currency
pattern: ^\d{1,8}(\.\d{1,2})?$
example: 10000.5
averageOrderAmount:
type: number
format: currency
pattern: ^\d{1,6}(\.\d{1,2})?$
example: 50.5
largestExpectedOrderAmount:
type: number
format: currency
pattern: ^\d{1,6}(\.\d{1,2})?$
example: 100.5
depositBankAccount:
type: object
properties:
accountHolderName:
type: string
maxLength: 40
pattern: ^[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/\\@$:&!?%«»€₣«»€₣ ]{1,}$
example: John Doe
accountType:
type: string
example: checking
description: 'Possible values:
- checking
- savings
- corporatechecking
- corporatesavings'
accountRoutingNumber:
type: string
maxLength: 9
pattern: \d{9}
accountNumber:
type: string
maxLength: 17
pattern: ^\d{5,17}$
required:
- accountHolderName
- accountType
- accountRoutingNumber
- accountNumber
required:
- whenIsCustomerCharged
- offerSubscriptions
- timeToProductDelivery
- estimatedMonthlySales
- averageOrderAmount
- largestExpectedOrderAmount
owners:
type: array
items:
type: object
properties:
firstName:
type: string
maxLength: 50
pattern: '[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\-_#,;/\\@$:&!?%«»€₣«»€₣ ]{1,}$'
example: John
middleName:
type: string
maxLength: 50
pattern: '[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\-_#,;/\\@$:&!?%«»€₣«»€₣ ]{1,}$'
example: John
lastName:
type: string
maxLength: 50
pattern: '[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\-_#,;/\\@$:&!?%«»€₣«»€₣ ]{1,}$'
example: John
birthDate:
type: string
format: date
pattern: ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$
example: '2016-08-11'
description: '`Format: YYYY-MM-DD`
Example 2016-08-11 equals August 11, 2016
'
isPrimary:
type: boolean
description: Determines whether the owner is the Primary owner of the organization
example: true
ssn:
type: string
maxLength: 12
pattern: ^\d{3}-\d{2}-\d{4}$|^\d{9,9}$
example: 123456789
description: Social Security Number
passportNumber:
type: string
maxLength: 12
pattern: ^(?!^0+$)[a-zA-Z0-9]{3,20}$
example: '1234556'
description: Passport number
passportCountry:
type: string
maxLength: 2
minLength: 2
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: US
jobTitle:
type: string
maxLength: 100
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: Director
hasSignificantResponsability:
type: boolean
description: Determines whether owner has significant responsibility to control, manage or direct the company
example: true
ownershipPercentage:
type: number
pattern: ^[0-9]$|^[1-9][0-9]$|^(100)$
description: Determines the percentage of ownership this owner has. For the primary owner the percentage can be from 0-100; for other owners the percentage can be from 25-100 and the sum of ownership accross owners cannot exceed 100
example: 25
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
example: 4567890398
email:
type: string
maxLength: 100
pattern: ^([a-zA-Z0-9_\-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\]?)$
example: test@test.com
address:
type: object
properties:
country:
type: string
maxLength: 2
minLength: 2
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: US
address1:
type: string
maxLength: 60
minLength: 1
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: 123 Fake st
address2:
type: string
maxLength: 60
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
example: apt 2
locality:
type: string
maxLength: 50
minLength: 1
pattern: "^[0-9a-zA-Z _\\-¡-\uFFFF]+$"
description: City of the billing address.
example: Bellevue
administrativeArea:
type: string
minLength: 1
maxLength: 50
pattern: "^[0-9a-zA-Z¡-\uFFFF ]*$"
description: State or province of the billing address. Required for United States and Canada.
example: WA
postalCode:
type: string
minLength: 1
maxLength: 20
pattern: ^[0-9a-zA-Z ]*$
description: Postal code for the billing address. The postal code must consist of 5 to 9 digits. Required for United States and Canada.
example: 6470
required:
- country
- address1
- locality
required:
- firstName
- lastName
- birthDate
- jobTitle
- hasSignificantResponsability
- ownershipPercentage
- phoneNumber
- email
- address
- isPrimary
required:
- businessInformation
productInformation:
type: object
properties:
selectedProducts:
type: object
properties:
payments:
title: paymentsProducts
type: object
properties:
cardProcessing:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
features:
type: object
description: "This is a map. The allowed keys are below. Value should be an object containing a sole boolean property - enabled.\n\n \n | cardPresent | \n
\n \n | cardNotPresent | \n
\n
\n"
additionalProperties:
x-devcenter-additional-properties:
- cardPresent
- cardNotPresent
type: object
properties:
enabled:
type: boolean
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
title: CardProcessingConfig
properties:
common:
type: object
properties:
processors:
type: object
description: 'e.g.
* amexdirect
* barclays2
* CUP
* EFTPOS
* fdiglobal
* gpngsapv3
* gpx
* smartfdc
* tsys
* vero
* VPC
For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request.
e.g. replace VPC with <your vpc processor>
'
additionalProperties:
x-devcenter-additional-properties:
- amexdirect
- barclays2
- CUP
- EFTPOS
- fdiglobal
- gpngsapv3
- gpx
- smartfdc
- tsys
- vero
- VPC
type: object
properties:
batchGroup:
type: string
description: 'Determines the batching group that separates merchants for special batching times. Batching groups can separate merchant batches by the following criteria:
* Timezone
* Merchant deadlines
* Large merchants (top 10)
* Merchants with Service-Level Agreements
Applicable for Chase Paymentech Salem (chasepaymentechsalem), Streamline (streamline2), Six (six), Barclays (barclays2), Paymentech Tampa (paymentechtampa), CMCIC (cmcic), FDC Nashville (smartfdc), RUPAY, American Express Direct (amexdirect), GPN (gpn), VPC, GPX (gpx), CB2A, Barclays HISO (barclayshiso), TSYS (tsys) and FDI Global (fdiglobal) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required |
|---|
| Barclays | cnp, cp, hybrid | Yes |
| Barclays HISO | cnp, cp, hybrid | Yes |
| American Express Direct | cnp, cp, hybrid | No |
'
businessApplicationId:
type: string
description: Indicates the type of money transfer used in the transaction. Applicable for VPC and GPX (gpx) processors.
merchantVerificationValue:
type: string
description: Identify merchants that participate in Select Merchant Fee (SMF) programs. Unique to the merchant. Applicable for GPX (gpx) and VPC processors.
abaNumber:
type: string
description: Routing Number to identify banks within the United States. Applicable for GPX (gpx) processors.
acquirer:
type: object
description: Identifies the financial institution acting as the acquirer of this customer transaction. The acquirer is the member or system user that signed the merchant.
properties:
institutionId:
type: string
description: 'Identifier of the acquirer. This number is usually assigned by Visa.
Applicable for VPC, GPX (gpx), CMCIC (cmcic), EFTPOS, CB2A, CUP, American Express Direct (amexdirect) and Six (six) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex | Default Value |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | 1 | 13 | ^[0-9]+$ | 1111 |
'
interbankCardAssociationId:
type: string
description: Number assigned by MasterCard to banks to identify the member in transactions. Applicable for VPC and GPX (gpx) processors.
discoverInstitutionId:
type: string
description: Assigned by Discover to identify the acquirer. Applicable for VPC and GPX (gpx) processors.
unionPayInstitutionId:
type: string
description: Assigned by China Union Pay to identify the acquirer. Applicable for VPC processors.
dinersClubInstitutionId:
type: string
description: Assigned by Diners Club to identify the acquirer. Applicable for VPC processors.
countryCode:
type: string
description: ISO 4217 format. Applicable for VPC, GPX (gpx), EFTPOS, RUPAY, Prisma (prisma) and CUP processors.
fileDestinationBin:
type: string
description: The BIN to which this capturefile is sent. This field must contain a valid BIN. Applicable for VPC and GPX (gpx) processors.
acquirers:
type: object
description: Identifies the financial institution acting as the acquirer of this customer transaction. The acquirer is the member or system user that signed the merchant.
additionalProperties:
properties:
institutionId:
type: string
description: Identifier of the acquirer. This number is usually assigned by Visa.
interbankCardAssociationId:
type: string
description: Number assigned by MasterCard to banks to identify the member in transactions.
discoverInstitutionId:
type: string
description: Assigned by Discover to identify the acquirer.
countryCode:
type: string
description: ISO 4217 format.
fileDestinationBin:
type: string
description: The BIN to which this capturefile is sent. This field must contain a valid BIN.
merchantVerificationValue:
type: string
description: Identify merchants that participate in Select Merchant Fee (SMF) programs. Unique to the merchant.
merchantId:
type: string
description: Merchant ID assigned by an acquirer or a processor. Should not be overriden by any other party.
terminalId:
type: string
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
'
allowMultipleBills:
type: boolean
description: 'Allows multiple captures for a single authorization transaction.
'
enableTransactionReferenceNumber:
type: boolean
description: To enable merchant to send in transaction reference number (unique reconciliation ID).
paymentTypes:
type: object
description: 'Valid values are:
* VISA
* MASTERCARD
* AMERICAN_EXPRESS
* CUP
* EFTPOS
* DINERS_CLUB
* DISCOVER
* JCB
'
additionalProperties:
x-devcenter-additional-properties:
- VISA
- MASTERCARD
- AMERICAN_EXPRESS
- DISCOVER
- DINERS_CLUB
- JCB
- PIN_DEBIT
- JAYWAN
type: object
properties:
enabled:
type: boolean
currencies:
type: object
description: Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
additionalProperties:
x-devcenter-additional-properties:
- USD
- CAD
- GBP
- EUR
- CHF
- NGN
- ETB
- CUP
- AZN
- RWF
- DOP
- GMD
- BBD
- GTG
- NPR
- SHP
- BZD
- JMP
- PHP
- BRL
- TZS
- BAM
- ISK
- KWD
- RON
- ARS
- SBD
- NOK
- KRW
- TJS
- JOD
- MOP
- CLP
- SOS
- MGA
- LVL
- GIP
- PYG
- SAR
- PGK
- SGD
- ROL
- BSD
- TRY
- CDF
- SYP
- BMD
- MRO
- WST
- GHS
- BTN
- HNL
- MAD
- GAR
- SRD
- BDT
- KGS
- GNF
- CNY
- JPY
- LYD
- TTD
- CVE
- SZL
- ZMW
- KPW
- PEN
- YER
- VEB
- KHR
- VEF
- VUV
- SLL
- AFN
- SCR
- BOB
- COP
- LTL
- EGP
- HUF
- RSD
- AOA
- MYR
- MTL
- CYP
- FKP
- GYD
- PLN
- KMF
- SGD
- IQD
- DKK
- KES
- UZS
- TMM
- NZD
- LKR
- EEK
- SKK
- ANG
- INR
- UYU
- LSL
- TND
- STD
- HTG
- VND
- AED
- MZN
- BND
- KZT
- PKR
- XCD
- RUB
- MKD
- BWP
- AWG
- GEL
- MDL
- HKD
- MVR
- amd
- IRR
- NAD
- MWK
- MNT
- CRC
- XPF
- LAK
- HRK
- ALL
- TOP
- BIF
- MUR
- PAB
- FJD
- CZK
- ZWD
- KYD
- IDR
- BGN
- MXN
- UGX
- MMK
- UAH
- DZD
- XAF
- THB
- OMR
- XOF
- AUD
- ZAR
- LBP
- NIO
- DJF
- LRD
- TWD
- ERN
- BHD
- ILS
- SEK
- BYR
type: object
properties:
enabled:
type: boolean
enabledCardPresent:
type: boolean
description: Indicates whether the card-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardPresent will have the value of enabled.
enabledCardNotPresent:
type: boolean
description: Indicates whether the card-not-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardNotPresent will have the value of enabled.
merchantId:
type: string
description: Merchant ID assigned by an acquirer or a processor. Should not be overridden by any other party.
terminalId:
type: string
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
'
terminalIds:
type: array
items:
type: string
description: Applicable for Prisma (prisma) processor.
serviceEnablementNumber:
type: string
description: 'Service Establishment Number (a.k.a. SE Number) is a unique ten-digit number assigned by American Express to a merchant that accepts American Express cards.
10 digit number provided by acquirer currency. This may be unique for each currency, however it depends on the way the processor is set up for the merchant.
'
currencies:
type: object
description: Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
additionalProperties:
x-devcenter-additional-properties:
- USD
- CAD
- GBP
- EUR
- CHF
- NGN
- ETB
- CUP
- AZN
- RWF
- DOP
- GMD
- BBD
- GTG
- NPR
- SHP
- BZD
- JMP
- PHP
- BRL
- TZS
- BAM
- ISK
- KWD
- RON
- ARS
- SBD
- NOK
- KRW
- TJS
- JOD
- MOP
- CLP
- SOS
- MGA
- LVL
- GIP
- PYG
- SAR
- PGK
- SGD
- ROL
- BSD
- TRY
- CDF
- SYP
- BMD
- MRO
- WST
- GHS
- BTN
- HNL
- MAD
- GAR
- SRD
- BDT
- KGS
- GNF
- CNY
- JPY
- LYD
- TTD
- CVE
- SZL
- ZMW
- KPW
- PEN
- YER
- VEB
- KHR
- VEF
- VUV
- SLL
- AFN
- SCR
- BOB
- COP
- LTL
- EGP
- HUF
- RSD
- AOA
- MYR
- MTL
- CYP
- FKP
- GYD
- PLN
- KMF
- SGD
- IQD
- DKK
- KES
- UZS
- TMM
- NZD
- LKR
- EEK
- SKK
- ANG
- INR
- UYU
- LSL
- TND
- STD
- HTG
- VND
- AED
- MZN
- BND
- KZT
- PKR
- XCD
- RUB
- MKD
- BWP
- AWG
- GEL
- MDL
- HKD
- MVR
- amd
- IRR
- NAD
- MWK
- MNT
- CRC
- XPF
- LAK
- HRK
- ALL
- TOP
- BIF
- MUR
- PAB
- FJD
- CZK
- ZWD
- KYD
- IDR
- BGN
- MXN
- UGX
- MMK
- UAH
- DZD
- XAF
- THB
- OMR
- XOF
- AUD
- ZAR
- LBP
- NIO
- DJF
- LRD
- TWD
- ERN
- BHD
- ILS
- SEK
- BYR
type: object
properties:
enabled:
type: boolean
enabledCardPresent:
type: boolean
description: Indicates whether the card-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardPresent will have the value of enabled.
enabledCardNotPresent:
type: boolean
description: Indicates whether the card-not-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardNotPresent will have the value of enabled.
merchantId:
type: string
description: Merchant ID assigned by an acquirer or a processor. Should not be overridden by any other party.
terminalId:
type: string
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
'
terminalIds:
type: array
items:
type: string
description: Applicable for Prisma (prisma) processor.
serviceEnablementNumber:
type: string
description: 'Service Establishment Number (a.k.a. SE Number) is a unique ten-digit number assigned by American Express to a merchant that accepts American Express cards.
10 digit number provided by acquirer currency. This may be unique for each currency, however it depends on the way the processor is set up for the merchant.
'
merchantId:
type: string
description: 'Merchant ID assigned by an acquirer or a processor. Should not be overriden by any other party.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| Barclays HISO | cp, cnp, hybrid | Yes | 1 | 15 | ^[0-9a-zA-Z]+$ |
| Barclays | cp, cnp, hybrid | Yes | 1 | 11 | ^[0-9a-zA-Z]+$ |
'
terminalId:
type: string
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| Barclays HISO | cnp, hybrid | Yes | 1 | 16 | ^[0-9a-zA-Z]+$ |
| Barclays HISO | cp | No | 1 | 16 | ^[0-9a-zA-Z]+$ |
'
paymentTypes:
type: object
description: 'Valid values are:
* VISA
* MASTERCARD
* AMERICAN_EXPRESS
* CUP
* EFTPOS
* DINERS_CLUB
* DISCOVER
* JCB
'
additionalProperties:
x-devcenter-additional-properties:
- VISA
- MASTERCARD
- AMERICAN_EXPRESS
- DISCOVER
- DINERS_CLUB
- JCB
- PIN_DEBIT
- JAYWAN
type: object
properties:
enabled:
type: boolean
currencies:
type: object
description: Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
additionalProperties:
x-devcenter-additional-properties:
- USD
- CAD
- GBP
- EUR
- CHF
- NGN
- ETB
- CUP
- AZN
- RWF
- DOP
- GMD
- BBD
- GTG
- NPR
- SHP
- BZD
- JMP
- PHP
- BRL
- TZS
- BAM
- ISK
- KWD
- RON
- ARS
- SBD
- NOK
- KRW
- TJS
- JOD
- MOP
- CLP
- SOS
- MGA
- LVL
- GIP
- PYG
- SAR
- PGK
- SGD
- ROL
- BSD
- TRY
- CDF
- SYP
- BMD
- MRO
- WST
- GHS
- BTN
- HNL
- MAD
- GAR
- SRD
- BDT
- KGS
- GNF
- CNY
- JPY
- LYD
- TTD
- CVE
- SZL
- ZMW
- KPW
- PEN
- YER
- VEB
- KHR
- VEF
- VUV
- SLL
- AFN
- SCR
- BOB
- COP
- LTL
- EGP
- HUF
- RSD
- AOA
- MYR
- MTL
- CYP
- FKP
- GYD
- PLN
- KMF
- SGD
- IQD
- DKK
- KES
- UZS
- TMM
- NZD
- LKR
- EEK
- SKK
- ANG
- INR
- UYU
- LSL
- TND
- STD
- HTG
- VND
- AED
- MZN
- BND
- KZT
- PKR
- XCD
- RUB
- MKD
- BWP
- AWG
- GEL
- MDL
- HKD
- MVR
- amd
- IRR
- NAD
- MWK
- MNT
- CRC
- XPF
- LAK
- HRK
- ALL
- TOP
- BIF
- MUR
- PAB
- FJD
- CZK
- ZWD
- KYD
- IDR
- BGN
- MXN
- UGX
- MMK
- UAH
- DZD
- XAF
- THB
- OMR
- XOF
- AUD
- ZAR
- LBP
- NIO
- DJF
- LRD
- TWD
- ERN
- BHD
- ILS
- SEK
- BYR
type: object
properties:
enabled:
type: boolean
enabledCardPresent:
type: boolean
description: Indicates whether the card-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardPresent will have the value of enabled.
enabledCardNotPresent:
type: boolean
description: Indicates whether the card-not-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardNotPresent will have the value of enabled.
merchantId:
type: string
description: Merchant ID assigned by an acquirer or a processor. Should not be overridden by any other party.
terminalId:
type: string
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
'
terminalIds:
type: array
items:
type: string
description: Applicable for Prisma (prisma) processor.
serviceEnablementNumber:
type: string
description: 'Service Establishment Number (a.k.a. SE Number) is a unique ten-digit number assigned by American Express to a merchant that accepts American Express cards.
10 digit number provided by acquirer currency. This may be unique for each currency, however it depends on the way the processor is set up for the merchant.
'
currencies:
type: object
description: Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
additionalProperties:
x-devcenter-additional-properties:
- USD
- CAD
- GBP
- EUR
- CHF
- NGN
- ETB
- CUP
- AZN
- RWF
- DOP
- GMD
- BBD
- GTG
- NPR
- SHP
- BZD
- JMP
- PHP
- BRL
- TZS
- BAM
- ISK
- KWD
- RON
- ARS
- SBD
- NOK
- KRW
- TJS
- JOD
- MOP
- CLP
- SOS
- MGA
- LVL
- GIP
- PYG
- SAR
- PGK
- SGD
- ROL
- BSD
- TRY
- CDF
- SYP
- BMD
- MRO
- WST
- GHS
- BTN
- HNL
- MAD
- GAR
- SRD
- BDT
- KGS
- GNF
- CNY
- JPY
- LYD
- TTD
- CVE
- SZL
- ZMW
- KPW
- PEN
- YER
- VEB
- KHR
- VEF
- VUV
- SLL
- AFN
- SCR
- BOB
- COP
- LTL
- EGP
- HUF
- RSD
- AOA
- MYR
- MTL
- CYP
- FKP
- GYD
- PLN
- KMF
- SGD
- IQD
- DKK
- KES
- UZS
- TMM
- NZD
- LKR
- EEK
- SKK
- ANG
- INR
- UYU
- LSL
- TND
- STD
- HTG
- VND
- AED
- MZN
- BND
- KZT
- PKR
- XCD
- RUB
- MKD
- BWP
- AWG
- GEL
- MDL
- HKD
- MVR
- amd
- IRR
- NAD
- MWK
- MNT
- CRC
- XPF
- LAK
- HRK
- ALL
- TOP
- BIF
- MUR
- PAB
- FJD
- CZK
- ZWD
- KYD
- IDR
- BGN
- MXN
- UGX
- MMK
- UAH
- DZD
- XAF
- THB
- OMR
- XOF
- AUD
- ZAR
- LBP
- NIO
- DJF
- LRD
- TWD
- ERN
- BHD
- ILS
- SEK
- BYR
type: object
properties:
enabled:
type: boolean
enabledCardPresent:
type: boolean
description: 'Indicates whether the card-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardPresent will have the value of enabled.
'
enabledCardNotPresent:
type: boolean
description: 'Indicates whether the card-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardNotPresent will have the value of enabled.
'
merchantId:
description: 'Merchant ID assigned by an acquirer or a processor. Should not be overriden by any other party.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| Barclays | cp, cnp, hybrid | Yes | 1 | 11 | ^[0-9a-zA-Z]+$ |
'
terminalId:
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| Barclays | cp, cnp, hybrid | Yes | 8 | 8 | ^[0-9]+$ |
'
terminalIds:
type: array
items:
type: string
description: Applicable for Prisma (prisma) processor.
serviceEnablementNumber:
description: 'Service Establishment Number (a.k.a. SE Number) is a unique ten-digit number assigned by American Express to a merchant that accepts American Express cards.
10 digit number provided by acquirer currency. This may be unique for each currency, however it depends on the way the processor is set up for the merchant.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cp, cnp, hybrid | Yes | 10 | 10 | ^[0-9]+$ |
'
visaAggregatorId:
type: string
description: This field is used as aggregator Id when Visa payment type is selected
amexAggregatorId:
type: string
description: This field is used as aggregator Id when Amex payment type is selected
masterCardAggregatorId:
type: string
description: This field is used as aggregator Id when Master Card payment type is selected
sicCode:
type: string
description: The Standard Industrial Classification (SIC) are four-digit codes that categorize the industries that companies belong to based on their business activities. Standard Industrial Classification codes were mostly replaced by the six-digit North American Industry Classification System (NAICS). Applicable for VPC and GPX (gpx) processors.
allowMultipleBills:
type: boolean
description: 'Allows multiple captures for a single authorization transaction.
Applicable for Paymentech Tampa (paymentechtampa), VPC, American Express Direct (amexdirect) and GPX (gpx) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cp, hybrid | Yes | No |
| American Express Direct | cnp | No | No |
'
allowMerchantDescriptorOverride:
type: boolean
description: Enables partner to enable/disable merchant descriptors values. Applicable for VPC, EFTPOS and CUP processors.
enhancedData:
type: string
description: 'To enable airline transactions.
Applicable for TSYS (tsys), VPC, Elavon Americas (elavonamericas), FDI Global (fdiglobal), GPX (gpx), Barclays (barclays2) and American Express Direct (amexdirect) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required |
|---|
| Barclays | cnp, cp, hybrid | No |
| American Express Direct | cp, cnp, hybrid | No |
'
fireSafetyIndicator:
type: boolean
description: Indicates whether the merchant is compliant with Hotel and Motel Fire Safety Act of 1990. Applicable for GPX (gpx) and VPC processors.
quasiCash:
type: boolean
description: 'To enable quasi-cash transactions. A quasi-cash transaction is a cash-like transaction for the sale of items that are directly convertible to cash, such as:-
Casino gaming chips,
Money orders,
Wire transfers.
Applicable for GPX (gpx), TSYS (tsys), Barclays (barclays2) and VPC processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| Barclays | cnp, cp, hybrid | No | No |
'
acquirerMerchantId:
type: string
description: Identifier assigned by the acquirer. Applicable for RUPAY, VPC and Six (six) processors.
avsFormat:
type: string
description: "Enables Enhanced AVS/Automated Address Verification Plus (AAV+).\n\nValid values:\n\"basic\" - Standard address verification system.\n When a processor supports AVS for a transaction's card type, the issuing bank uses AVS to confirm that the customer has provided the correct billing address.\n When a customer provides incorrect information, the transaction might be fraudulent.\n\"basic + name\" - Enhanced address verification system.\n Consists of the standard AVS functionality plus verification of some additional fields.\n The additional fields that are verified for Enhanced AVS are:\n - customer_firstname\n - customer_lastname\n\"basic + name + shipto\" - Automated address verification plus.\n Consists of the Enhanced AVS functionality plus verification of some additional fields.\n AAV+ intended for merchants who deliver physical goods to a different address than the billing address.\n AAV+ verifies the additional fields only when the standard and Enhanced AVS tests pass first.\n For information about Enhanced AVS - The additional fields that are verified for AAV+ are:\n - ship_to_firstname\n - ship_to_lastname\n - ship_to_address1\n - ship_to_country\n - ship_to_zip\n - ship_to_phone\n - customer_phone(American Express Direct only)\n\nApplicable for American Express Direct (amexdirect) processor.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Default Value |
|---|
\n| American Express Direct | cnp, cp, hybrid | Yes | basic |
\n
\n"
enableLongTransRefNo:
type: boolean
description: 'Amex Direct specific merchant config value which determines what length (either 9 or Unique 12-char reference number) of reference number will be CYBS generated if the merchant does not pass in a trans_ref_no.
Can be any combination of alpha, numeric and special characters, and/or binary data in hexadecimal.
Applicable for American Express Direct (amexdirect) processor.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cp, cnp, hybrid | No | No |
'
enableLevel2:
type: boolean
description: 'Field that indicates whether merchant will send level 2 data for Amex cards.
Applicable for American Express Direct (amexdirect) processor.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cp, cnp, hybrid | No | No |
'
enableMultipleTransactionAdviceAddendum:
type: boolean
description: 'This flag related to multiple transaction advice addendum field. It is used to display descriptive information about a transaction on customer''s American Express card statement.
Applicable for American Express Direct (amexdirect) processor.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cp, cnp, hybrid | No | No |
'
amexTransactionAdviceAddendum1:
type: string
description: 'Advice addendum field. It is used to display descriptive information about a transaction on customer''s American Express card statement.
Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | No | 1 | 40 | ^[0-9a-zA-Z\-\s.]+$ |
'
enableMultiLineItems:
type: boolean
description: 'This flag is related to offer/line item details to be included instead of sending one line item, and a grand total. Example, offer0, offer 1...offer n.
Applicable for American Express Direct (amexdirect) and Elavon Americas (elavonamericas) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cp, cnp, hybrid | No | No |
'
enableTransactionReferenceNumber:
type: boolean
description: To enable merchant to send in transaction reference number (unique reconciliation ID). Applicable for VPC, Vero (vero), FDI Global (fdiglobal), Six (six), CB2A, CUP, VPC, Chase Paymentech Salem (chasepaymentechsalem), Fiserv (fiserv), Elavon Americas (elavonamericas) and EFTPOS processors.
enableAutoAuthReversalAfterVoid:
type: boolean
description: 'Enables to meet the Visa mandate requirements to reverse unused authorizations, benefitting the customer by releasing the hold on unused credit card funds.
Applicable for CB2A, Elavon Americas (elavonamericas), Six (six), VPC and American Express Direct (amexdirect) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cp, cnp, hybrid | No | No |
'
enableExpresspayPanTranslation:
type: boolean
description: When this is enabled, authorization responses from American Express expresspay transactions include the Primary Account Number (PAN) and expiration date of the card. Applicable for American Express Direct (amexdirect) processor.
enableCreditAuth:
type: boolean
description: Authorizes a credit. Reduces refund chargebacks and prevents customers from seeing the online update for credits which are otherwise offline settlements.
industryCode:
type: string
description: "Field used to identify the industry type of the merchant submitting the authorization request.\n\nValid values:\n`0` – unknown or unsure\n`A` – auto rental (EMV supported)\n`B` – bank/financial institution (EMV supported)\n`D` – direct marketing\n`F` – food/restaurant (EMV supported)\n`G` – grocery store/super market (EMV supported)\n`H` – hotel (EMV supported)\n`L` – limited amount terminal (EMV supported)\n`O` – oil company/automated fueling system (EMV supported)\n`P` – passenger transport (EMV supported)\n`R` – retail (EMV supported)\nApplicable for TSYS (tsys), RUPAY and Elavon Americas (elavonamericas) processors.\n \nPossible values:\n- 0\n- A\n- B\n- D\n- F\n- G\n- H\n- L\n- O\n- P\n- R"
sendAmexLevel2Data:
type: boolean
description: Field that indicates whether merchant will send level 2 data for Amex cards. Applicable for TSYS (tsys) processor.
softDescriptorType:
type: string
description: 'A soft descriptor is a text, rendered on a cardholder''s statement, describing a particular product or service, purchased by the cardholder.
Descriptors are intended to help the cardholder identify the products or services purchased.
Valid values:
`1` - trans_ref_no
`2` - merchant_descriptor
`3` - trans_ref_no and merchant_descriptor
Applicable for TSYS (tsys) processor.
'
vitalNumber:
type: string
description: V-number provided by TSYS info. The leading `V` must be replaced by a `7`. For example, replace `V1234567` with `71234567`. Applicable for TSYS (tsys) processor.
bankNumber:
type: string
description: 6 digit agent bank number provided by acquirer. Applicable for TSYS (tsys) processor.
chainNumber:
type: string
description: 6 digit chain number provided by acquirer. Applicable for TSYS (tsys) processor.
merchantBinNumber:
type: string
description: 6 digits acquirer bank identification number. Applicable for TSYS (tsys) processor.
merchantLocationNumber:
type: string
description: 5 digit merchant location number. Unless otherwise specified by merchant's bank or processor, this field should default to 00001. Applicable for TSYS (tsys) processor.
storeID:
type: string
description: 4 digits number used to identify a specific merchant store location within the member systems. Applicable for TSYS (tsys) processor.
travelAgencyCode:
type: string
description: Contains travel agency code if airline ticket was issued by a travel agency. Applicable for TSYS (tsys) processor.
travelAgencyName:
type: string
description: Contains travel agency name if airline ticket was issued by travel agency. Applicable for TSYS (tsys) processor.
settlementCurrency:
type: string
description: This field is used to indicate Merchant's settlement currency. [ISO 4217 ALPHA-3 Standard Currency Codes] Applicable for TSYS (tsys) and Streamline (streamline2) processors.
enableLeastCostRouting:
type: boolean
description: Indicates whether Least Cost Routing is enabled. Applicable for EFTPOS and CUP processors.
enableCVVResponseIndicator:
type: boolean
description: This field denotes EFTPOS Merchant's choice of receiving CVV Processing Response in return. Applicable for EFTPOS processors.
enableMultiCurrencyProcessing:
type: string
description: 'Applicable for Barclays (barclays2) processor.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| Barclays | cnp, cp, hybrid | No | Yes |
'
transactionTypeIdentifier:
type: string
maxLength: 3
minLength: 1
pattern: ^[0-9a-zA-Z]+$
description: Transaction Type Identifier (TTI) field for Mastercard AFT transactions. Maps to ISO field F104.65.32. Used to ensure compliance with Mastercard's requirements for money send transactions when wallet classifications differ between Visa and Mastercard schemes. Takes priority over BAI values for Mastercard AFT transactions when present.
subMerchantId:
type: string
maxLength: 55
minLength: 1
pattern: ^[0-9a-zA-Z\_\s]+$
description: The Sub merchant ID, sometimes referred to as the 'Seller ID' is generally used and *required for Aggregators and OptBlue participants. The 'Sub Merchant' is the Merchant whose transactions are submitted by a payment aggregator.
subMerchantEmail:
type: string
maxLength: 255
minLength: 0
pattern: ^([\w-]+(?:\.[\w-]+)*)@((?:[\w-]+\.)*\w[\w-]{0,70})\.([a-zA-Z]{2,6}(?:\.[a-zA-Z]{2})?)$
description: Sub Merchant Email of the Payment Facilitator's, OptBlue Participant
subMerchantPhoneNumber:
type: string
maxLength: 12
minLength: 1
pattern: ^[0-9a-zA-Z]+$
description: Sub Merchant Phone Number of the Payment Facilitator's, OptBlue Participant's
enablePosNetworkSwitching:
type: boolean
description: '''POS Network Switching'' or ''Alternate Routing'' means merchant can process PIN Debit transactions without a PIN. Set the value to ''Yes'' if it is supported. Applicable for FDI Global (fdiglobal) processor.'
enableDynamicCurrencyConversion:
type: boolean
description: Enable dynamic currency conversion for a merchant.
merchantTier:
type: string
maxLength: 3
minLength: 3
pattern: ^[0-9]+$
description: Merchant Tier defines the type of merchant, the numeric Merchant Tier value is allocated by EFTPOS. Applicable for EFTPOS processors.
required:
- merchantId
amexVendorCode:
type: string
description: Vendor code assigned by American Express. Applicable for TSYS (tsys) processor.
defaultAuthTypeCode:
type: string
description: "Authorization Finality indicator. Please note that the input can be in small case or capitals but response is in small case as of now. It will be made capitals everywhere in the next version.\nApplicable for Elavon Americas (elavonamericas), TSYS (tsys), Barclays (barclays2), Streamline (streamline2), Six (six), Barclays HISO (barclayshiso), GPN (gpn), FDI Global (fdiglobal), GPX (gpx), Paymentech Tampa (paymentechtampa), FDC Nashville (smartfdc), VPC and Chase Paymentech Salem (chasepaymentechsalem) processors.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Default Value |
|---|
\n| Barclays | cnp, cp, hybrid | No | FINAL |
\n| Barclays HISO | cnp, cp, hybrid | Yes | FINAL |
\n
\n \nPossible values:\n- PRE\n- FINAL\n- UNDEFINED"
masterCardAssignedId:
type: string
description: MAID aka MasterCard assigned ID, MasterCard equivalent of Merchant Verification Value by Visa. Applicable for VPC, GPX (gpx) and FDI Global (fdiglobal) processors.
enablePartialAuth:
type: boolean
description: 'Allow merchants to accept partial authorization approvals.
Applicable for Elavon Americas (elavonamericas), VPC, GPX (gpx), FDI Global (fdiglobal), FDC Nashville (smartfdc), GPN (gpn), TSYS (tsys), American Express Direct (amexdirect), Paymentech Tampa (paymentechtampa) and Chase Paymentech Salem (chasepaymentechsalem) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cnp, cp, hybrid | No | No |
'
merchantCategoryCode:
type: string
description: 'Indicates type of business product or service of the merchant.
Applicable for Chase Paymentech Salem (chasepaymentechsalem), FDI Global (fdiglobal), RUPAY, Elavon Americas (elavonamericas), American Express Direct (amexdirect), CMCIC (cmcic), GPX (gpx), VPC, TSYS (tsys), EFTPOS, CUP, Paymentech Tampa (paymentechtampa), CB2A, Barclays (barclays2), Prisma (prisma) and GPN (gpn) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| Barclays | cnp | No | 4 | 4 | ^[0-9]+$ |
| American Express Direct | cnp, cp, hybrid | Yes | 4 | 4 | ^[0-9]+$ |
'
sicCode:
type: string
description: The Standard Industrial Classification (SIC) are four-digit codes that categorize the industries that companies belong to based on their business activities. Standard Industrial Classification codes were mostly replaced by the six-digit North American Industry Classification System (NAICS). Applicable for VPC and GPX (gpx) processors.
foodAndConsumerServiceId:
type: string
description: Food and Consumer Service ID. Identifies the merchant as being certified and approved to accept Food Stamps. Applicable for GPX (gpx) processor.
enableSplitShipment:
type: boolean
description: 'Enables you to split an order into multiple shipments with multiple captures. This feature is provided by CyberSource and supports three different scenarios:
* multiple authorizations
* multiple captures
* multiple authorizations with multiple captures
Applicable for VPC processors.
'
enableInterchangeOptimization:
type: boolean
description: Reduces your interchange fees by using automatic authorization refresh and automatic partial authorization reversal. Applicable for VPC processors.
visaDelegatedAuthenticationId:
type: string
description: Identifier provided to merchants who opt for Visa's delegated authorization program. Applicable for VPC processors.
creditCardRefundLimitPercent:
type: string
description: Blocks over-refunds when the aggregated refund amount is higher than the percentage set for this field. Applicable for GPX (gpx), VPC and Chase Paymentech Salem (chasepaymentechsalem) processors.
businessCenterCreditCardRefundLimitPercent:
type: string
description: Limits refunds to the percentage set in this field. Applicable for GPX (gpx) and VPC processors.
allowCapturesGreaterThanAuthorizations:
type: boolean
description: Enables this merchant account to capture amounts greater than the authorization amount. Applicable for GPX (gpx), VPC, Paymentech Tampa (paymentechtampa) and Chase Paymentech Salem (chasepaymentechsalem) processors.
enableDuplicateMerchantReferenceNumberBlocking:
type: boolean
description: Helps prevent duplicate transactions. Applicable for VPC, GPX (gpx) and Chase Paymentech Salem (chasepaymentechsalem) processors.
domesticMerchantId:
type: boolean
description: This is a local merchant ID used by merchants in addition to the conventional merchant ID. This value is sent to the issuer. Applicable for VPC and Prisma (prisma) processors.
processLevel3Data:
type: string
description: 'Indicates whether merchant processes Level 3 transactions.
Applicable for TSYS (tsys), Barclays (barclays2), Paymentech Tampa (paymentechtampa), FDI Global (fdiglobal), Elavon Americas (elavonamericas) and Chase Paymentech Salem (chasepaymentechsalem) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required |
|---|
| Barclays | cnp | No |
'
subMerchantId:
type: string
description: 'The ID assigned to the sub-merchant.
Applicable for American Express Direct (amexdirect) processor.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | No | 1 | 20 | ^[0-9a-zA-Z\-\_\,\s.]+$ |
'
subMerchantBusinessName:
type: string
description: 'Sub-merchant''s business name.
Applicable for American Express Direct (amexdirect) processor.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | No | 1 | 37 | ^[0-9a-zA-Z\-\_\,\s.]+$ |
'
preferCobadgedSecondaryBrand:
type: boolean
description: It denotes merchant's preference on secondary brand for routing in case of co-branded cards. Applicable for EFTPOS processors.
merchantDescriptorInformation:
type: object
description: A merchant descriptor is the line of copy that identifies transactions on a cardholder's account activity and statement. If this information is not populated, the data will be retrieved from OMS.
properties:
name:
type: string
description: 'Applicable for TSYS (tsys), RUPAY, American Express Direct (amexdirect) and Elavon Americas (elavonamericas) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | 1 | 38 | ^[0-9a-zA-Z\s]+$ |
'
city:
type: string
description: 'Applicable for American Express Direct (amexdirect), TSYS (tsys), RUPAY and Elavon Americas (elavonamericas) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | 1 | 21 | ^[0-9a-zA-Z\s]+$ |
'
country:
type: string
description: 'Applicable for Six (six), Elavon Americas (elavonamericas), TSYS (tsys) and American Express Direct (amexdirect) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | 3 | 3 | ^[A-Z]+$ |
'
phone:
type: string
description: 'Applicable for RUPAY, Elavon Americas (elavonamericas), American Express Direct (amexdirect) and TSYS (tsys) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | 1 | 20 | ^[0-9a-zA-Z\s]+$ |
'
state:
type: string
description: 'Applicable for RUPAY, TSYS (tsys), Elavon Americas (elavonamericas) and American Express Direct (amexdirect) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | No | 1 | 3 | ^[A-Z]+$ |
'
street:
type: string
description: 'Applicable for American Express Direct (amexdirect), TSYS (tsys) and Elavon Americas (elavonamericas) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | 1 | 38 | ^[0-9a-zA-Z\s]+$ |
'
zip:
type: string
description: 'Applicable for Elavon Americas (elavonamericas), RUPAY, American Express Direct (amexdirect) and TSYS (tsys) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | 1 | 15 | ^[0-9a-zA-Z\s]+$ |
'
url:
type: string
description: 'Applicable for RUPAY and American Express Direct (amexdirect) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, hybrid | Yes | 1 | 40 | URL |
| American Express Direct | cp | No | 1 | 40 | URL |
'
countryOfOrigin:
type: string
description: Country Cf Origin of merchant is applicable for VPC Processors and is dependent on governmentControlled attribute.
acquirerAgreement:
type: object
description: Contains information about the acquirer agreement. The payload will have acquirerCode (example "Sumitomo") and its object containing all the acquirerAgreement fields.
properties:
acquirerCode:
type: object
description: Contains the specific configuration details for an acquirer.
properties:
acquirerAccountId:
type: string
description: Account number for the acquirer.
summerBonusStartDate:
type: string
description: Bonus start date for the summer period.
summerBonusEndDate:
type: string
description: Bonus end date for the summer period.
summerBonusMonth:
type: string
description: Bonus month for the summer period .
winterBonusStartDate:
type: string
description: Bonus start date for the winter period.
winterBonusEndDate:
type: string
description: Bonus end date for the winter period.
winterBonusMonth:
type: string
description: Bonus month for the winter period .
numberOfInstallments:
type: string
description: Comma-separated list of the number of installments.
paymentModes:
type: string
description: Comma-separated list of payment modes.
numberOfInstallmentPayments:
type: string
description: Comma-separated list of the number of installment payments.
numberOfIntegratedInstallments:
type: string
description: Comma-separated list of the number of integrated installments.
numberOfBonusPayments:
type: string
description: Comma-separated list of the number of bonus payments.
centerName:
type: string
description: Center name provided by the acquirer.
fbnIdentificationFlag:
type: string
description: FBN (For Benefit Of) Identification flag.
retailSupported:
type: boolean
description: Indicates if retail transactions are supported.
paymentOptions:
type: object
properties:
jpPaymentOptionType:
type: array
items:
type: string
description: An array of Japan-specific payment options.
governmentControlled:
type: boolean
description: Indicates whether the merchant is government controlled. Applicable for VPC processors.
dropBillingInfo:
type: boolean
description: This field is used to indicate whether the merchant wants to drop the billing information from the request. If this field is set to true, then the billing information will be dropped from the request. If this field is set to false, then the billing information will be sent in the request.
features:
type: object
properties:
cardNotPresent:
type: object
properties:
processors:
type: object
description: 'e.g.
* amexdirect
* barclays2
* CUP
* EFTPOS
* fdiglobal
* gpx
* smartfdc
* tsys
* vero
* VPC
For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request.
e.g. replace VPC with <your vpc processor>
'
additionalProperties:
x-devcenter-additional-properties:
- amexdirect
- barclays2
- CUP
- EFTPOS
- fdiglobal
- gpx
- smartfdc
- tsys
- VPC
type: object
properties:
relaxAddressVerificationSystem:
type: boolean
description: 'Enables you to submit the payment transaction without one or more of the fields for the billTo or card_expiration.
Applicable for Elavon Americas (elavonamericas), CB2A, Six (six), CMCIC (cmcic), GPX (gpx), GPN (gpn), VPC, Vero (vero), Fiserv (fiserv), American Express Direct (amexdirect), Chase Paymentech Salem (chasepaymentechsalem), RUPAY, FDI Global (fdiglobal) and Barclays HISO (barclayshiso) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| Barclays HISO | cp, cnp, hybrid | No | Yes |
| American Express Direct | cnp | No | No |
| American Express Direct | cp | No | Yes |
| American Express Direct | hybrid | Yes | Yes |
'
relaxAddressVerificationSystemAllowZipWithoutCountry:
type: boolean
description: 'Allows Zip code without country.
Applicable for American Express Direct (amexdirect), GPX (gpx), VPC, FDI Global (fdiglobal), Elavon Americas (elavonamericas), Chase Paymentech Salem (chasepaymentechsalem), RUPAY, GPN (gpn) and Barclays HISO (barclayshiso) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| Barclays HISO | cp, cnp, both | No | Yes |
| American Express Direct | cp, hybrid | No | Yes |
| American Express Direct | cnp | No | No |
'
relaxAddressVerificationSystemAllowExpiredCard:
type: boolean
description: 'Allows transactions that use an expired card.
Applicable for American Express Direct (amexdirect), GPN (gpn), Barclays HISO (barclayshiso), Elavon Americas (elavonamericas), VPC, FDI Global (fdiglobal), GPX (gpx), RUPAY, Six (six), Chase Paymentech Salem (chasepaymentechsalem) and CB2A processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| Barclays HISO | cp, cnp, hybrid | No | Yes |
| American Express Direct | cp, hybrid | No | Yes |
| American Express Direct | cnp | No | No |
'
enableEmsTransactionRiskScore:
type: boolean
description: MasterCard Expert Monitoring Solutions (EMS) provides a predictive, behavior-based fraud score in real time during authorizations for card-not-present (CNP) transactions on cards issued in the U.S. Applicable for GPX (gpx) and VPC processors.
prestigiousPropertyIndicator:
type: string
description: Applicable for VPC processors.
payouts:
type: object
properties:
reimbursementCode:
type: string
description: Applicable for VPC processors.
acquiringInstitutionId:
type: string
description: This code identifies the financial institution acting as the acquirer of this customer transaction. The acquirer is the member or system user that signed the merchant. This number is usually a Visa-assigned. Applicable for VPC processors.
businessApplicationId:
type: string
description: Transaction type. List of supported identifiers documented in the Developer Guide. Applicable for GPX (gpx) and VPC processors.
financialInstitutionId:
type: string
description: Applicable for GPX (gpx) and VPC processors.
merchantAbaNumber:
type: string
description: Routing Number to identify banks within the United States. Applicable for VPC processors.
networkOrder:
type: string
description: Order of the networks in which Visa should make routing decisions. Applicable for VPC processors.
currencies:
type: object
description: Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
additionalProperties:
x-devcenter-additional-properties:
- USD
- CAD
- GBP
- EUR
- CHF
- NGN
- ETB
- CUP
- AZN
- RWF
- DOP
- GMD
- BBD
- GTG
- NPR
- SHP
- BZD
- JMP
- PHP
- BRL
- TZS
- BAM
- ISK
- KWD
- RON
- ARS
- SBD
- NOK
- KRW
- TJS
- JOD
- MOP
- CLP
- SOS
- MGA
- LVL
- GIP
- PYG
- SAR
- PGK
- SGD
- ROL
- BSD
- TRY
- CDF
- SYP
- BMD
- MRO
- WST
- GHS
- BTN
- HNL
- MAD
- GAR
- SRD
- BDT
- KGS
- GNF
- CNY
- JPY
- LYD
- TTD
- CVE
- SZL
- ZMW
- KPW
- PEN
- YER
- VEB
- KHR
- VEF
- VUV
- SLL
- AFN
- SCR
- BOB
- COP
- LTL
- EGP
- HUF
- RSD
- AOA
- MYR
- MTL
- CYP
- FKP
- GYD
- PLN
- KMF
- SGD
- IQD
- DKK
- KES
- UZS
- TMM
- NZD
- LKR
- EEK
- SKK
- ANG
- INR
- UYU
- LSL
- TND
- STD
- HTG
- VND
- AED
- MZN
- BND
- KZT
- PKR
- XCD
- RUB
- MKD
- BWP
- AWG
- GEL
- MDL
- HKD
- MVR
- amd
- IRR
- NAD
- MWK
- MNT
- CRC
- XPF
- LAK
- HRK
- ALL
- TOP
- BIF
- MUR
- PAB
- FJD
- CZK
- ZWD
- KYD
- IDR
- BGN
- MXN
- UGX
- MMK
- UAH
- DZD
- XAF
- THB
- OMR
- XOF
- AUD
- ZAR
- LBP
- NIO
- DJF
- LRD
- TWD
- ERN
- BHD
- ILS
- SEK
- BYR
type: object
properties:
enabled:
type: boolean
enabledCardPresent:
type: boolean
description: 'Indicates whether the card-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardPresent will have the value of enabled.
'
enabledCardNotPresent:
type: boolean
description: 'Indicates whether the card-present transaction is activated for the selected currency. If both enabledCardPresent and enabledCardNotPresent are set to null, then enabledCardNotPresent will have the value of enabled.
'
merchantId:
type: string
description: Merchant ID assigned by an acquirer or a processor. Should not be overriden by any other party.
terminalId:
type: string
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
'
terminalIds:
type: array
items:
type: string
description: Applicable for Prisma (prisma) processor.
serviceEnablementNumber:
type: string
description: 'Service Establishment Number (a.k.a. SE Number) is a unique ten-digit number assigned by American Express to a merchant that accepts American Express cards.
10 digit number provided by acquirer currency. This may be unique for each currency, however it depends on the way the processor is set up for the merchant.
'
example:
USD:
enabled: true
enabledCardPresent: false
enabledCardNotPresent: true
merchantId: merchantId
terminalIds:
- '12345678'
- '12345678'
serviceEnablementNumber: serviceEnablementNumber
merchantId:
type: string
description: 'Merchant ID assigned by an acquirer or a processor. Should not be overridden by any other party.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| Barclays | cnp, hybrid | No | 1 | 11 | ^[0-9]+$ |
'
terminalId:
type: string
description: 'The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| Barclays | cnp, hybrid | No | 1 | 255 | ^[0-9:\-]+$ |
'
ignoreAddressVerificationSystem:
type: boolean
description: Flag for a sale request that indicates whether to allow the capture service to run even when the authorization receives an AVS decline. Applicable for VPC, FDI Global (fdiglobal), GPX (gpx) and GPN (gpn) processors.
visaStraightThroughProcessingOnly:
type: boolean
description: Indicates if a merchant is enabled for Straight Through Processing - B2B invoice payments. Applicable for FDI Global (fdiglobal), TSYS (tsys), VPC and GPX (gpx) processors.
amexTransactionAdviceAddendum1:
type: string
description: Advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors.
installment:
type: object
properties:
enableInstallment:
type: boolean
description: 'This flag is to enable for installment plan programs.
Applicable for Fiserv (fiserv), Vero (vero) and American Express Direct (amexdirect) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cnp | No | No |
'
installmentPlan:
type: string
description: 'This indicates the type of funding for the installment plan associated with the payment.
Valid values:
"merchant" - Merchant-funded installment plan
"issuer" - Issuer-funded installment plan
Applicable for Fiserv (fiserv), American Express Direct (amexdirect) and Vero (vero) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required |
|---|
| American Express Direct | cnp | No |
'
cardPresent:
type: object
properties:
processors:
type: object
description: 'e.g.
* amexdirect
* barclays2
* CUP
* EFTPOS
* fdiglobal
* gpx
* smartfdc
* tsys
* vero
* VPC
For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request.
e.g. replace VPC with <your vpc processor>
'
additionalProperties:
x-devcenter-additional-properties:
- amexdirect
- barclays2
- CUP
- EFTPOS
- fdiglobal
- gpx
- smartfdc
- tsys
- VPC
type: object
properties:
defaultPointOfSaleTerminalId:
type: string
description: 'Default Terminal ID used for Card Present and Virtual Terminal transactions.
Applicable for VPC, GPX (gpx), American Express Direct (amexdirect) and Chase Paymentech Salem (chasepaymentechsalem) processors.
Validation details (for selected processors)...
| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex | Default Value |
|---|
| American Express Direct | cp | Yes | 4 | 8 | ^[0-9a-zA-Z]+$ | 1111 |
'
pointOfSaleTerminalIds:
type: array
items:
type: string
format: csv
description: For retail transactions, if merchant chooses to send the terminal id in the API, then that value has to be validated before being used. Holds a comma separated list of all possible terminal ids that the merchant is likely to send. Applicable for VPC processors.
disablePointOfSaleTerminalIdValidation:
type: boolean
description: Disables terminal ID validation. Applicable for VPC processors.
pinDebitNetworkOrder:
type: string
description: Order of the networks in which Visa should make routing decisions. Applicable for GPX (gpx) and VPC processors.
pinDebitReimbursementCode:
type: string
description: This attribute requests VIP to qualify a given PIN Debit transaction for a certain type of interchange program. Y = SMS supermarket, Z = SMS general merchant. Applicable for GPX (gpx) and VPC processors.
financialInstitutionId:
type: string
description: Acquirer Institution ID for the PIN Debit Transactions. Applicable for GPX (gpx) and VPC processors.
enablePinTranslation:
type: boolean
description: Enables CyberSource PIN Translation for Online PIN Transactions. Please ensure you have exchanged PIN keys with CyberSource to use this feature. Applicable for VPC processors.
enableTerminalIdLookup:
type: boolean
description: Used for Card Present and Virtual Terminal Transactions for Terminal ID lookup. Applicable for GPX (gpx) processor.
alternativePaymentMethods:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
configurationInformation:
type: object
properties:
configurations:
type: object
properties:
merchantCategoryCode:
type: string
description: 'Merchant Category Code (MCC) is a four-digit number assigned to a business by credit card companies
when the business first starts accepting credit cards as a form of payment. The MCC is used to
classify the business by the type of goods or services it provides.
'
processors:
type: object
description: "This is a map. The allowed keys are below. Value should be an object containing a sole boolean property - enabled.\n\n \n | klarna | \n
\n \n | payPal | \n
\n \n | alipay | \n
\n \n | bancontact | \n
\n \n | giropay | \n
\n \n | ideal | \n
\n
\n"
additionalProperties:
type: object
description: 'Processor configuration for the product.
'
properties:
paymentMethods:
type: object
description: 'Payment methods supported by the processor. The following values are supported:
- klarna
- CREDIT_CARD
- DEBIT_CARD
'
additionalProperties:
type: object
description: 'Payment method configuration for the product.
'
properties:
merchantId:
type: string
description: 'Merchant ID for the payment method. This is a unique identifier for the merchant.
example. mid12345678
'
logoUrl:
type: string
description: 'URL of the logo for the payment method. This is used for branding purposes.
example: http://www.test.com
'
redirectSuccessUrl:
type: string
description: 'URL to redirect to after a successful transaction. This is where the user will be sent after completing the payment.
example: http://www.test.com/success
'
redirectCancelUrl:
type: string
description: 'URL to redirect to if the user cancels the transaction. This is where the user will be sent if they choose to cancel the payment.
example: http://www.test.com/cancel
'
redirectFailureUrl:
type: string
description: 'URL to redirect to if the transaction fails. This is where the user will be sent if there is an error during the payment process.
example: http://www.test.com/failure
'
underwriting:
title: underwritingConfiguration
type: object
description: 'Underwriting configuration containing the complete VMES (Visa Merchant Evaluation Service) payload for merchant risk evaluation.
'
properties:
clientReferenceInformation:
type: object
properties:
clientRequestId:
description: 'client-generated request reference or tracking number. It is recommended that you send a unique value for each request so that you can perform meaningful searches for the request.
'
type: string
maxLength: 50
minLength: 1
pattern: ^[0-9a-zA-Z_]+$
example: merch-test1
applicationName:
type: string
maxLength: 50
description: "The name of the application (such as Boarding Workflow or Anet Boarding) that the client uses to send a request to merchant evaluation service. \n"
minLength: 1
pattern: ^[0-9a-zA-Z_]+$
example: merch-test1
merchantApplication:
type: object
required:
- products
properties:
applicationId:
type: string
readOnly: true
applicationStatus:
type: string
readOnly: true
products:
description: The product(s) that are being underwritten
type: array
items:
type: object
required:
- productShortName
properties:
productShortName:
description: 'Product Name
[PRODUCT1, PRODUCT2, PRODUCT3]
'
type: string
pattern: ^[a-zA-Z0-9-]{1,30}$
preferredAcquirer:
description: Override Acquirer Value
type: string
maxLength: 30
pattern: ^[a-zA-Z0-9-_]$
status:
readOnly: true
description: 'Product status
[]
'
type: string
campaignId:
description: Driver Campaign ID, identifies where the application came from
type: string
ocId:
description: Offer CampaignID, used by Sales
type: string
resellerId:
description: ResellerID, used by Sales
type: string
maxLength: 128
metadata:
type: object
metadataExternal:
type: object
organizationInformation:
type: object
properties:
parentOrganizationId:
type: string
minLength: 6
maxLength: 30
pattern: ^[0-9a-zA-Z_]+$
description: Parent Organization ID for the application
organizationId:
type: string
minLength: 6
maxLength: 30
pattern: ^[0-9a-zA-Z_]+$
description: Organization ID for the application
boardingPackageId:
type: string
maxLength: 60
description: Boarding Package ID for the application
businessInformation:
type: object
required:
- businessIdentifier
- countryRegistration
- legalName
- doingBusinessAs
- businessDescription
- startDate
- merchantCategoryCode
- businessType
- countryPhoneNumber
- phoneNumber
- email
properties:
businessIdentifier:
type: string
maxLength: 20
pattern: ^[a-zA-Z0-9]*$
description: Tax ID for the business
countryRegistration:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country where the business is registered. Two character country code, ISO 3166-1 alpha-2.
legalName:
type: string
minLength: 1
maxLength: 60
description: The legally registered name of the business
doingBusinessAs:
type: string
maxLength: 60
description: The DBA of the business.
businessDescription:
type: string
maxLength: 250
description: Short description of the Business
registrationNumber:
type: string
maxLength: 60
description: Registration ID for Enterprise Merchant
stockExchange:
type: string
maxLength: 60
description: Which stock exchange is the company trading in?
tickerSymbol:
type: string
maxLength: 10
pattern: ^[a-zA-Z0-9_.]*$
description: Stock Symbol on the exchange
startDate:
type: string
format: date
description: 'When did Business start. Format: YYYY-MM-DD Example 2016-08-11 equals August 11, 2016'
merchantCategoryCode:
type: string
maxLength: 4
pattern: ^\d{3,4}$
description: Industry standard Merchant Category Code (MCC)
mccDescription:
type: string
maxLength: 128
description: MCC Description
websiteURL:
type: string
maxLength: 100
description: Website for the Business
businessType:
type: string
description: "Business type \nPossible values:\n- PARTNERSHIP\n- SOLE_PROPRIETORSHIP\n- CORPORATION\n- LLC\n- NON_PROFIT\n- TRUST"
localMCC:
type: array
items:
type: string
countryPhoneNumber:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country of the Business phone number. Two character country code, ISO 3166-1 alpha-2.
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
description: Business Phone Number
email:
type: string
maxLength: 100
description: Business Email Address
whatYourCompanyDoes:
type: string
maxLength: 500
description: What your company does and how you market your service
address:
type: object
required:
- country
- address1
- locality
- administrativeArea
- postalCode
properties:
country:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country where the business is located. Two character country code, ISO 3166-1 alpha-2.
address1:
type: string
minLength: 1
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Business street address
address2:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Business street address continued
buildingName:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Building Name
locality:
type: string
minLength: 1
maxLength: 50
pattern: ^[0-9a-zA-Z _\-\u00A1-\uFFFF]+$
description: City of the billing address
administrativeArea:
type: string
minLength: 1
maxLength: 50
pattern: ^[0-9a-zA-Z _\-\u00A1-\uFFFF]+$
description: Business state (US) or province (Canada, others). Required for US and Canada.
postalCode:
type: string
minLength: 1
maxLength: 20
description: Business zip code (US) or postal code (Canada). The postal code must consist of 5 to 9 digits. Required for United States and Canada.
tradingAddress:
type: object
properties:
country:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country where the business is located. Two character country code, ISO 3166-1 alpha-2.
address1:
type: string
minLength: 1
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Business street address
address2:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Business street address continued
buildingName:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Building Name
locality:
type: string
minLength: 1
maxLength: 50
pattern: ^[0-9a-zA-Z _\-\u00A1-\uFFFF]+$
description: City of the billing address
administrativeArea:
type: string
minLength: 1
maxLength: 50
pattern: ^[0-9a-zA-Z _\-\u00A1-\uFFFF]+$
description: Business state (US) or province (Canada, others). Required for US and Canada.
postalCode:
type: string
minLength: 1
maxLength: 20
description: Business zip code (US) or postal code (Canada). The postal code must consist of 5 to 9 digits. Required for United States and Canada.
businessContact:
type: object
required:
- firstName
- lastName
- phoneNumber
- email
properties:
firstName:
type: string
maxLength: 50
description: Contact Person First Name
middleName:
type: string
maxLength: 50
description: Contact Person Middle Name
lastName:
type: string
maxLength: 50
description: Contact Person Last Name
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
description: Contact Person Phone Number
email:
type: string
maxLength: 100
description: Contact Persona Email
businessDetails:
type: object
required:
- interactionTypes
- percentageSplitByF2F
- percentageSplitByCNP
- whenIsCustomerCharged
- offerSubscriptions
properties:
customerType:
type: string
description: "Who is the business interacting with? Business to Business, Business to Consumer, Both \nPossible values:\n- B2B\n- B2C\n- Both"
percentageSplitByB2B:
type: number
minimum: 0
maximum: 100
default: 0
description: '% Split'
percentageSplitByB2C:
type: number
minimum: 0
maximum: 100
default: 0
description: '% Split'
interactionTypes:
type: string
description: "Merchant Facing: Face to Face, Card Not Present, Both \nPossible values:\n- F2F\n- CNP\n- Both"
percentageSplitByF2F:
type: number
minimum: 0
maximum: 100
default: 0
description: '% Split'
percentageSplitByCNP:
type: number
minimum: 0
maximum: 100
default: 0
description: '% Split'
whenIsCustomerCharged:
type: string
description: "When is the customer charged? \nPossible values:\n- OneTimeBeforeServiceDelivery\n- OneTimeAfterServiceDelivery\n- Other"
whenIsCustomerChargedDescription:
type: string
maxLength: 30
offerSubscriptions:
type: boolean
description: Does Merchant Offer Subscriptions?
monthlySubscriptionPercent:
type: number
minimum: 0
maximum: 100
default: 0
description: '% of business is monthly subscriptions'
quarterlySubscriptionPercent:
type: number
minimum: 0
maximum: 100
default: 0
description: '% of business is quarterly subscriptions'
semiannualSubscriptionPercent:
type: number
minimum: 0
maximum: 100
default: 0
description: '% of business is semi-annual subscriptions'
annualSubscriptionPercent:
type: number
minimum: 0
maximum: 100
default: 0
description: '% of business is annual subscriptions'
currencyType:
type: string
description: "Processing Currency. ISO 4217, 3 characters. \nPossible values:\n- USD\n- CAD\n- EUR\n- GBP\n- CHF"
estimatedMonthlySales:
type: number
description: Merchant's estimated monthly sales
averageOrderAmount:
type: number
description: Merchant's average order amount
largestExpectedOrderAmount:
type: number
description: Merchant's largest expected order amount
primaryAccountUsage:
type: string
description: "Primary purpose of account usage \nPossible values:\n- Paying for goods / services\n- Repatriating overseas earnings\n- Intercompany transfers\n- Collecting funds from clients\n- Liquidity / FX\n- Payment to an individual\n- Investment activity\n- Property purchase/sale\n- Other"
sourceOfFunds:
type: string
description: "Source of Funds \nPossible values:\n- Business revenue\n- External or shareholder investment\n- Loan, advance or other borrowing\n- Donations or grants\n- Inter-company transfers\n- Proceeds of sales of assests\n- Other"
receiveMoney3rdParties:
type: boolean
description: Will you recieve money from 3rd parties into your account?
receiveTransactionFrequency:
type: string
description: "Roughly how often do you expect to send or receive transactions? \nPossible values:\n- One-off or infrequently\n- 1-20 per month\n- 20-50 per month\n- 50-100 per month\n- 100+ per month"
estimatedMonthlySpend:
type: string
description: "What is your estimated total monthly spend? \nPossible values:\n- <$10,000\n- $10,000 - $50,000\n- $50,000 - $100,000\n- $100,000 - $500,000\n- $500,000+"
countryTransactions:
type: array
items:
type: string
currenciesIn:
type: array
items:
type: string
currenciesOut:
type: array
items:
type: string
productServicesSubscription:
type: array
items:
type: object
properties:
productServiceName:
type: string
maxLength: 255
description: Name of the product, service, or subscription.
productServicePercentage:
type: number
minimum: 0
maximum: 100
description: Percentage of business revenue from this product or service.
ownerInformation:
type: array
items:
type: object
required:
- firstName
- lastName
- birthDate
- isPrimary
- hasSignificantResponsibility
- nationalId
- ownershipPercentage
- nationality
- dueDiligenceRequired
- phoneNumberCountryCode
- phoneNumber
- email
properties:
firstName:
type: string
maxLength: 50
description: Owner's first name
middleName:
type: string
maxLength: 50
description: Owner's middle name
lastName:
type: string
maxLength: 50
description: Owner's last name
birthDate:
type: string
format: date
description: 'Owner''s date of birth. Format: YYYY-MM-DD Example 2016-08-11 equals August 11, 2016'
isPrimary:
type: boolean
description: Primary Owner or Non-Primary Owner
hasSignificantResponsibility:
type: boolean
description: If not an owner, is the user a Control Person
ownerDirector:
type: boolean
description: Is the owner a Director as well?
nationalId:
type: string
maxLength: 15
description: Identification value from ID document
idCountry:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country of the ID document. Two character country code, ISO 3166-1 alpha-2.
passportNumber:
type: string
maxLength: 12
description: Passport Number
passportCountry:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Passport Country. Two character country code, ISO 3166-1 alpha-2.
jobTitle:
type: string
maxLength: 100
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
description: Owner's Job Title
ownershipPercentage:
type: number
minimum: 1
maximum: 100
description: Percentage of the company that owner owns
nationality:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country of origin for the owner. Two character country code, ISO 3166-1 alpha-2.
dueDiligenceRequired:
type: boolean
description: Indicates if due diligence checks should be run for this owner
phoneNumberCountryCode:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Phone number country. Two character country code, ISO 3166-1 alpha-2.
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
description: Owner's phone number
email:
type: string
maxLength: 100
description: Email address for Owner
address:
type: object
required:
- country
- address1
- locality
- administrativeArea
- postalCode
properties:
country:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country where the owner resides. Two character country code.
address1:
type: string
minLength: 1
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Owner's street address.
address2:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Owner's street address Continued
buildingName:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Building Name
locality:
type: string
minLength: 1
maxLength: 50
pattern: ^[0-9a-zA-Z _\-\u00A1-\uFFFF]+$
description: Owner's city
administrativeArea:
type: string
minLength: 1
maxLength: 50
description: Owner's state (US) or province (Canada, others)
postalCode:
type: string
minLength: 1
maxLength: 20
description: Owner's zip code (US) or postal code (Canada)
directorInformation:
type: array
items:
type: object
properties:
firstName:
type: string
maxLength: 50
description: Director's first name
middleName:
type: string
maxLength: 50
description: Director's middle name
lastName:
type: string
maxLength: 50
description: Director's last name
birthDate:
type: string
format: date
description: 'Director''s date of birth. Format: YYYY-MM-DD Example 2016-08-11 equals August 11, 2016'
email:
type: string
maxLength: 100
description: Email address for Director
phoneNumber:
type: string
maxLength: 20
pattern: ^[0-9a-zA-Z\\+\\-]+$
description: Owner's phone number
nationality:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country of origin for the owner. Two character country code, ISO 3166-1 alpha-2.
nationalId:
type: string
maxLength: 15
description: Identification value from ID document
idCountry:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country of the ID document. Two character country code, ISO 3166-1 alpha-2.
passportNumber:
type: string
maxLength: 12
description: Passport Number
address:
type: object
properties:
country:
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
description: Country where the Director resides. Two character country code.
address1:
type: string
minLength: 1
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Director's street address.
address2:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Director's street address Continued
buildingName:
type: string
maxLength: 60
pattern: ^[0-9a-zA-Z _\-\#\u00A1-\uFFFF]+$
description: Building Name
locality:
type: string
minLength: 1
maxLength: 50
pattern: ^[0-9a-zA-Z _\-\u00A1-\uFFFF]+$
description: Director's city
administrativeArea:
type: string
minLength: 1
maxLength: 50
pattern: ^[0-9a-zA-Z _\-\u00A1-\uFFFF]+$
description: Director's state (US) or province (Canada, others)
postalCode:
type: string
minLength: 1
maxLength: 20
description: Director's zip code (US) or postal code (Canada)
deviceInformation:
type: object
properties:
ipAddress:
description: IP Address of the user that filled in the Merchant Application
type: string
fingerprintSessionId:
description: Info about the user that filled in the Merchant Application
type: string
userAgent:
description: Info about the user that filled in the Merchant Application
type: string
depositInformation:
type: object
properties:
bankAccountCountry:
description: Country of the Bank Account. Two character country code, ISO 3166-1 alpha-2.
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
example: US
accountHolderName:
description: Name on the Bank Account
type: string
maxLength: 150
example: Sarah Jane Smith
accountType:
description: 'Type of Account
Possible Values:
- CHECKING
- SAVINGS
- CORPORATECHECKING
- CORPORATESAVINGS
'
type: string
example: CORPORATECHECKING
accountRoutingNumber:
description: Routing Number, IBAN, Swift/BIC, etc
type: string
pattern: ^[0-9a-zA-Z\+\-]+$
maxLength: 15
example: 111111111111111
accountNumber:
description: Account Number
type: string
pattern: ^[0-9a-zA-Z\+\-]+$
maxLength: 17
example: 111111111111110
billingInformation:
type: object
properties:
bankAccountInformation:
type: object
properties:
bankAccountCountry:
description: Country of the Bank Account. Two character country code, ISO 3166-1 alpha-2.
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]*$
example: US
accountHolderName:
description: Name on the checking account
type: string
maxLength: 150
example: Sarah Jane Smith
accountType:
description: 'Type of Account
Possible Values:
- CHECKING
- SAVINGS
- CORPORATECHECKING
- CORPORATESAVINGS
'
type: string
example: CORPORATECHECKING
accountRoutingNumber:
description: Routing Number, IBAN, Swift/BIC, etc
type: string
maxLength: 15
pattern: ^[0-9a-zA-Z\+\-]+$
example: 111111111111111
accountNumber:
description: Account Number
type: string
maxLength: 17
pattern: ^[0-9a-zA-Z\+\-]+$
example: 111111111111110
saleRepresentativeInformation:
type: object
required:
- salesRepId
- salesRepFirstName
- salesRepLastName
- salesRepEmail
- salesRepNumericPhoneNumberCountryCode
- salesRepPhoneNumber
properties:
salesRepId:
description: Sales rep Identifier
type: string
maxLength: 60
salesRepFirstName:
description: Sales rep First Name
type: string
maxLength: 50
example: John
salesRepLastName:
description: Sales Rep Last Name
type: string
maxLength: 50
example: Johnson
salesRepEmail:
description: Sales Rep eMail
type: string
maxLength: 100
example: test@test.com
salesRepNumericPhoneNumberCountryCode:
description: Sales Rep Phone Number Country. Two character country code, ISO 3166-1 alpha-2.
type: string
minLength: 2
maxLength: 2
example: US
salesRepPhoneNumber:
description: Sales Rep Phone
type: string
maxLength: 20
example: 4567890398
fileAttachmentInformation:
type: object
properties:
fileGroupId:
description: The unique identifier for the file group
type: string
additionalConfigurations:
type: array
maxItems: 10
description: 'Additional configurations for the payment method. This can include various settings specific to the payment method.
'
items:
type: object
description: 'Additional configuration for the payment method.
'
properties:
key:
type: string
description: 'Key for the additional configuration. This is used to identify the specific setting.
example: serviceProviderId
'
value:
type: string
description: 'Value for the additional configuration. This is the actual setting being configured.
example: svcId
'
cardPresentConnect:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- NOT_SELF_SERVICEABLE"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
properties:
partnerSolutionIdentifier:
type: string
description: Solution identifier used to associate a partner organization with the Merchant that is on-boarded.
cybsReadyTerminal:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- NOT_SELF_SERVICEABLE"
eCheck:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
mode:
type: array
items:
type: string
description: Indicates what mode the product is expected to behave at boarding and transaction flows. Ex, Acquirer/Gateway/Other.
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
title: ECheckConfig
properties:
common:
type: object
properties:
processors:
type: object
additionalProperties:
type: object
description: Payment Processing connection used to support eCheck, aka ACH, payment methods. Example - "bofaach"
properties:
companyEntryDescription:
type: string
maxLength: 10
description: '*EXISTING* Company (merchant) defined description of entry to receive. For e.g. PAYROLL, GAS BILL, INS PREM. This field is alphanumeric'
companyId:
type: string
maxLength: 10
description: '*EXISTING* company ID assigned to merchant by Acquiring bank. This field is alphanumeric'
batchGroup:
type: string
description: '*EXISTING* Capture requests are grouped into a batch bound for your payment processor. The batch time can be identified by reading the last 2-digits as military time. E.g., _16 = your processing cutoff is 4PM PST. Please note if you are in a different location you may then need to convert time zone as well.'
enableAccuityForAvs:
type: boolean
default: true
description: '*NEW* Accuity is the original validation service that checks the account/routing number for formatting issues. Used by WF and set to "Yes" unless told otherwise'
accuityCheckType:
type: string
default: ALWAYS
description: "*NEW* \nPossible values:\n- ALWAYS"
setCompletedState:
type: boolean
default: false
description: '*Moved* When set to Yes we will automatically update transactions to a completed status X-number of days after the transaction comes through; if no failure notification is received. When set to No means we will not update transaction status in this manner. For BAMS/Bank of America merchants, they should be set to No unless we are explicitly asked to set a merchant to YES.'
required:
- companyEntryDescription
internalOnly:
type: object
properties:
displayEcheckInfo:
type: boolean
default: true
description: '*NEW* Used by EBC UI always set to true'
processors:
type: object
description: '*NEW* Payment Processing connection used to support eCheck, aka ACH, payment methods.
Example
* "bofaach"
* "wellsfargoach"
'
additionalProperties:
x-devcenter-additional-properties:
- bofaach
- wellsfargoach
type: object
description: Name of the payment processor. Example - "wellsfargoach"
properties:
enableCCS:
type: boolean
description: '*NEW* Flag to indicate whether the processor is migrated to the Common Connectivity Services Platform.
Applicable for VPC and amexdirect processors.
'
terminalId:
type: string
description: '*NEW* The ''Terminal Id'' aka TID, is an identifier used for with your payments processor.
Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions.
Applicable for VPC processors.
'
enable15anTransactionReferenceNumber:
type: boolean
default: true
description: '*NEW* This ensures the transaction reference # contains an identifier that can be viewed in CYBS'
portalSupportedPaytypes:
type: string
default: CHECK
description: '*NEW* This is used by the EBC2 application'
settlementMethod:
type: string
default: BEST_GUESS
description: "*NEW* \nPossible values:\n- BEST_GUESS"
verificationLevel:
type: string
default: VALIDATION
description: "*NEW* \nPossible values:\n- VALIDATION"
setCompletedState:
type: boolean
default: false
description: '*Moved* When set to Yes we will automatically update transactions to a completed status X-number of days after the transaction comes through; if no failure notification is received. When set to No means we will not update transaction status in this manner. For BAMS/Bank of America merchants, they should be set to No unless we are explicitly asked to set a merchant to YES.'
accountHolderName:
type: string
maxLength: 22
description: "Mandatory \nName on Merchant's Bank Account\nOnly ASCII (Hex 20 to Hex 7E)\n"
accountType:
type: string
description: "Mandatory \nType of account for Merchant's Bank Account\nPossible values:\n- checking\n- savings\n- corporatechecking\n- corporatesavings\n"
accountRoutingNumber:
type: string
maxLength: 9
description: "Mandatory \nRouting number for Merchant's Bank Account\nUS Account Routing Number\n"
accountNumber:
type: string
maxLength: 17
description: "Mandatory \nAccount number for Merchant's Bank Account\n"
required:
- accountHolderName
- accountType
- accountRoutingNumber
- accountNumber
underwriting:
type: object
properties:
standardEntryClassCodes:
type: string
default: CCD,PPD,TEL,WEB
description: "Mandatory \nFree-text (csv) \nPossible values (combination):\n\nCCD — Cash Concentration or Disbursement, or CCD, is a charge or refund against a business checking account. One-time or recurring CCD transactions are fund transfers to or from a corporate entity. A standing authorization is required for recurring transactions.\nPPD — Prearranged Payment and Deposit Entry, or PPD, is a charge or refund against a customer's checking or savings account. PPD entries can only be originated when payment and deposit terms between the merchant and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions.\nTEL — Telephone-Initiated Entry, or TEL, is a one-time charge against a customer's checking or savings account. TEL transactions can only be originated when a business relationship between the merchant and the customer already exists; or if a relationship does not exist, then only when the customer initiates the telephone call to the merchant. Payment authorization is obtained from the customer by telephone.\nWEB — Internet-Initiated Entry or WEB is a charge against a customer's checking or savings account. One-time or recurring WEB transactions are originated through the Internet. Payment authorization is also obtained from the customer through the Internet.\n"
enableHold:
type: boolean
default: true
description: "Mandatory \nDetermines whether CYBS has placed the merchant on a funding hold\nThis will often be set to True for new merchants until the risk team has completed additional verification of their first transaction. It will be switched to \"false\" once underwriting review is completed and we are ready to start funding the merchant.\n"
monthlyTotalTransactionAmountLimit:
type: number
format: currency
description: "Mandatory \nMonthly Maximum total Transaction Amount\n12 digit including decimal\n"
holdingDays:
type: number
format: integer
default: 7
description: "Mandatory \nFunds Hold Days (Number of days funds will be held before it will be deposited into merchant account)\n3 digits\n"
enableCredits:
type: boolean
description: "Optional \nAllow Credits (True/False)\n"
transactionAmountLimit:
type: number
format: currency
description: "Mandatory \nMaximum total Transaction Amount\nThis is a per transaction limit. For example, the merchant is limited to processing transactions under $100\n12 digits (including decimal - USD only)\n"
riskReserveMethod:
type: string
description: "Mandatory\nReserve Method \nPossible value:\n- fixed\n- none\nMost merchants do not have a reserve attached to their account so the default value would be \"none.\" \n\nFor a Fixed Reserve, the reserve balance is established by either, (1) a receipt of a lump\nsum deposit from a merchant, or (2) withholding funds at a Reserve Rate established for\nthe account from each batch settlement until the reserve balance is equal to a set\nReserve Target. A Fixed Reserve may also be established by a combination of lump\nsum deposit and withholding of settlement funds.\n\nA Rolling Reserve balance is established by withholding from a merchant's available\nsettlement funds at a Reserve Rate (percentage) and no Reserve Target is specified.\nRather, each amount withheld is retained for a specified number of Reserve Holding\nDays and then released back to the merchant.\n"
riskReserveRate:
type: number
format: decimal
description: "Mandatory \nReserve Rate (% of TPV)=> Relevant for Rolling Reserve and Fixed Reserve\nThe percentage rate at which risk funds are withheld from each\neCheck.Net batch settlement.\n"
riskReserveTargetAmount:
type: number
format: currency
description: "Mandatory \nReserve Target (fixed $ amount)=> Relevant for Fixed Reserve ONLY\n\nThe maximum dollar amount that can be held in Risk Reserve for a\nfixed reserve. Once risk withholdings reach the Reserve Target established for the\neCheck.Net account, a portion of available funds will be deposited to the merchant's\nbank account\n12 digit including decimal\n"
solutionOrganizationId:
type: string
description: Solution organization id
required:
- standardEntryClassCodes
- enableHold
- monthlyTotalTransactionAmountLimit
- holdingDays
- transactionAmountLimit
- riskReserveMethod
- riskReserveRate
- riskReserveTargetAmount
features:
type: object
properties:
accountValidationService:
type: object
properties:
internalOnly:
type: object
properties:
processors:
type: object
description: '*NEW* Payment Processing connection used to support eCheck, aka ACH, payment methods.
Example
* "bofaach"
* "wellsfargoach"
'
additionalProperties:
x-devcenter-additional-properties:
- bofaach
- wellsfargoach
type: object
description: Name of the payment processor. Example - "wellsfargoach"
properties:
avsVersion:
type: string
default: '2'
description: "*NEW* \nPossible values:\n- 2"
processors:
type: object
description: '*NEW* Payment Processing connection used to support eCheck, aka ACH, payment methods.
Example
* "bofaach"
* "wellsfargoach"
'
additionalProperties:
type: object
description: '*NEW* Name of the payment processor. Example - "wellsfargoach"'
properties:
avsAccountOwnershipService:
type: boolean
description: '*NEW* Determined in WF eTicket if account has opted into the Account Ownership Service.'
avsAccountStatusService:
type: boolean
description: '*NEW* Determined in WF eTicket if account has opted into the Account Status Service.'
avsSignedAgreement:
type: boolean
description: '*NEW* Taken from Addendum Agreement Column in boarding form.'
avsCalculatedResponseBehavior:
type: string
default: continue
description: "*NEW* \nPossible values:\n- continue"
avsAdditionalId:
type: string
description: '*NEW* Also known as the Additional ID. Taken from the boarding form.'
enableAvs:
type: boolean
default: true
description: '*NEW*'
avsEntityId:
type: string
description: '*NEW* Also known as the AVS Gateway Entity ID.'
avsResultMode:
type: string
description: "*NEW* \nPossible values:\n- FULL_RESPONSE\n- LOGIC_BOX"
enableAvsTokenCreation:
type: boolean
default: false
description: '*NEW* Applicable if the merchant wants to run AVS on token creation requests only.'
payerAuthentication:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
title: PayerAuthConfig
properties:
cardTypes:
type: object
properties:
verifiedByVisa:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
masterCardSecureCode:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
amexSafeKey:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
jCBJSecure:
type: object
properties:
securePasswordForJCB:
type: string
minLength: 8
maxLength: 8
description: JSecure currency password for Japan Credit Bureau
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
dinersClubInternationalProtectBuy:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
ELO:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
UPI:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
CB:
type: object
properties:
requestorId:
type: string
minLength: 14
maxLength: 14
description: The value is for 3DS2.0 and is a Directory Server assigned 3DS Requestor ID value. If this field is passed in request, it will override Requestor Id value that is configured on the Merchant's profile.
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
digitalPayments:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
features:
type: object
description: "Allowed values are;\n\n \n | visaCheckout | \n
\n \n | applePay | \n
\n \n | samsungPay | \n
\n \n | googlePay | \n
\n
\n"
additionalProperties:
x-devcenter-additional-properties:
- visaCheckout
- applePay
- samsungPay
- googlePay
type: object
properties:
enabled:
type: boolean
secureAcceptance:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
title: SAConfig
properties:
parentProfileId:
type: string
description: You can group Secure Acceptance profiles under parent profiles. By changing the parent profile, you can update all profiles underneath that parent. Specify the Parent Profile ID here.
contactInformation:
type: object
description: Optional contact information to be associated with the Secure Acceptance profile - for example the developer of the integration to the Hosted Checkout.
properties:
phone:
type: string
companyName:
type: string
email:
type: string
name:
type: string
notifications:
type: object
properties:
merchantNotifications:
type: object
properties:
backofficePostEnabled:
type: boolean
description: Enables Webhook transaction confirmation messages sent to URL defined in backofficePostUrl. Usually enabled by web developers integrating to Secure Acceptance.
backofficeEmailAddress:
type: string
description: Email address to receive transaction confirmation messages.
backofficeEmailEnabled:
type: boolean
description: Enables email transaction confirmation messages, sent to the address specified in backofficeEmailAddress.
backofficePostUrl:
type: string
description: Webhook URL to which transaction confirmation is sent. Usually completed by the web developers integrating to Secure Acceptance.
cardNumberFormat:
type: string
description: "Format in which the card number should be masked in the notifications. \n\nValid values:\n`1` - Display first 6 digits only (e.g. \"444433**********\")\n\n`2` - Display last four digits only (e.g. \"************1111\")\n\n`3` - Display First six and last four digits (e.g. \"444433******1111\")\n"
customerNotifications:
type: object
description: Features relating to notifications being sent directly to the payer using the Hosted Checkout.
properties:
customReceiptPageEnabled:
type: boolean
description: Toggles the custom receipt page, where merchants can receive the results of the transaction and display appropriate messaging. Usually set by web developers integrating to Secure Acceptance.
receiptEmailAddress:
type: string
description: Email address where a copy of the payer's receipt email is sent, when notificationReceiptEmailEnabled is true.
customerReceiptEmailEnabled:
type: boolean
description: Toggles an email receipt sent to the payer's email address on payment success.
customCancelPage:
type: string
description: URL to which transaction results are POSTed when the payer clicks 'Cancel' on the Hosted Checkout. Triggered when customCancelPageEnabled is true. Usually set by web developers integrating to Secure Acceptance.
customReceiptPage:
type: string
description: URL to which transaction results are POSTed when the payer requests a payment on the Hosted Checkout. Triggered when customCancelPageEnabled is true. Usually set by web developers integrating to Secure Acceptance.
customCancelPageEnabled:
type: boolean
description: Toggles the custom cancel page, where merchants can receive notice that the payer has canceled, and display appropriate messaging and direction. Usually set by web developers integrating to Secure Acceptance.
notificationReceiptEmailEnabled:
type: boolean
description: Toggles whether merchant receives a copy of the payer's receipt email.
service:
type: object
properties:
decisionManagerVerboseEnabled:
type: boolean
description: Toggles whether verbose Decision Manager results should be present in the Secure Acceptance response. As this response passes through the browser, it is recommended to set this to "false" outside of debugging.
declinedRetryLimit:
type: number
description: Defines the number of retries a payer is presented with on payment declines on Hosted Checkout. Valid values are between 0 and 5.
decisionManagerEnabled:
type: boolean
description: Toggles whether Decision Manager is enabled or not for Secure Acceptance transactions. Requires the transacting MID to be enabled and configured for Decicion Manager.
tokenizationEnabled:
type: boolean
description: Toggles whether Tokenization is enabled or not for Secure Acceptance transactions. Requires the transacting MID to be enabled and configured for Tokenization.
reverseAuthOnAddressVerificationSystemFailure:
type: boolean
description: Toggles whether or not an approved Authorization that fails AVS should be automatically reversed.
deviceFingerprintEnabled:
type: boolean
description: Toggles whether or not fraud Device Fingerprinting is enabled on the Hosted Checkout. This simplifies enablement for Decision Manager.
reverseAuthOnCardVerificationNumberFailure:
type: boolean
description: Toggles whether or not an approved Authorization that fails CVN check that should be automatically reversed.
paymentMethods:
type: object
properties:
enabledPaymentMethods:
type: array
items:
type: string
description: 'Possible values:
- CARD
- ECHECK
- VISACHECKOUT
- PAYPAL'
checkout:
type: object
properties:
displayTaxAmount:
type: boolean
description: Toggles whether or not the tax amount is displayed on the Hosted Checkout.
templateType:
type: string
description: "Specifies whether the Hosted Checkout is displayed as a single page form or multi page checkout. \n\nValid values: \n`multi` \n`single`\n"
returnToMerchantSiteUrl:
type: string
description: URL of the website linked to from the Secure Acceptance receipt page. Only used if the profile does not have custom receipt pages configured.
paymentTypes:
type: object
description: Object containing Payment Types supported
properties:
cardTypes:
type: object
properties:
discover:
type: object
description: Object containing supported Card Types and settings
properties:
cardVerificationNumberSupported:
type: boolean
description: Dictates whether or Card Verification Number is supported by the card type. Usually this is set at system level.
cardVerificationNumberDisplay:
type: boolean
description: Toggles whether or Card Verification Number is displayed on the Hosted Checkout.
payerAuthenticationSupported:
type: boolean
description: Dictates whether or Payer Authentication is supported by the card type. Usually this is set at system level.
supportedCurrencies:
type: array
description: Array of the supported ISO 4217 alphabetic currency codes.
items:
type: string
method:
type: string
cardVerificationNumberRequired:
type: boolean
payerAuthenticationEnabled:
type: boolean
amex:
type: object
description: Object containing supported Card Types and settings
properties:
cardVerificationNumberSupported:
type: boolean
description: Dictates whether or Card Verification Number is supported by the card type. Usually this is set at system level.
cardVerificationNumberDisplay:
type: boolean
description: Toggles whether or Card Verification Number is displayed on the Hosted Checkout.
payerAuthenticationSupported:
type: boolean
description: Dictates whether or Payer Authentication is supported by the card type. Usually this is set at system level.
supportedCurrencies:
type: array
description: Array of the supported ISO 4217 alphabetic currency codes.
items:
type: string
method:
type: string
cardVerificationNumberRequired:
type: boolean
payerAuthenticationEnabled:
type: boolean
masterCard:
type: object
description: Object containing supported Card Types and settings
properties:
cardVerificationNumberSupported:
type: boolean
description: Dictates whether or Card Verification Number is supported by the card type. Usually this is set at system level.
cardVerificationNumberDisplay:
type: boolean
description: Toggles whether or Card Verification Number is displayed on the Hosted Checkout.
payerAuthenticationSupported:
type: boolean
description: Dictates whether or Payer Authentication is supported by the card type. Usually this is set at system level.
supportedCurrencies:
type: array
description: Array of the supported ISO 4217 alphabetic currency codes.
items:
type: string
method:
type: string
cardVerificationNumberRequired:
type: boolean
payerAuthenticationEnabled:
type: boolean
visa:
type: object
description: Object containing supported Card Types and settings
properties:
cardVerificationNumberSupported:
type: boolean
description: Dictates whether or Card Verification Number is supported by the card type. Usually this is set at system level.
cardVerificationNumberDisplay:
type: boolean
description: Toggles whether or Card Verification Number is displayed on the Hosted Checkout.
payerAuthenticationSupported:
type: boolean
description: Dictates whether or Payer Authentication is supported by the card type. Usually this is set at system level.
supportedCurrencies:
type: array
description: Array of the supported ISO 4217 alphabetic currency codes.
items:
type: string
method:
type: string
cardVerificationNumberRequired:
type: boolean
payerAuthenticationEnabled:
type: boolean
virtualTerminal:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
title: VTConfig
properties:
cardNotPresent:
type: object
properties:
globalPaymentInformation:
type: object
properties:
basicInformation:
type: object
properties:
defaultStandardEntryClassCode:
type: string
defaultCountryCode:
type: string
description: ISO 4217 format
defaultCurrencyCode:
type: string
description: Three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
defaultTransactionType:
type: string
description: 'Possible values:
- AUTHORIZATION
- SALE'
defaultPaymentType:
type: string
description: 'Possible values:
- CREDIT_CARD
- ECHECK'
defaultTransactionSource:
type: string
displayRetail:
type: boolean
displayMoto:
type: boolean
displayInternet:
type: boolean
paymentInformation:
type: object
properties:
displayCardVerificationValue:
type: array
items:
type: string
description: 'Possible values:
- VISA
- MASTER_CARD
- AMEX
- DISCOVER
- DINERS_CLUB
- CARTE_BLANCHE
- JCB
- ENROUTE
- JAL
- SWITCH_SOLO
- DELTA
- VISA_ELECTRON
- DANKORT
- LASER
- CARTE_SBANCAIRES
- CARTASI
- MAESTRO_INTERNATIONAL
- GE_MONEY_UK_CARD
- HIPER_CARD
- ELO'
requireCardVerificationValue:
type: array
items:
type: string
description: 'Possible values:
- VISA
- MASTER_CARD
- AMEX
- DISCOVER
- DINERS_CLUB
- CARTE_BLANCHE
- JCB
- ENROUTE
- JAL
- SWITCH_SOLO
- DELTA
- VISA_ELECTRON
- DANKORT
- LASER
- CARTE_SBANCAIRES
- CARTASI
- MAESTRO_INTERNATIONAL
- GE_MONEY_UK_CARD
- HIPER_CARD
- ELO'
acceptedCardTypes:
type: array
items:
type: string
description: 'Possible values:
- VISA
- MASTER_CARD
- AMEX
- DISCOVER
- DINERS_CLUB
- CARTE_BLANCHE
- JCB
- ENROUTE
- JAL
- SWITCH_SOLO
- DELTA
- VISA_ELECTRON
- DANKORT
- LASER
- CARTE_SBANCAIRES
- CARTASI
- MAESTRO_INTERNATIONAL
- GE_MONEY_UK_CARD
- HIPER_CARD
- ELO'
displayCreditCards:
type: boolean
displayEchecks:
type: boolean
displayDebtIndicator:
type: boolean
displayBillPayment:
type: boolean
enableEchecks:
type: boolean
displayIgnoreECheckAvsCheckbox:
type: boolean
firstNameRequired:
type: boolean
lastNameRequired:
type: boolean
displayFirstName:
type: boolean
displayLastName:
type: boolean
merchantDefinedDataFields:
type: object
properties:
displayMerchantDefinedData1:
type: boolean
displayMerchantDefinedData2:
type: boolean
displayMerchantDefinedData3:
type: boolean
displayMerchantDefinedData4:
type: boolean
displayMerchantDefinedData5:
type: boolean
merchantDefinedData1DefaultValue:
type: string
merchantDefinedData1Label:
type: string
requireMerchantDefinedData1:
type: boolean
merchantDefinedData2DefaultValue:
type: string
merchantDefinedData2Label:
type: string
requireMerchantDefinedData2:
type: boolean
merchantDefinedData3DefaultValue:
type: string
merchantDefinedData3Label:
type: string
requireMerchantDefinedData3:
type: boolean
merchantDefinedData4DefaultValue:
type: string
merchantDefinedData4Label:
type: string
requireMerchantDefinedData4:
type: boolean
merchantDefinedData5DefaultValue:
type: string
merchantDefinedData5Label:
type: string
requireMerchantDefinedData5:
type: boolean
merchantDefinedData1DisplayOnReceipt:
type: boolean
merchantDefinedData2DisplayOnReceipt:
type: boolean
merchantDefinedData3DisplayOnReceipt:
type: boolean
merchantDefinedData4DisplayOnReceipt:
type: boolean
merchantDefinedData5DisplayOnReceipt:
type: boolean
receiptInformation:
type: object
properties:
header:
type: object
properties:
virtualTerminalReceiptHeader:
type: string
orderInformation:
type: object
properties:
emailAliasName:
type: string
customReplyToEmailAddress:
type: string
emailReceipt:
type: object
properties:
sendersEmailAddress:
type: string
cardPresent:
type: object
properties:
globalPaymentInformation:
type: object
properties:
basicInformation:
type: object
properties:
defaultStandardEntryClassCode:
type: string
defaultCountryCode:
type: string
description: ISO 4217 format
defaultCurrencyCode:
type: string
description: Three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
defaultTransactionType:
type: string
description: 'Possible values:
- AUTHORIZATION
- SALE'
defaultPaymentType:
type: string
description: 'Possible values:
- CREDIT_CARD
- ECHECK'
defaultTransactionSource:
type: string
displayRetail:
type: boolean
displayMoto:
type: boolean
displayInternet:
type: boolean
paymentInformation:
type: object
properties:
displayCardVerificationValue:
type: array
items:
type: string
description: 'Possible values:
- VISA
- MASTER_CARD
- AMEX
- DISCOVER
- DINERS_CLUB
- CARTE_BLANCHE
- JCB
- ENROUTE
- JAL
- SWITCH_SOLO
- DELTA
- VISA_ELECTRON
- DANKORT
- LASER
- CARTE_SBANCAIRES
- CARTASI
- MAESTRO_INTERNATIONAL
- GE_MONEY_UK_CARD
- HIPER_CARD
- ELO'
requireCardVerificationValue:
type: array
items:
type: string
description: 'Possible values:
- VISA
- MASTER_CARD
- AMEX
- DISCOVER
- DINERS_CLUB
- CARTE_BLANCHE
- JCB
- ENROUTE
- JAL
- SWITCH_SOLO
- DELTA
- VISA_ELECTRON
- DANKORT
- LASER
- CARTE_SBANCAIRES
- CARTASI
- MAESTRO_INTERNATIONAL
- GE_MONEY_UK_CARD
- HIPER_CARD
- ELO'
acceptedCardTypes:
type: array
items:
type: string
description: 'Possible values:
- VISA
- MASTER_CARD
- AMEX
- DISCOVER
- DINERS_CLUB
- CARTE_BLANCHE
- JCB
- ENROUTE
- JAL
- SWITCH_SOLO
- DELTA
- VISA_ELECTRON
- DANKORT
- LASER
- CARTE_SBANCAIRES
- CARTASI
- MAESTRO_INTERNATIONAL
- GE_MONEY_UK_CARD
- HIPER_CARD
- ELO'
displayCreditCards:
type: boolean
displayEchecks:
type: boolean
displayDebtIndicator:
type: boolean
displayBillPayment:
type: boolean
enableEchecks:
type: boolean
displayIgnoreECheckAvsCheckbox:
type: boolean
firstNameRequired:
type: boolean
lastNameRequired:
type: boolean
displayFirstName:
type: boolean
displayLastName:
type: boolean
merchantDefinedDataFields:
type: object
properties:
displayMerchantDefinedData1:
type: boolean
displayMerchantDefinedData2:
type: boolean
displayMerchantDefinedData3:
type: boolean
displayMerchantDefinedData4:
type: boolean
displayMerchantDefinedData5:
type: boolean
merchantDefinedData1DefaultValue:
type: string
merchantDefinedData1Label:
type: string
requireMerchantDefinedData1:
type: boolean
merchantDefinedData2DefaultValue:
type: string
merchantDefinedData2Label:
type: string
requireMerchantDefinedData2:
type: boolean
merchantDefinedData3DefaultValue:
type: string
merchantDefinedData3Label:
type: string
requireMerchantDefinedData3:
type: boolean
merchantDefinedData4DefaultValue:
type: string
merchantDefinedData4Label:
type: string
requireMerchantDefinedData4:
type: boolean
merchantDefinedData5DefaultValue:
type: string
merchantDefinedData5Label:
type: string
requireMerchantDefinedData5:
type: boolean
merchantDefinedData1DisplayOnReceipt:
type: boolean
merchantDefinedData2DisplayOnReceipt:
type: boolean
merchantDefinedData3DisplayOnReceipt:
type: boolean
merchantDefinedData4DisplayOnReceipt:
type: boolean
merchantDefinedData5DisplayOnReceipt:
type: boolean
receiptInformation:
type: object
properties:
header:
type: object
properties:
virtualTerminalReceiptHeader:
type: string
orderInformation:
type: object
properties:
emailAliasName:
type: string
customReplyToEmailAddress:
type: string
emailReceipt:
type: object
properties:
sendersEmailAddress:
type: string
currencyConversion:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
properties:
processors:
type: object
additionalProperties:
x-devcenter-additional-properties:
- six
- cmcic
- fdiglobal
- fdcsouth
type: object
properties:
provider:
type: string
description: The name of the provider.
merchantId:
type: string
description: A unique identifier value assigned to each merchant. Assigned by the provider.
acquirerId:
type: string
description: This code identifies the financial institution acting as the acquirer.
tax:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
customerInvoicing:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
recurringBilling:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
paymentOrchestration:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
payouts:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
configurations:
type: object
properties:
common:
type: object
properties:
paymentTypes:
type: array
description: 'List of card types supported by this merchant.
'
items:
type: string
minLength: 1
maxLength: 30
description: 'Possible values:
- VISA
- MASTERCARD'
businessApplicationId:
type: array
description: 'List of supported Business Application Indicators.
'
items:
type: string
minLength: 2
maxLength: 2
description: 'Possible values:
- AA
- BB
- BI
- BP
- CB
- CD
- CI
- CO
- CP
- FD
- FT
- GD
- GP
- LA
- LO
- MD
- MI
- MP
- OG
- PD
- PG
- PP
- PS
- RP
- TU
- WT'
defaultBusinessApplicationId:
type: string
minLength: 2
maxLength: 2
description: "Default Business Application Indicator. Must match one of the values in businessApplicationId array.\n \nPossible values:\n- AA\n- BB\n- BI\n- BP\n- CB\n- CD\n- CI\n- CO\n- CP\n- FD\n- FT\n- GD\n- GP\n- LA\n- LO\n- MD\n- MI\n- MP\n- OG\n- PD\n- PG\n- PP\n- PS\n- RP\n- TU\n- WT"
aggregator:
type: object
properties:
id:
type: string
pattern: ^[a-zA-Z0-9_]+$
minLength: 1
maxLength: 11
description: Marketplace or payment facilitator ID.
name:
type: string
pattern: ^[A-Za-z0-9!@#$%^&*(),.?":{}|<>]+$
minLength: 1
maxLength: 25
description: Acceptor's legal business name associated with the card acceptor identification code.
subMerchantId:
type: string
pattern: ^[a-zA-Z0-9_]+$
minLength: 1
maxLength: 15
description: Sub-merchant ID
processors:
type: object
additionalProperties:
description: 'string [1 .. 40] characters
The name of the Payouts processor.
'
pattern: ^[A-Za-z0-9]+$
allOf:
- type: object
properties:
enabled:
type: boolean
description: 'Indicates if the payment route is enabled. Allows the acquirer to enable/disable processing based on the config setting but to retain the configuration profile.
'
acquirer:
type: object
properties:
acquiringId:
type: string
pattern: ^\d+$
minLength: 6
maxLength: 11
description: 'This code identifies the financial institution acting as the acquirer.
Also known as:
- Acquiring BIN
- Acquiring Institution Identification Code
'
country:
type: string
description: "The acquirer's [ISO 3166-1](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html) alpha-2 country code. \nPossible values:\n- US\n- AF\n- AX\n- AL\n- DZ\n- AD\n- AO\n- AI\n- AQ\n- AG\n- AR\n- AM\n- AW\n- AU\n- AS\n- AT\n- AZ\n- BS\n- BH\n- BD\n- BB\n- BY\n- BE\n- BZ\n- BJ\n- BM\n- BT\n- BO\n- BA\n- BQ\n- BW\n- BV\n- BR\n- IO\n- VG\n- BN\n- BG\n- BF\n- BI\n- KH\n- CM\n- CA\n- CV\n- CW\n- KY\n- CF\n- TD\n- CL\n- CN\n- CX\n- CC\n- CO\n- KM\n- CD\n- CG\n- CK\n- CR\n- CI\n- HR\n- CU\n- CY\n- CZ\n- DK\n- DJ\n- DM\n- DO\n- EC\n- EG\n- SV\n- GQ\n- ER\n- EE\n- ET\n- FK\n- FO\n- FJ\n- FI\n- FR\n- GF\n- PF\n- TF\n- GA\n- GM\n- GE\n- DE\n- GH\n- GI\n- GR\n- GL\n- GD\n- GP\n- GU\n- GT\n- GG\n- GN\n- GW\n- GY\n- HT\n- HM\n- HN\n- HK\n- HU\n- IS\n- IN\n- ID\n- IR\n- IQ\n- IE\n- IM\n- IL\n- IT\n- JM\n- JP\n- JE\n- JO\n- KZ\n- KE\n- KI\n- KW\n- KG\n- LA\n- LV\n- LB\n- LS\n- LR\n- LY\n- LI\n- LT\n- LU\n- MO\n- MK\n- MG\n- MW\n- MY\n- MV\n- ML\n- MT\n- MH\n- MQ\n- MR\n- MU\n- YT\n- MX\n- FM\n- MD\n- MC\n- MN\n- ME\n- MS\n- MA\n- MZ\n- MM\n- NA\n- NR\n- NP\n- NL\n- AN\n- NC\n- NZ\n- NI\n- NE\n- NG\n- NU\n- NF\n- KP\n- MP\n- NO\n- OM\n- PK\n- PW\n- PS\n- PA\n- PG\n- PY\n- PE\n- PH\n- PN\n- PL\n- PT\n- PR\n- QA\n- RE\n- RO\n- RU\n- RW\n- BL\n- SH\n- KN\n- LC\n- MF\n- PM\n- VC\n- WS\n- SM\n- SS\n- ST\n- SX\n- SA\n- SN\n- RS\n- SC\n- SL\n- SG\n- SK\n- SI\n- SB\n- SO\n- ZA\n- GS\n- KR\n- ES\n- LK\n- SD\n- SR\n- SJ\n- SZ\n- SE\n- CH\n- SY\n- TW\n- TJ\n- TZ\n- TH\n- TL\n- TG\n- TK\n- TO\n- TT\n- TN\n- TR\n- TM\n- TC\n- TV\n- UG\n- UA\n- AE\n- GB\n- UM\n- UY\n- UZ\n- VU\n- VA\n- VE\n- VN\n- VI\n- WF\n- KV\n- EH\n- YE\n- ZM\n- ZW"
currencies:
type: array
description: List of supported [ISO 4217](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html) alpha-3 currency codes.
items:
type: string
minLength: 3
maxLength: 3
description: 'Possible values:
- USD
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BOX
- BRL
- BSD
- BTN
- BWP
- BYR
- BYN
- BZD
- CAD
- CDF
- CHF
- CLF
- CLP
- CNY
- COP
- COU
- CRC
- CSK
- CUC
- CUP
- CVE
- CZK
- DJF
- DFF
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GWP
- GYD
- HKD
- HNL
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- HMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LRD
- LSL
- LTV
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SHP
- SLE
- SOS
- SRD
- SSP
- STD
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- UYU
- VEF
- VND
- VUV
- WST
- XAF
- XCD
- XOF
- XPF
- YER
- ZAR
- ZMK
- ZMW
- ZWD
- ZWL'
countries:
type: array
description: List of [ISO 3166-1](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html) alpha-2 country codes
items:
type: string
minLength: 2
maxLength: 2
description: 'Possible values:
- US
- AF
- AX
- AL
- DZ
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AS
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BA
- BQ
- BW
- BV
- BR
- IO
- VG
- BN
- BG
- BF
- BI
- KH
- CM
- CA
- CV
- CW
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CD
- CG
- CK
- CR
- CI
- HR
- CU
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MK
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- AN
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MP
- NO
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- SS
- ST
- SX
- SA
- SN
- RS
- SC
- SL
- SG
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- ES
- LK
- SD
- SR
- SJ
- SZ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- UY
- UZ
- VU
- VA
- VE
- VN
- VI
- WF
- KV
- EH
- YE
- ZM
- ZW'
merchantId:
type: string
pattern: ^[A-Za-z0-9!@#$%^&*(),.?":{}|<>]+$
minLength: 1
maxLength: 15
description: A unique identifier value assigned by Visa for each merchant included in the identification program.
terminalId:
type: string
pattern: ^[A-Za-z0-9!@#$%^&*(),.?":{}|<>]+$
minLength: 1
maxLength: 8
description: This field contains a code that identifies a terminal at the card acceptor location. This field is used in all messages related to a transaction. If sending transactions from a card not present environment, use the same value for all transactions.
businessCategoryValidation:
type: boolean
description: 'Default: false
Override Business Application Indicator and Merchant Category Code validations for payout transaction types.
'
payoutsTransactionTypes:
type: array
description: 'The supported Payouts transaction types for the processor.
'
items:
type: string
minLength: 19
maxLength: 20
description: 'Possible values:
- PULL_FUNDS_TRANSFER
- PUSH_FUNDS_TRANSFER'
merchantPseudoAbaNumber:
type: string
pattern: ^[A-Za-z0-9!@#$%^&*(),.?":{}|<>]+$
minLength: 9
maxLength: 9
description: 'This is a number that uniquely identifies the merchant for PPGS transactions.
'
binLookupEligibilityCheck:
type: array
description: 'List of transaction types eligible for BIN Lookup Payouts Eligibility Check.
Supports "PULL_FUNDS_TRANSFER" and "PUSH_FUNDS_TRANSFER".
'
items:
type: string
minLength: 19
maxLength: 19
description: 'Possible values:
- PULL_FUNDS_TRANSFER
- PUSH_FUNDS_TRANSFER'
- type: object
allOf:
- properties:
feeProgramId:
type: string
pattern: ^[A-Za-z0-9]+$
minLength: 3
maxLength: 3
description: 'This field identifies the interchange fee program applicable to each financial transaction. Fee program indicator (FPI) values correspond to the fee descriptor and rate for each existing fee program.
This field can be regarded as informational only in all authorization messages.
'
cpsAuthorizationCharacteristicsId:
type: string
pattern: ^[A-Za-z]+$
minLength: 1
maxLength: 1
description: The Authorization Characteristics Indicator (ACI) is a code used by the acquirer to request CPS qualification. If applicable, Visa changes the code to reflect the results of its CPS evaluation.
nationalReimbursementFee:
type: string
pattern: ^[A-Za-z0-9!@#$%^&*(),.?":{}|<>]+$
minLength: 1
maxLength: 12
description: A client-supplied interchange amount.
settlementServiceId:
type: string
description: "This flag enables the merchant to request for a particular settlement service to be used for settling the transaction. \nNote: The default value is VIP. This field is only relevant for specific countries where the acquirer has to select National Settlement in order to settle in the national net settlement service.change\n \nPossible values:\n- INTERNATIONAL_SETTLEMENT\n- VIP_TO_DECIDE\n- NATIONAL_SETTLEMENT"
sharingGroupCode:
type: string
minLength: 6
maxLength: 16
description: "This U.S.-only field is optionally used by PIN Debit Gateway Service participants (merchants and acquirers) to specify the network access priority. VisaNet checks to determine if there are issuer routing preferences for a network specified by the sharing group code. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on issuer preference. If an preference exists for multiple specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on acquirer routing priorities. \nPossible values:\n- ACCEL_EXCHANGE_E\n- CU24_C\n- INTERLINK_G\n- MAESTRO_8\n- NYCE_Y\n- NYCE_F\n- PULSE_S\n- PULSE_L\n- PULSE_H\n- STAR_N\n- STAR_W\n- STAR_Z\n- STAR_Q\n- STAR_M\n- VISA_V"
allowCryptoCurrencyPurchase:
type: boolean
description: This field allows a merchant to send a flag that specifies whether the payment is for the purchase of cryptocurrency.
merchantMvv:
type: string
pattern: ^\d+$
minLength: 10
maxLength: 10
description: Merchant Verification Value (MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant.
electronicCommerceId:
type: string
minLength: 1
maxLength: 20
description: "This code identifies the level of security used in an electronic commerce transaction over an open network (for example, the Internet). \nPossible values:\n- INTERNET\n- RECURRING\n- RECURRING_INTERNET\n- VBV_FAILURE\n- VBV_ATTEMPTED\n- VBV\n- SPA_FAILURE\n- SPA_ATTEMPTED\n- SPA"
- type: object
allOf:
- properties:
merchantDescriptor:
type: object
properties:
name:
type: string
pattern: ^[A-Za-z0-9]+$
minLength: 22
maxLength: 22
description: The merchant statement descriptor. The statement descriptor is a string which will be displayed on the recipient's bank or card statement.
operatingEnvironment:
type: string
minLength: 1
maxLength: 22
description: "Initiation channel of the transfer request. \n \nPossible values:\n- WEB\n- MOBILE\n- BANK\n- KIOSK"
interchangeRateDesignator:
type: string
pattern: ^[A-Za-z0-9]+$
minLength: 2
maxLength: 2
description: The IRD used for clearing the transaction on the Mastercard network.
partnerIdentifier:
type: string
pattern: ^[A-Za-z0-9_\-]+$
minLength: 32
maxLength: 32
description: Mastercard-assigned unique ID for registered partner. Mastercard Send Only.
differentialFee:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
features:
type: object
properties:
surcharge:
type: object
properties:
enabled:
type: boolean
payByLink:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
unifiedCheckout:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
enablementStatus:
type: string
default: ENABLED_AND_USABLE
description: 'Possible values:
- PENDING
- ENABLED_AND_USABLE
- ENABLED_NOT_USABLE
- DISABLED'
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
features:
type: object
properties:
pazeForUnifiedCheckout:
type: object
properties:
enabled:
type: boolean
description: Enabling Paze under unified checkout
tokenManagement:
type: object
properties:
enabled:
type: boolean
description: Enabling Token Management under Unified Checkout
payPal:
type: object
properties:
enabled:
type: boolean
description: Enabling PayPal under Unified Checkout
venmo:
type: object
properties:
enabled:
type: boolean
description: Enabling Venmo under Unified Checkout
applePay:
type: object
properties:
enabled:
type: boolean
description: Enabling Apple Pay under Unified Checkout
googlePay:
type: object
properties:
enabled:
type: boolean
description: Enabling Google Pay under Unified Checkout
tinkPayByBank:
type: object
properties:
enabled:
type: boolean
description: Enabling Tink Pay by Bank under Unified Checkout
eCheck:
type: object
properties:
enabled:
type: boolean
description: Enabling eCheck under Unified Checkout
p24:
type: object
properties:
enabled:
type: boolean
description: Enabling p24 under Unified Checkout
myBank:
type: object
properties:
enabled:
type: boolean
description: Enabling MyBank under Unified Checkout
konbini:
type: object
properties:
enabled:
type: boolean
description: Enabling Konbini under Unified Checkout
dragonPay:
type: object
properties:
enabled:
type: boolean
description: Enabling Dragon Pay under Unified Checkout
decisionManager:
type: object
properties:
enabled:
type: boolean
description: Enabling Decision Manager under Unified Checkout
payerAuthentication:
type: object
properties:
enabled:
type: boolean
description: Enabling Payer Authentication under Unified Checkout
afterPay:
type: object
properties:
enabled:
type: boolean
description: Enabling AfterPay under Unified Checkout
ideal:
type: object
properties:
enabled:
type: boolean
description: Enabling Ideal under Unified Checkout
multibanco:
type: object
properties:
enabled:
type: boolean
description: Enabling Multibanco under Unified Checkout
bancontact:
type: object
properties:
enabled:
type: boolean
description: Enabling Bancontact under Unified Checkout
clickToPay:
type: object
properties:
enabled:
type: boolean
description: Enabling Click to Pay under Unified Checkout
unifiedClickToPaySDK:
type: object
properties:
enabled:
type: boolean
description: Enabling Unified Click to Pay SDK under Unified Checkout
portfolioAccessofSensitiveData:
type: object
properties:
enabled:
type: boolean
description: Enabling Portfolio Access of Sensitive Data under Unified Checkout
configurationInformation:
type: object
properties:
configurations:
type: object
properties:
features:
type: object
properties:
paze:
type: object
properties:
financialInstitution:
type: string
description: "Indicates the financial institution with whom the contract has been signed \nPossible values:\n- BANKOFAMERICA\n- WELLSFARGO"
financialInstitutionContract:
type: boolean
description: Indicates if the contract has been signed with the selected bank
pazeEnabledInProfile:
type: boolean
description: Paze enabled in the profile for the merchants
description: Paze specific required configuration details under unified checkout
receivablesManager:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
serviceFee:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
configurations:
type: object
properties:
products:
type: object
description: 'Products enabled for this account. The following values are supported:
virtualTerminal
paymentTokenizationOtp
subscriptionsOtp
virtualTerminalCp
eCheck
'
additionalProperties:
type: object
properties:
serviceFeeEnabled:
type: boolean
description: Boolean flag to determine if service fee will be applied to the Product.
terminalId:
type: string
pattern: /^[a-zA-Z0-9]+$/
description: Identifier of the terminal at the retail location.
maxLength: 8
merchantId:
type: string
pattern: /^[a-zA-Z0-9]+$/
description: Identifier of a merchant account.
maxLength: 15
merchantInformation:
type: object
properties:
name:
type: string
description: Name of the merchant account.
maxLength: 25
contact:
type: string
pattern: /^\(?([0-9]{3})\)?[-. ]?([0-9]{3})[-. ]?([0-9]{4})$/
description: Phone number of the primary contact for the merchant account.
state:
type: string
description: 2-character ISO code for the U.S. state in which the merchant is registered
maxLength: 2
paymentInformation:
type: array
items:
type: object
properties:
paymentType:
type: string
description: "Payment types accepted by this merchant. The supported values are: MASTERDEBIT, MASTERCREDIT, VISACREDIT, VISADEBIT, DISCOVERCREDIT, AMEXCREDIT, ECHECK \nPossible values:\n- MASTERDEBIT\n- MASTERCREDIT\n- VISACREDIT\n- VISADEBIT\n- DISCOVERCREDIT\n- AMEXCREDIT\n- ECHECK"
feeType:
type: string
description: "Fee type for the selected payment type. Supported values are: Flat or Percentage.\n \nPossible values:\n- FLAT\n- PERCENTAGE"
feeAmount:
type: number
pattern: /^\d{0,8}(\.\d{0,2})?$/
description: 'Fee Amount of the selected payment type if you chose Flat fee type.
'
percentage:
type: number
description: 'Percentage of the selected payment type if you chose Percentage Fee type. Supported values use numbers with decimals. For example, 1.0
'
feeCap:
type: number
pattern: /^\d{0,8}(\.\d{0,2})?$/
description: 'Fee cap for the selected payment type. Supported values use numbers with decimals. For example, 1.0
'
batchUpload:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
transactGuard:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
microform:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
enablementStatus:
type: string
default: ENABLED_AND_USABLE
description: 'Possible values:
- PENDING
- ENABLED_AND_USABLE
- ENABLED_NOT_USABLE
- DISABLED'
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
features:
type: object
additionalProperties:
x-devcenter-additional-properties:
- cardPresent
- cardNotPresent
type: object
properties:
enabled:
type: boolean
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
properties:
features:
type: object
properties:
gatewayAgnostic:
type: object
properties:
merchantLevelEncryption:
type: boolean
risk:
title: riskProducts
type: object
properties:
fraudManagementEssentials:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
decisionManager:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
title: DmConfig
properties:
processingOptions:
type: object
properties:
stepUpAuthEnabled:
type: boolean
organization:
type: object
properties:
hierarchyGroup:
type: string
description: 'Must be one of the following : NO_GROUP, INCLUDE_IN_PARENTS_GROUP
'
example: NO_GROUP
portfolioControls:
type: object
properties:
hideRiskMenus:
type: boolean
hideRiskTransactionData:
type: boolean
thirdparty:
type: object
properties:
provider:
type: object
properties:
accurint:
type: object
properties:
enabled:
type: boolean
credentials:
type: object
properties:
username:
type: string
password:
type: string
credilink:
type: object
properties:
enabled:
type: boolean
enableRealTime:
type: boolean
useCybsCredentials:
type: boolean
credentials:
type: object
properties:
username:
type: string
password:
type: string
sigla:
type: string
ekata:
type: object
properties:
enabled:
type: boolean
enableRealTime:
type: boolean
useCybsCredentials:
type: boolean
credentials:
type: object
properties:
apiKey:
type: string
emailage:
type: object
properties:
enabled:
type: boolean
enableRealTime:
type: boolean
useCybsCredentials:
type: boolean
credentials:
type: object
properties:
username:
type: string
password:
type: string
perseuss:
type: object
properties:
enabled:
type: boolean
enableRealTime:
type: boolean
credentials:
type: object
properties:
username:
type: string
password:
type: string
signifyd:
type: object
properties:
enabled:
type: boolean
credentials:
type: object
properties:
teamId:
type: string
apiKey:
type: string
secretKeyid:
type: string
secretKey:
type: string
targus:
type: object
properties:
enabled:
type: boolean
useCybsCredentials:
type: boolean
credentials:
type: object
properties:
username:
type: string
password:
type: string
serviceId:
type: string
portfolioRiskControls:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
configurations:
type: object
properties:
profileId:
type: string
enhancedAuthentication:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
title: PayerAuthConfig
properties:
cardTypes:
type: object
properties:
verifiedByVisa:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
masterCardSecureCode:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
amexSafeKey:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
jCBJSecure:
type: object
properties:
securePasswordForJCB:
type: string
minLength: 8
maxLength: 8
description: JSecure currency password for Japan Credit Bureau
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
dinersClubInternationalProtectBuy:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
ELO:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
UPI:
type: object
properties:
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
CB:
type: object
properties:
requestorId:
type: string
minLength: 14
maxLength: 14
description: The value is for 3DS2.0 and is a Directory Server assigned 3DS Requestor ID value. If this field is passed in request, it will override Requestor Id value that is configured on the Merchant's profile.
enabled:
type: boolean
default: true
currencies:
type: array
items:
type: object
properties:
currencyCodes:
type: array
description: "Supported currency codes are numeric ISO 4217 codes, such as 840 for US Dollar and 978 for Euro. \nFor backward compatibility, we also support the 'ALL' code, which represents all currencies. \nIn the UI, 'ALL' is displayed as 'Default'.\n"
example:
- ALL
- '840'
- '978'
items:
type: string
example: ALL
acquirerId:
type: string
minLength: 6
maxLength: 20
pattern: ^[a-zA-Z0-9]{6,20}$
description: 'The Acquirer ID value, often referred to as the Acquirer BIN, is specific to an Acquirer.
The value is created by Cardinal in their system and the Acquirer may not know that the Acquirer ID is different from their Acquiring BIN.
It is most often the Acquiring BIN + "-1000" but the trailing character can be different.
**Note** We will need to double check with Cardinal before setting up the Portfolio Template in production.
'
processorMerchantId:
type: string
minLength: 6
maxLength: 35
pattern: ^[a-zA-Z0-9]{6,35}$
description: 'Processor Merchant ID is the Merchant ID assigned by your acquiring bank.
This Merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.
'
commerceSolutions:
title: commerceSolutionsProducts
type: object
properties:
tokenManagement:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
properties:
parentProfileId:
type: string
description: Specify the Vault ID to which transacting MID needs to be assigned.Provide Vault ID as seen on EBC Vault management page. If not provided , transacting MID will be assigned to the existing default Vault at merchant's level. If there are no Vaults at merchant level , a new Vault will be created and transacting MID will be assigned to it.
vault:
type: object
properties:
defaultTokenType:
type: string
description: "Default token type to be used.\nPossible Values: \n - 'CUSTOMER'\n - 'PAYMENT_INSTRUMENT'\n - 'INSTRUMENT_IDENTIFIER'\n"
example: CUSTOMER
location:
type: string
description: "Location where the vault will be stored.\n\nUse 'IDC' (the Indian Data Centre) when merchant is storing token data in India or 'GDC' (the Global Data Centre) for all other cases.\n\nPossible Values: \n - 'IDC'\n - 'GDC'\n"
example: GDC
tokenFormats:
title: tmsTokenFormats
type: object
properties:
customer:
type: string
description: "Format for customer tokens.\n\nPossible Values:\n - '16_DIGIT'\n - '19_DIGIT'\n - '22_DIGIT'\n - '32_HEX'\n"
example: 32_HEX
paymentInstrument:
type: string
description: "Format for payment instrument tokens.\n\nPossible Values:\n - '16_DIGIT'\n - '19_DIGIT'\n - '22_DIGIT'\n - '32_HEX'\n"
example: 32_HEX
instrumentIdentifierCard:
type: string
description: "Format for card based instrument identifier tokens.\n\nPossible Values:\n - '16_DIGIT'\n - '16_DIGIT_LAST_4'\n - '19_DIGIT'\n - '19_DIGIT_LAST_4'\n - '22_DIGIT'\n - '32_HEX'\n"
instrumentIdentifierBankAccount:
type: string
description: "Format for bank account based instrument identifier tokens.\n\nPossible Values: \n - '16_DIGIT'\n - '19_DIGIT'\n - '22_DIGIT'\n - '32_HEX'\n"
tokenPermissions:
title: TokenPermissions
type: object
properties:
create:
type: boolean
description: Indicates if tokens may be created
read:
type: boolean
description: Indicates if tokens may be read
update:
type: boolean
description: Indicates if tokens may be updated
delete:
type: boolean
description: Indicates if tokens may be deleted
sensitivePrivileges:
title: tmsSensitivePrivileges
type: object
properties:
cardNumberMaskingFormat:
type: string
description: "Indicates which digits of the card number will be unmasked.\n\nPossible Values: \n - 'FIRST_6_LAST_4'\n - 'LAST_4'\n - 'MASKED'\n"
nullify:
title: tmsNullify
type: object
properties:
instrumentIdentifierCardNumber:
type: boolean
description: Indicates if the card number should be nullified (i.e. not stored)
instrumentIdentifierCardExpiration:
type: boolean
description: Indicates if the expiration date associated to the instrument identifier should be nullified (i.e. not stored)
paymentInstrumentCardDetails:
type: boolean
description: Indicates if the card details should be nullified (i.e. not stored)
networkTokenServices:
title: tmsNetworkTokenServices
type: object
properties:
notifications:
type: object
properties:
enabled:
type: boolean
description: Indicates if lifecycle management (LCM) notifications are enabled
paymentCredentials:
type: object
properties:
enabled:
type: boolean
description: Indicates if Payment Credentials are enabled. If enabled, this provides access to the unredacted token and its associated cryptogram.
synchronousProvisioning:
type: object
properties:
enabled:
type: boolean
description: "Indicates if network tokens are provisioned synchronously (i.e. as part of the transaction flow) or asychronously (i.e. in parallel to the payment flow)\n\nNOTE: The synchronous provisioning feature is designed exclusively for aggregator merchants.\n\nDirect merchants should not enable synchronous provisioning as TMS manages the asynchronous creation of network tokens for direct clients. \n\nActivation of this feature by direct merchants will lead to latency in the authorization response.\n"
visaTokenService:
type: object
properties:
enableService:
type: boolean
description: Indicates if the service for network tokens for the Visa card association are enabled
enableTransactionalTokens:
type: boolean
description: Indicates if network tokens for the Visa card association are enabled for transactions
tokenRequestorId:
type: string
description: 'Token Requestor ID provided by Visa during the registration process for the Tokenization Service
Pattern: ^[0-9]{11}\\z$"
Min Length: 11
Max Length: 11
Example: "40000000082"
'
pattern: ^[0-9]{11}\\z$"
minLength: 11
maxLength: 11
relationshipId:
type: string
description: 'Relationship ID provided by visa
Min Length: 1
Max Length: 100
Example: "24681921-40000000082"
'
minLength: 1
maxLength: 100
mastercardDigitalEnablementService:
type: object
properties:
enableService:
type: boolean
description: Indicates if the service for network tokens for the Mastercard card association are enabled
enableTransactionalTokens:
type: boolean
description: Indicates if network tokens for the Mastercard card association are enabled for transactions
tokenRequestorId:
type: string
description: 'Token Requestor ID provided by Mastercard during the registration process for the Tokenization Service
Pattern: ^[0-9]{11}\\z$"
Min Length: 11
Max Length: 11
Example: "50162233570"
'
pattern: ^[0-9]{11}\\z$"
minLength: 11
maxLength: 11
americanExpressTokenService:
type: object
properties:
enableService:
type: boolean
description: Indicates if the service for network tokens for the American Express card association are enabled
enableTransactionalTokens:
type: boolean
description: Indicates if network tokens for the American Express card association are enabled for transactions
tokenRequestorId:
type: string
description: 'Token Requestor ID provided by American Express during the registration process for the Tokenization Service
Pattern: ^[0-9]{11}\\z$"
Min Length: 11
Max Length: 11
Example: "12345678912"
'
pattern: ^[0-9]{11}\\z$"
minLength: 11
maxLength: 11
seNumber:
type: string
minLength: 10
maxLength: 10
pattern: ^[0-9]{11}\z$
description: 'SE Number assigned by American Express for the merchant''s account
Pattern: "^[0-9]{11}\\z$"
Min Length: 10
Max Length: 10
Example: "9876543212"
'
networkTokenEnrollment:
title: networkTokenEnrollment
type: object
properties:
businessInformation:
title: tmsBusinessInformation
type: object
properties:
name:
type: string
maxLength: 60
minLength: 1
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
description: Name of the network token merchant.
example: NetworkTokenMerchant
doingBusinessAs:
type: string
maxLength: 60
pattern: "^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#¡-\uFFFF]+$"
description: Name the network token merchant does business as
example: NetworkTokenCo1
address:
type: object
properties:
country:
type: string
maxLength: 2
minLength: 2
pattern: ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$
description: Country of network token merchant.
example: US
locality:
type: string
maxLength: 50
minLength: 1
pattern: "^[0-9a-zA-Z _\\-¡-\uFFFF]+$"
description: City of network token merchant.
example: ORMOND BEACH
websiteUrl:
type: string
maxLength: 100
pattern: \b((?:https?://|www\d{0,3}[.]|[a-z0-9.\-]+[.][a-z]{2,4}/)(?:[^\s()<>]+|\(([^\s()<>]+|(\([^\s()<>]+\)))*\))+(?:\(([^\s()<>]+|(\([^\s()<>]+\)))*\)|[^\s`!()\[\]{};:'".,<>?«»“â€.‘’]))
description: Website of network token merchant.
example: https://www.NetworkTokenMerchant.com
businessIdentificationType:
type: string
description: 'The Identifier associated with the business type; required unless both acquirerId and acquirerMerchantId are provided.
'
maxLength: 15
businessIdentificationValue:
type: string
description: 'The value associated with the business identifier type; required unless both acquirerId and acquirerMerchantId are provided.
'
maxLength: 25
acquirer:
type: object
properties:
acquirerId:
type: string
description: 'Acquirer ID; required unless both businessIdentificationType and businessIdentificationValue are provided.
'
maxLength: 15
acquirerMerchantId:
type: string
description: 'Acquirer merchant ID; required unless both businessIdentificationType and businessIdentificationValue are provided.
'
maxLength: 25
networkTokenServices:
title: NetworkTokenServicesEnablement
type: object
properties:
visaTokenService:
type: object
properties:
enrollment:
type: boolean
description: Indicates if an enrollment to create a TRID for the Visa card association should be attempted
mastercardDigitalEnablementService:
type: object
properties:
enrollment:
type: boolean
description: Indicates if an enrollment to create a TRID for the MasterCard card association should be attempted
accountUpdater:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
templateId:
type: string
configurations:
type: object
properties:
masterCard:
type: object
properties:
merchantId:
type: string
description: MasterCard merchant identified number
interbankCardAssociationNumber:
type: string
description: Number assigned by MasterCard to a financial institution, third-party processor or other member to identify the member in transaction.
active:
type: boolean
required:
- merchantId
- interbankCardAssociationNumber
visa:
type: object
properties:
merchantId:
type: string
description: Visa merchant identified number
segmentId:
type: string
description: Visa assigned segment ID for each group of merchants participating in VAU.
active:
type: boolean
required:
- merchantId
- segmentId
amex:
type: object
properties:
mode:
type: string
description: Type of mode. Valid values are `tokenApi` or `dailyHarvest`.
seNumber:
type: string
subscriberId:
type: string
active:
type: boolean
preferredDay:
type: number
minimum: 1
maximum: 28
daysWindow:
type: number
minimum: 1
maximum: 3650
default: 31
binLookup:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
configurationInformation:
type: object
properties:
configurations:
type: object
properties:
isPayoutOptionsEnabled:
type: boolean
description: This flag indicates if the merchant is configured to make payout calls
isAccountPrefixEnabled:
type: boolean
description: This flag indicates if the merchant is configured to receive account prefix
agenticCommerce:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
valueAddedServices:
title: valueAddedServicesProducts
type: object
properties:
reporting:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
transactionSearch:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
bankAccountValidation:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
flexapi:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
webhooks:
type: object
properties:
subscriptionInformation:
type: object
properties:
enabled:
type: boolean
selfServiceability:
type: string
default: NOT_SELF_SERVICEABLE
description: "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY"
productInformationSetups:
type: array
items:
type: object
properties:
organizationId:
type: string
maxLength: 30
minLength: 6
pattern: ^[0-9a-zA-Z]+$
example: merch-test1
setups:
type: object
properties:
payments:
type: object
properties:
cardProcessing:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
alternativePaymentMethods:
type: object
properties:
configurationStatus:
type: object
properties:
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
message:
type: string
subscriptionStatus:
type: object
properties:
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
message:
type: string
status:
type: string
description: 'Possible values:
- PROCESSED
- PARTIAL_PROCESSED'
submitTimeUtc:
type: string
format: date-time
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example: 2024-09-08T09:37:38+0000
'
cardPresentConnect:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
eCheck:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
payerAuthentication:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
digitalPayments:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
secureAcceptance:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
virtualTerminal:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
currencyConversion:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
tax:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
customerInvoicing:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
recurringBilling:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
cybsReadyTerminal:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
paymentOrchestration:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
payouts:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
payByLink:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
unifiedCheckout:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
receivablesManager:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
serviceFee:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
batchUpload:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
transactGuard:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
microform:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
risk:
type: object
properties:
fraudManagementEssentials:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
decisionManager:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
enhancedAuthentication:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
commerceSolutions:
type: object
properties:
tokenManagement:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
accountUpdater:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
binLookup:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
agenticCommerce:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
configurationStatus:
type: object
properties:
configurationId:
type: string
description: This is NOT for MVP
version:
type: string
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- PARTIAL
- PENDING
- NOT_SETUP'
reason:
type: string
description: 'Possible values:
- PENDING_PROVISIONING_PROCESS
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD
- NOT_APPLICABLE'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
valueAddedServices:
type: object
properties:
reporting:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
transactionSearch:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
bankAccountValidation:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
flexapi:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
webhooks:
type: object
properties:
subscriptionStatus:
type: object
properties:
submitTimeUtc:
type: string
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
status:
type: string
description: 'Possible values:
- SUCCESS
- FAILURE
- PARTIAL
- PENDING'
reason:
type: string
description: 'Possible values:
- DEPENDENT_PRODUCT_NOT_CONTRACTED
- DEPENDENT_FEATURE_NOT_CHOSEN
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
details:
type: array
items:
type: object
properties:
field:
type: string
reason:
type: string
description: 'Possible values:
- MISSING_DATA
- INVALID_DATA
- DUPLICATE_FIELD'
additionalProperties:
type: string
message:
type: string
documentInformation:
type: object
properties:
signedDocuments:
type: array
items:
type: object
properties:
documentId:
type: string
maxLength: 200
example: TCProcessing
details:
type: object
additionalProperties:
type: array
items:
type: object
properties:
field:
type: string
description: This is the flattened JSON object field name/path that is either missing or invalid.
reason:
type: string
description: Possible reasons for the error.
example: MISSING_FIELD
value:
type: string
example: abc123
reference:
type: string
example: xyz
x-devcenter-additional-properties:
- organizationInformation
- productInformation
'400':
description: Bad Request
headers:
v-c-correlationid:
type: string
description: Unique identifier for this request
schema:
type: object
properties:
submitTimeUtc:
type: string
format: date-time
example: '2019-06-11T22:47:57Z'
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
readOnly: true
status:
type: string
description: The http status description of the submitted request.
example: BAD_REQUEST
reason:
type: string
description: "Documented reason codes. Client should be able to use the key for generating their own error message\nPossible Values:\n - 'INVALID_DATA'\n - 'SYSTEM_ERROR'\n - 'RESOURCE_NOT_FOUND'\n"
message:
type: string
description: Descriptive message for the error.
details:
type: array
items:
type: object
properties:
field:
type: string
description: This is the flattened JSON object field name/path that is either missing or invalid.
reason:
type: string
description: Possible reasons for the error.
example: MISSING_FIELD
'404':
description: Resource Not Found
headers:
v-c-correlationid:
type: string
description: Unique identifier for this request
schema:
type: object
properties:
submitTimeUtc:
type: string
format: date-time
example: '2019-06-11T22:47:57Z'
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
readOnly: true
status:
type: string
description: The http status description of the submitted request.
example: NOT_FOUND
reason:
type: string
description: "Documented reason codes. Client should be able to use the key for generating their own error message\nPossible Values:\n - 'RESOURCE_NOT_FOUND'\n"
message:
type: string
description: Descriptive message for the error.
details:
type: array
items:
type: object
properties:
field:
type: string
description: This is the flattened JSON object field name/path that is either missing or invalid.
reason:
type: string
description: Possible reasons for the error.
example: MISSING_FIELD
'500':
description: Internal Server error
headers:
v-c-correlationid:
type: string
description: Unique identifier for this request
schema:
type: object
properties:
submitTimeUtc:
type: string
format: date-time
example: '2019-06-11T22:47:57Z'
description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the
time. The Z indicates UTC.
'
readOnly: true
status:
type: string
description: The http status description of the submitted request.
example: INTERNAL_SERVER_ERROR
reason:
type: string
description: "Documented reason codes. Client should be able to use the key for generating their own error message\nPossible Values:\n - 'SYSTEM_ERROR'\n"
message:
type: string
description: Descriptive message for the error.
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).