Run card transaction

Allows you to process a card transaction through the API.

Aside from the fields marked required here, the gateway you are using may require additional fields. For information on gateway-specific required fields, see the Connections documentation.

Important

Parameters passed with a process request override any data points that are saved with the card token.

For example, if the value for data.customer.billToAddressOne is saved with the card token as 729 Jay Road, but the value for that field is passed with the process request as 2147 West Silverlake Drive, the address at Silverlake Drive is the one that is used.

Request parameters

  • data
  • data.amount
  • data.currency
  • data.allowedCardTypes
  • data.cart
  • data.cart.items
  • data.cart.items.item
  • data.cart.items.description
  • data.cart.items.quantity
  • data.cart.items.price
  • data.cart.items.type
  • data.customer
  • data.customer.customerRef
  • data.customer.orderNumber
  • data.customer.orderDate
  • data.customer.invoice
  • data.customer.firstName
  • data.customer.lastName
  • data.customer.birthDate
  • data.customer.nationalIdentificationNumber
  • data.customer.billToAddressOne
  • data.customer.billToAddressTwo
  • data.customer.billToCity
  • data.customer.billToCountry
  • data.customer.billToPhone
  • data.customer.billToPostal
  • data.customer.billToState
  • data.customer.createdAtDate
  • data.customer.email
  • data.customer.phone
  • data.customer.shipToAddressOne
  • data.customer.shipToAddressTwo
  • data.customer.shipToCity
  • data.customer.shipToCountry
  • data.customer.shipToPhone
  • data.customer.shipToPostal
  • data.customer.shipToState
  • data.customFields
  • data.customFields.exampleKey
  • data.description
  • data.descriptor
  • data.descriptor.name
  • data.descriptor.address
  • data.descriptor.city
  • data.descriptor.state
  • data.descriptor.postal
  • data.descriptor.country
  • data.descriptor.phone
  • data.descriptor.url
  • data.descriptor.merchantId
  • data.descriptor.mcc
  • data.lodging
  • data.lodging.advanceDeposit
  • data.lodging.checkInDate
  • data.lodging.checkOutDate
  • data.lodging.noShow
  • data.lodging.roomNumber
  • data.lodging.roomRate
  • paymentMethod
  • tokenex
  • tokenex.token
  • tokenex.firstSix
  • tokenex.lastFour
  • card
  • card.cardType
  • card.cardHolderName
  • card.encryptedNumber
  • card.expirationMonth
  • card.expirationYear
  • card.securityCode
  • card.firstSix
  • card.lastFour
  • card.classification
  • card.businessNumber
  • card.password
  • token
  • shouldUpdateCard
  • merchantId
  • processingOptions
  • processingOptions.merchantId
  • processingOptions.check3ds
  • processingOptions.paymentType
  • processingOptions.customerRedirectUrl
  • processingOptions.checkFraud
  • processingOptions.saveCardToken
  • processingOptions.paymentOptionTag
  • processingOptions.retryOnSoftDecline
  • processingOptions.shouldUseFingerprint
  • processingOptions.verboseResponse
  • clientIp
  • isAuthOnly
  • installment
  • installment.period

Response parameters

  • id
  • merchantId
  • authCode
  • amount
  • currency
  • transactionDate
  • transactionStatus
  • transactionType
  • shouldUpdateCard
  • card
  • card.cardHolder
  • card.expirationMonth
  • card.expirationYear
  • card.cardType
  • card.cardNumber
  • token
  • token.token
  • token.firstSix
  • token.lastFour
  • token.cardType
  • data
  • data.amount
  • data.currency
  • data.settlementCurrency
  • data.customer
  • data.customer.customerRef
  • data.customer.orderNumber
  • data.customer.orderDate
  • data.customer.invoice
  • data.customer.firstName
  • data.customer.lastName
  • data.customer.birthDate
  • data.customer.billToAddressOne
  • data.customer.billToAddressTwo
  • data.customer.billToCity
  • data.customer.billToCountry
  • data.customer.billToPhone
  • data.customer.billToPostal
  • data.customer.billToState
  • data.customer.email
  • data.customer.phone
  • data.customer.shipToAddressOne
  • data.customer.shipToAddressTwo
  • data.customer.shipToCity
  • data.customer.shipToCountry
  • data.customer.shipToPhone
  • data.customer.shipToPostal
  • data.customer.shipToState
  • data.customer.createdAt
  • data.cart
  • data.cart.items
  • data.cart.items.item
  • data.cart.items.description
  • data.cart.items.quantity
  • data.cart.items.price
  • data.cart.items.type
  • data.lodging
  • data.lodging.advanceDeposit
  • data.lodging.checkInDate
  • data.lodging.checkOutDate
  • data.lodging.noShow
  • data.lodging.roomNumber
  • data.lodging.roomRate
  • data.customFields
  • data.customFields.exampleKey
  • kountResponse
  • kountResponse.status
  • kountResponse.rules
  • installment
  • installment.period
  • gatewayResponse
  • gatewayResponse.gatewayName
  • gatewayResponse.refNumber
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!