REST API

Recent Revisions to This Document

24.11

May 2024:
This revision of the guide contains updated or new field information.
Added these new fields:
  • merchantInformation.merchantDescriptor.phone
  • processingInformation.authorizationOptions.extendAuthIndicator
  • processingInformation.fundingOptions.initiator.type
  • processingInformation.merchantVerificationValue
  • processingInformation.paymentFlowMode
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.amexsafekey.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.amexsafekey.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.amexsafekey.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.amexsafekey.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.cb.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.cb.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.cb.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.cb.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.cb.requestorId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes. dinersclubinternationalprotectbuy.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes. dinersclubinternationalprotectbuy.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes. dinersclubinternationalprotectbuy.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes. dinersclubinternationalprotectbuy.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.elo.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.elo.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.elo.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.elo.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.jcbjsecure.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.jcbjsecure.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.jcbjsecure.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.jcbjsecure.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.jcbjsecure.securePasswordForJCB
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.mastercardsecurecode.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.mastercardsecurecode.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.mastercardsecurecode.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.mastercardsecurecode.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.upi.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.upi.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.upi.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.upi.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.verifiedbyvisa.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.verifiedbyvisa.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.verifiedbyvisa.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.verifiedbyvisa.enabled
  • recipientInformation.accountType
  • recipientInformation.address2
  • recipientInformation.buildingNumber
  • recipientInformation.streetName
Updated these fields:
  • aggregatorInformation.aggregatorId

24.10

April 2024:
This revision of the guide contains updated or new field information.
Added these new fields:
  • agreementInformation.dateSigned
  • agreementInformation.eSignIndicator
  • buyerInformation.gender
  • deviceInformation.deviceType
  • merchantDefinedInformation[].value
  • merchantInformation.transactionLocalDateTime
  • orderInformation.billTo.county
  • orderInformation.billTo.title
  • paymentInformation.bank.account.iban
  • paymentInformation.bank.scheme
  • paymentInformation.directDebit.mandate.clearingDate
  • paymentInformation.directDebit.mandate.id
  • paymentInformation.legacyToken.id
  • paymentOptions.limit
  • paymentOptions.offset
  • processingInformation.paymentFlowMode
  • processingInformation.transactionTimeout
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations. common.processors.[processorName].paymentTypes[paymentType].currencies.[currency].enabled
  • productInformation.selectedProducts.payments.payerAuthentication. subscriptionInformation.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. subscriptionInformation.selfServiceability
  • productInformation.selectedProducts.payments.paymentOrchestration. subscriptionInformation.enabled
  • productInformation.selectedProducts.payments.paymentOrchestration. subscriptionInformation.selfServiceability
  • travelInformation.transit.airline.clearingCount
  • travelInformation.transit.airline.clearingSequence
  • travelInformation.transit.airline.creditReasonIndicator
  • travelInformation.transit.airline.electronicTicketIndicator
  • travelInformation.transit.airline.purchaseType
  • travelInformation.transit.airline.reservationSystemCode
  • travelInformation.transit.airline.restrictedTicketDescription
  • travelInformation.transit.airline.ticketIssuer.locality
  • travelInformation.transit.airline.ticketNumber
  • travelInformation.transit.airline.totalClearingAmount
Updated these fields:
  • processingInformation.authorizationOptions.balanceInquiry
  • processingInformation.purchaseLevel
  • processingInformation.authorizationOptions.declineAvsFlags
  • processingInformation.authorizationOptions.ignoreCvResult
  • processorInformation.merchantAdvice.code
  • processorInformation.merchantAdvice.codeRaw

24.09

April 2024:
This revision of the guide contains updated or new field information.
Added these new fields:
  • paymentInsightsInformation.orchestration.infoCodes[]
Updated these fields:
  • orderInformation.lineItems[].amountIncludesTax
Updated these field groups:
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations. common.processors.[processorName]
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations. features.cardNotPresent.processors.[processorName]
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation. configurations.features.cardNotPresent.processors.[processorName]
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation. configurations.features.cardPresent.processors.[processorName]
  • productInformation.selectedProducts.payments.echeck.configurationInformation. configurations.common.processors.[processorName]
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes
Added these new fields:
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.features. cardNotPresent.amexTransactionAdviceAddendum1
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].acquirer.institutionId
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].acquirerMerchantId
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName]. amexTransactionAdviceAddendum1
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].enhancedData
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].merchantTier
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].paymentTypes.[paymentType].currencies.[currency].merchantId
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].paymentTypes.[paymentType].currencies.[currency].terminalId
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].paymentTypes.[paymentType].currencies.[currency].terminalIds
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].terminalId
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common. subMerchantBusinessName
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.subMerchantId
  • productInformation.selectedProducts.payments.secureAcceptance. subscriptionInformation.enabled
  • productInformation.selectedProducts.payments.secureAcceptance. subscriptionInformation.selfServiceability
  • productInformation.selectedProducts.payments.tax. subscriptionInformation.enabled
  • productInformation.selectedProducts.payments.tax. subscriptionInformation.selfServiceability
  • productInformation.selectedProducts.payments.unifiedCheckout. subscriptionInformation.enabled
  • productInformation.selectedProducts.payments.unifiedCheckout. subscriptionInformation.selfServiceability
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.basicInformation.defaultPaymentType
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.basicInformation.defaultTransactionType
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.basicInformation.displayInternet
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.basicInformation.displayMoto
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.basicInformation.displayRetail
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData1
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData2
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData3
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData4
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData5
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData1DisplayOnReceipt
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData2DisplayOnReceipt
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData3DisplayOnReceipt
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData4DisplayOnReceipt
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData5DisplayOnReceipt
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData1
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData2
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData3
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData4
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData5
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.acceptedCardTypes
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayBillPayment
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayCardVerificationValue
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayCreditCards
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayDebtIndicator
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayEchecks
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayFirstName
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayIgnoreECheckAvsCheckbox
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayLastName
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.enableEchecks
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.firstNameRequired
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.lastNameRequired
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.requireCardVerificationValue

24.08

April 2024:
This revision of the guide contains updated or new field information.
Updated these fields:
  • processorInformation.responseCode
Added these new fields:
  • clientReferenceInformation.partner.developerId
  • processingInformation.authorizationOptions.paymentTypeIndicator
  • tokenInformation.additionalInformation

24.07

April 2024:
This revision of the guide contains updated or new field information.
Added these new fields:
  • paymentAccountInformation.features.healthCard
  • paymentInformation.shippingAddress.id
  • processingInformation.enablerId
Updated these fields:
  • aggregatorInformation.aggregatorId
  • aggregatorInformation.subMerchant.id
  • consumerAuthenticationInformation.paSpecificationVersion
  • issuerInformation.transactionInformation
  • merchantInformation.salesOrganizationId
  • paymentInsightInformation.responseInsights.category
  • pointOfSaleInformation.emv.tags
  • pointOfSaleInformation.encryptedPin
  • processingInformation.authorizationOptions.authType
  • processingInformation.networkPartnerId
  • processorInformation.merchantAdvice.code
  • processorInformation.merchantAdvice.codeRaw

24.06

March 2024:
This revision of the guide contains updated or new field information.
Added these new fields:
  • allowedCardNetworks
  • allowedPaymentNetworks
  • captureMandate.billingType
  • captureMandate.requestEmail
  • captureMandate.requestPhone
  • captureMandate.requestShipping
  • captureMandate.shipToCountries
  • captureMandate.showAcceptedNetworkIcons
  • clientVersion
  • consumerAuthenticationInformation.dsReferenceNumber
  • country
  • locale
  • processingInformation.transactionTypeIndicator
  • targetOrigins

24.05

February 2024:
This revision of the guide contains updated or new field information.
Added this new field:
  • watchlistScreeningInformation.proceedOnMatch

24.04

February 2024:
This revision of the guide contains updated or new field information.
Updated the field length for
installmentInformation.identifier

24.03

January 2024:
This revision of the guide contains updated or new field information.
Added these new fields:
  • orderInformation.billTo.company.phoneNumber
  • orderInformation.billTo.middleName
  • orderInformation.billTo.namePrefix
  • orderInformation.billTo.nameSuffix
  • orderInformation.billTo.company.phoneNumber
  • paymentInformation.bank.account.checkTransactionCode
  • validationInformation.accountType
  • validationInformation.authorizationLevel
  • validationInformation.bank.accountOwner.customerDataConditionCode
  • validationInformation.bank.accountOwner.matchAddress
  • validationInformation.bank.accountOwner.matchAdministrativeArea
  • validationInformation.bank.accountOwner.matchCompanyName
  • validationInformation.bank.accountOwner.matchCompanyPhoneNumber
  • validationInformation.bank.accountOwner.matchDateOfBirth
  • validationInformation.bank.accountOwner.matchFirstName
  • validationInformation.bank.accountOwner.matchFullName
  • validationInformation.bank.accountOwner.matchLastName
  • validationInformation.bank.accountOwner.matchLocality
  • validationInformation.bank.accountOwner.matchMiddleName
  • validationInformation.bank.accountOwner.matchNamePrefix
  • validationInformation.bank.accountOwner.matchNameSuffix
  • validationInformation.bank.accountOwner.matchPersonalIdentificationID
  • validationInformation.bank.accountOwner.matchPersonalIdentificationIssuedBy
  • validationInformation.bank.accountOwner.matchPersonalIdentificationType
  • validationInformation.bank.accountOwner.matchPhoneNumber
  • validationInformation.bank.accountOwner.matchSocialSecurityNumber
  • validationInformation.bank.accountOwner.matchTaxId
  • validationInformation.bank.accountOwner.matchPostalCode
  • validationInformation.bank.accountOwner.overallMatchScore
  • validationInformation.bank.accountStatus.addedOrClosedDate
  • validationInformation.bank.accountStatus.additionalStatusCode
  • validationInformation.bank.accountStatus.fcraDisputeCode
  • validationInformation.bank.accountStatus.lastUpdateDate
  • validationInformation.bank.accountStatus.previousStatusCode
  • validationInformation.bank.accountStatus.primaryStatusCode
  • validationInformation.bank.accountStatus.scoredAccountProcessorResponse1
  • validationInformation.bank.accountStatus.scoredAccountProcessorResponse2
  • validationInformation.bank.accountStatus.scoredAccountProcessorResponse3
  • validationInformation.bank.accountStatus.scoredAccountProcessorResponse5
  • validationInformation.bank.accountStatus.secondaryStatusCode
  • validationInformation.calculatedResponse
  • validationInformation.resultCode
  • validationInformation.referenceID
  • validationInformation.transactionReason
  • validationInformation.validationType
Updated the processors that support these fields:
  • buyerInformation.merchantCustomerID
  • consumerAuthenticationInformation.cavvAlgorithm
  • orderInformation.billTo.company.name
  • orderInformation.shipTo.address1
  • orderInformation.shipTo.address2
  • orderInformation.shipTo.firstName
  • orderInformation.shipTo.lastName
  • orderInformation.shipTo.locality
  • paymentInformation.card.cardType
  • paymentInformation.card.securityCode
  • paymentInformation.card.type
  • paymentInformation.tokenizedCard.securityCode
  • paymentInformation.tokenizedCard.type
  • processingInformation.commerceIndicator
  • processorInformation.retrievalReferenceNumber

24.02

January 2024:
This revision of the guide contains updated or new field information.
Added clarifying information for
FDC Nashville Global
about the uses of this field:
  • processorInformation.merchantAdvice.code

24.01

January 2024:
This revision of the guide contains editorial improvements and potentially updated or new field information.
Added an important note about relaxed requirements for address data and the expiration date to these fields:
  • orderInformation.billTo.address1
  • orderInformation.billTo.administrativeArea
  • orderInformation.billTo.country
  • orderInformation.billTo.email
  • orderInformation.billTo.firstName
  • orderInformation.billTo.lastName
  • orderInformation.billTo.locality
  • orderInformation.billTo.postalCode
  • paymentInformation.card.expirationMonth
  • paymentInformation.card.expirationYear
Added clarifying information for
FDC Nashville Global
about the uses of these fields:
  • issuerInformation.responseCode
  • processorInformation.merchantAdvice.code

23.12

December 2023:
This revision of the guide contains editorial improvements and potentially updated or new field information.
Fields Added
  • merchantDefinedSecureInformation[].key
    : Name that you assign as the key for your merchant-defined secure data field.
  • merchantDefinedSecureInformation[].value
    : Merchant-defined secure data field to be passed in an authorization request.

23.11

November 2023:
This revision of the guide contains editorial improvements and potentially updated or new field information.

23.10

October 2023:
This revision of the guide contains editorial improvements and potentially updated or new field information.

23.09

September 2023:
This revision of the guide contains editorial improvements and potentially updated or new field information.

23.08

August 2023:
This revision of the guide contains editorial improvements and potentially updated or new field information.

23.07

July 2023:
This revision of the guide contains editorial improvements and potentially updated or new field information.