Skip to login Skip to content
Developer Cybersource Logo

Our API

Learn about Cybersource REST APIs, Developer guides & Release notes

API reference

View sample code and API field descriptions. Send requests to the sandbox and see the responses.

Developer guides

View feature-level guides with prerequisite and use-case information for implementing our API

Release notes

These release notes cover all releases to the production for the APIs and SDKs every month

Getting started

Use these developer resources to make your first API call.

 

Hello world

Step by step guide to make first Cybersource REST API call.

REST API SDKs

An inventory of SDKs & Sample codes in 6 languages to help you kick start your integration

 

Testing

Guide with sandbox testing instructions and processor specific testing trigger data.

 

Postman collection

A collection to make sample REST API calls. It provides samples for all supported HTTP methods.

Response (error) codes Understand all different error codes that Cybersource REST API responds with.

Accept payments

In-person Accept

Accept payments in person through a range of supported payment devices provided by us or integrate your existing payment devices to our payments network

Online payments

Start accepting payments online—quickly, securely, and globally. We offer a range of solutions to help you optimize payments across channels while protecting sensitive data.

Plugin connections

See our latest plugins and integrations.

 

Technology Partners

See our latest integrations and ISV solutions

Support

Reach out to our award-winning customer support team, or contact sales directly.

FAQ Frequently asked questions relating to Cybersource REST APIs and developer center.

Sales help Learn more about how our services can help your business. Call sales: 1-800-530-9095

Contact us

Cybersource on GitHub

Cybersource Community Forum

News and announcements

Feedback

Menu
API Overview
  • Recent Revisions to This Document
  • About This Guide
  • VISA Platform Connect: Specifications and Conditions for Resellers/Partners
  • Introduction to Card Present Connect | Retail
    • Enabling the Card Present Connect Platform
      • Enabling Card Present Connect
    • Card-Present Transactions
      • EMV Transactions
      • Magnetic Stripe Transactions
      • Hand-Keyed Transactions
    • Card-Present Transaction Risk Control Requirements
  • Card-Present Payment Processing
  • Card-Present Authorizations
    • Authorization with Contact EMV and Online PIN
      • Required Fields for Processing an Authorization with Contact EMV and Online PIN
        • Country-Specific Required Fields for Processing an Authorization with Contact EMV or Contactless PIN
      • REST Example: Processing an Authorization with Contact EMV and Online PIN
    • Authorization with Contact EMV and Offline PIN
      • Required Fields for Processing an Authorization with Contact EMV and Offline PIN
        • Country-Specific Required Fields for Processing an Authorization with Contact EMV or Contactless PIN
      • REST Example: Processing an Authorization with Contact EMV and Offline PIN
    • Authorization with Contactless EMV and Online PIN
      • Required Fields for Processing an Authorization with Contactless EMV and Online PIN
      • REST Example: Processing an Authorization with Contactless EMV and Online PIN
    • Authorizations with Magnetic Stripe Swipes
      • Required Fields for Processing an Authorization with Swiped Track Data
      • REST Example: Processing an Authorization with Swiped Track Data
    • Authorizations with Hand-Keyed Data
      • Required Fields for Processing an Authorization with Hand Keyed Data
      • REST Example: Processing an Authorization with Hand Keyed Data
    • Authorization for a Cash Advance with a Credit Card
      • Required Fields for Processing an Authorization for a Cash Advance
      • Optional Fields for Processing an Authorization for a Cash Advance
      • REST Example: Processing an Authorization for a Cash Advance
      • Response Codes from an Authorization for a Cash Advance
  • Captures
    • Required Fields for Capturing an Authorization
    • REST Example: Capturing an Authorization
  • Capture for a Contact EMV Authorization
    • Required Fields for Capturing a Contact EMV Authorization
    • REST Example: Capturing a Contact EMV Authorization
  • Stand-Alone Credit
    • Required Fields for Processing a Stand-Alone Credit
    • REST Example: Processing a Stand-Alone Credit
  • Authorization Reversals
    • Required Fields for Processing an Authorization Reversal
    • REST Example: Processing an Authorization Reversal
  • Voids
    • Required Fields for Processing a Void
    • REST Example: Processing a Void
  • Timeout Void for a Capture, Sale, Refund, or Credit
    • Required Fields for Processing a Timeout Void for a Capture, Sale, Refund, or Credit
    • REST Example: Processing a Timeout Void for a Capture, Sale, Refund, or Credit
  • Card-Present Mobile Point-of-Sale Payment Processing
    • Authorization with an mPOS Using an Embedded Reader and Software PIN Entry
      • Required Fields for Processing an Authorization with an mPOS Using an Embedded Reader and Software PIN Entry
      • REST Example: Processing an Authorization with an mPOS Using an Embedded Reader and Software PIN Entry for Mastercard
      • REST Example: Processing an Authorization with an mPOS Using an Embedded Reader and Software PIN Entry for Visa
    • Authorization with an mPOS Using an Embedded Reader and Software with No PIN Entry
      • Required Fields for Processing an Authorization with an mPOS Using an Embedded Reader and Software with No PIN Entry
      • REST Example: Processing an Authorization with an mPOS Using an Embedded Reader and Software with No PIN Entry for Mastercard
      • REST Example: Processing an Authorization with an mPOS Using an Embedded Reader and Software with No PIN Entry for Visa
    • Authorization with an mPOS Using an External, Contact-Only Reader with No PIN Entry
      • Required Fields for Processing an Authorization with an mPOS Using an External, Contact-Only Reader with No PIN Entry
      • REST Example: Processing an Authorization with an mPOS Using an External, Contact-Only Reader with No PIN Entry for Mastercard
      • REST Example: Processing an Authorization with an mPOS Using an External, Contact-Only Reader with No PIN Entry for Visa
    • Authorization with an mPOS Using an External Reader and Hardware PIN Entry
      • Required Fields for Processing an Authorization with an mPOS Using an External Reader and Hardware PIN Entry
      • REST Example: Processing an Authorization with an mPOS Using an External Reader and Hardware PIN Entry for Mastercard
      • REST Example: Processing an Authorization with an mPOS Using an External Reader and Hardware PIN Entry for Visa
    • Authorization with an mPOS Using an External Reader and Software PIN Entry
      • Required Fields for Processing an Authorization with an mPOS Using an External Reader and Software PIN Entry
      • REST Example: Processing an Authorization with an mPOS Using an External Reader and Software PIN Entry for Mastercard
      • REST Example: Processing an Authorization with an mPOS Using an External Reader and Software PIN Entry for Visa
    • Sale with an mPOS Using an Embedded Reader and Software PIN Entry
      • Required Fields for Processing a Sale with an mPOS Using an Embedded Reader and Software PIN Entry
      • REST Example: Processing a Sale with an mPOS Using an Embedded Reader and Software PIN Entry for Mastercard
      • REST Example: Processing a Sale with an mPOS Using an Embedded Reader and Software PIN Entry for Visa
    • Sale with an mPOS Using an Embedded Reader and Software with No PIN Entry
      • Required Fields for Processing a Sale with an mPOS Using an Embedded Reader and Software with No PIN Entry
      • REST Example: Processing a Sale with an mPOS Using an Embedded Reader and Software with No PIN Entry for Mastercard
      • REST Example: Processing a Sale with an mPOS Using an Embedded Reader and Software with No PIN Entry for Visa
    • Sale with an mPOS Using an External, Contact-Only Reader with No PIN Entry
      • Required Fields for Processing a Sale with an mPOS Using an External, Contact-Only Reader with No PIN Entry
      • REST Example: Processing a Sale with an mPOS Using an External, Contact-Only Reader with No PIN Entry for Mastercard
      • REST Example: Processing a Sale with an mPOS Using an External, Contact-Only Reader with No PIN Entry for Visa
    • Sale with an mPOS Using an External Reader and Hardware PIN Entry
      • Required Fields for Processing a Sale with an mPOS Using an External Reader and Hardware PIN Entry
      • REST Example: Processing a Sale with an mPOS Using an External Reader and Hardware PIN Entry for Mastercard
      • REST Example: Processing a Sale with an mPOS Using an External Reader and Hardware PIN Entry for Visa
    • Sale with an mPOS Using an External Reader and Software PIN Entry
      • Required Fields for Processing a Sale with an mPOS Using an External Reader and Software PIN Entry
      • REST Example: Processing a Sale with an mPOS Using an External Reader and Software PIN Entry for Mastercard
      • REST Example: Processing a Sale with an mPOS Using an External Reader and Software PIN Entry for Visa
  • Introduction to PIN Debit Processing
    • PIN Debit Integration
    • PIN Debit Transactions
    • PIN Debit Network Routing
    • PIN Debit Processing Versus Credit Card Processing
    • PIN Debit Reconciliation
    • Track Data
    • Terminal IDs
    • Electronic Benefit Transfer
    • Optional Features
      • Cash Back
      • Merchant Descriptors
      • Merchant-Inititated Reversals
      • Partial Authorizations
      • Payment Network Tokens
      • Surcharge Fees
  • PIN Debit Services
    • PIN Debit Purchase with Contactless EMV
      • Required Fields for a PIN Debit Purchase with Contactless EMV
      • REST Example: PIN Debit Purchase with Contactless EMV
    • PIN Debit Purchase with Contact EMV
      • Required Fields for a PIN Debit Purchase with Contact EMV
      • REST Example: PIN Debit Purchase with Contact EMV
    • PIN Debit Purchase with Contactless EMV and Cash Back
      • Required Fields for a PIN Debit Purchase with Contactless EMV and Cash Back
      • REST Example: PIN Debit Purchase with Contactless EMV and Cash Back
    • PIN Debit Purchase with Swiped Track Data and Merchant Descriptors
      • Required Fields for a PIN Debit Purchase with Swiped Track Data and Merchant Descriptors
      • REST Example: PIN Debit Purchase with Swiped Track Data and Merchant Descriptors
    • PIN Debit Partial Authorization with Swiped Track Data
      • Required Fields for a Swiped PIN Debit Partial Authorization
      • REST Example: PIN Debit Partial Authorization with Swiped Track Data
    • PIN Debit Purchase with Contactless EMV and a Surcharge Fee
      • Required Fields for a PIN Debit Purchase with Contactless EMV and a Surcharge Fee
      • REST Example: PIN Debit Purchase with Contactless EMV and a Surcharge Fee
    • PIN Debit Balance Inquiry with Contactless EMV
      • Required Fields for a PIN Debit Balance Inquiry with Contactless EMV
      • REST Example: PIN Debit Balance Inquiry with Contactless EMV
    • PIN Debit Balance Inquiry with Swiped Track Data
      • Required Fields for a PIN Debit Balance Inquiry with Swiped Track Data
      • REST Example: PIN Debit Balance Inquiry with Swiped Track Data
    • PIN Debit Credit with Swiped Track Data
      • Required Fields for a PIN Debit Credit with Swiped Track Data
      • REST Example: PIN Debit Credit with Swiped Track Data
    • PIN Debit Credit with Contactless EMV
      • Required Fields for a PIN Debit Credit with Contactless EMV
      • REST Example: PIN Debit Credit with Contactless EMV
    • Reverse a PIN Debit Purchase or Credit
      • Required Fields to Reverse a PIN Debit Purchase or Credit
      • REST Example: Reverse a PIN Debit Purchase or Credit
    • PIN Debit EBT Purchase with a SNAP Voucher
      • Required Fields for a PIN Debit EBT Purchase with a SNAP Voucher
      • REST Example: PIN Debit EBT Purchase with a SNAP Voucher
    • PIN Debit EBT Purchase with SNAP Account Swiped Track Data
      • Required Fields for a PIN Debit EBT Purchase with SNAP Account Swiped Track Data
      • REST Example: PIN Debit EBT Purchase with SNAP Account Swiped Track Data
    • PIN Debit EBT Purchase with SNAP Account Swiped Track Data and Balance Inquiry
      • Required Fields for a PIN Debit EBT Purchase with SNAP Account Swiped Track Data and Balance Inquiry
      • REST Example: PIN Debit EBT Purchase with SNAP Account Swiped Track Data and Balance Inquiry
    • PIN Debit EBT Purchase with a Cash Benefits Account Swiped Track Data and Cash Back
      • Required Fields for a PIN Debit EBT Purchase with a Cash Benefits Account Swiped Track Data and Cash Back
      • REST Example: PIN Debit EBT Purchase with a Cash Benefits Account Swiped Track Data and Cash Back
    • Credit a PIN Debit EBT Purchase with SNAP Account
      • Required Fields to Credit a PIN Debit EBT Purchase with SNAP Account
      • REST Example: Credit a PIN Debit EBT Purchase with SNAP Account
    • Reverse a PIN Debit EBT Purchase
      • Required Fields to Reverse a PIN Debit EBT Purchase
      • REST Example: Reverse a PIN Debit EBT Purchase

Required Fields for a PIN Debit Purchase with Contactless EMV and a Surcharge Fee

clientReferenceInformation.code
clientReferenceInformation.partner.thirdPartyCertificationNumber
Cybersource
 provides the value for this field.
clientReferenceInformation.transactionId
orderInformation.amountDetails.currency
orderInformation.amountDetails.surcharge.amount
orderInformation.amountDetails.totalAmount
paymentInformation.card.sourceAccountType
Set this field to
UA
.
paymentInformation.card.useAs
Leave this field blank.
paymentInformation.paymentType.name
Set this field to
CARD
.
paymentInformation.paymentType.subTypeName
Set this field to
DEBIT
.
pointOfSaleInformation.emv.cardSequenceNumber
Required only when the card has a sequence number configured on the EMV chip.
pointOfSaleInformation.emv.tags
pointOfSaleInformation.entryMode
Set this field to
contactless
.
pointOfSaleInformation.terminalCapability
pointOfSaleInformation.trackData
processingInformation.commerceIndicator
Set this field to
retail
.
Previous topic
Next topic
Back to top

Visa

Cybersource.com

Terms + conditions

Cookie policy

Privacy Notice

Your privacy rights

© 2024 Cybersource. All rights reserved. All brand names and logos are the property of their respective owners, are used for identification purposes only, and do not imply product endorsement or affiliation with Cybersource.