Recent Revisions to This Document

About This Guide

Basic Processing
- Basic Authorizations
  - Required Fields for Processing Basic Authorizations Using the REST API
  - Declined Authorizations
  - REST Interactive Example: Processing an Authorization
  - REST Example: Processing a Basic Authorization
- Authorization Reversals
  - Required Fields for Processing Authorization Reversals Using REST APIs
  - Capturing an Authorization Using REST APIs
  - Example: Processing an Authorization Reversal Using the REST API
- Authorization with Line Itemization
  - Required Fields
  - REST Example: Processing a Basic Authorization with Line Items
- Zero Amount Authorizations
  - Required Fields for Processing Zero Amount Authorizations Using the REST API
  - Authorizing a Payment Using REST APIs
  - REST Example: Processing a Zero Amount Authorization
- Authorization with an SCA Exemption
  - Required Fields for Processing Basic Authorizations Using the REST API
  - REST Example: Authorization with an SCA Exemption for Low Value Transactions
- Captures
  - Required Fields for Processing Basic Captures Using the REST API
  - REST Interactive Example: Capturing a Payment
  - REST Example: Capturing an Authorization
- Sales
  - Required Fields for Processing Basic Sales Using REST APIs
  - REST Example: Requesting a Sale
- Refunds
  - Required Fields for Processing Refunds Using the REST API
  - REST Interactive Example: Processing a Refund
  - Example: Processing a Refund Using the REST API
- Stand Alone Credits
  - Required Fields for Processing RefundsFollow-On Credits Using REST APIs
  - REST Interactive Example: Processing a Credit
  - REST Example: Processing a Stand-Alone Credit
- Capture or Credit Voids
  - Required Fields for Processing Voids Using REST APIs
  - REST Example: Processing a Void

Card-Present Authorizations
- EMV Chip and Online PIN Authorization
  - Fallback
  - Required Fields for a Contact EMV Authorization with Online PIN Using the REST API
  - REST Example: EMV Chip and Online PIN Authorization
- EMV Chip (Contact) and Offline PIN Authorization
  - Fallback
  - Required Fields for a Contact EMV Authorization with Offline PIN Using the REST API
  - REST Example: EMV Chip (Contact) with an Offline PIN
- EMV Chip (Contact) and Signature
  - Fallback
  - Required Fields for a Contact EMV Authorization with a Signature Using the REST API
  - REST Example: EMV Chip (Contact) with a Signature
- EMV Chip (Contactless) and Online PIN
  - Fallback
  - Required Fields for an EMV Contactless Authorization with an Online PIN Using the REST API
  - REST Example: EMV Chip (Contactless) with an Online PIN
- EMV Chip (Contactless) and Offline PIN
  - Fallback
  - Required Fields for an EMV Contactless Authorization with an Offline PIN Using the REST API
  - REST Example: EMV Chip (Contactless) with an Offline PIN
- EMV Chip (Contactless with a Signature
  - EMV Fallback
  - Required Fields for an EMV Contactless Authorization with a Signature Using the REST API
  - REST Example: EMV Chip (Contactless) with a Signature

Payer Authentication Processing
- Visa Secure
  - Required Fields for an Authorization with Visa Secure Using REST APIs
  - Example: Authorization with Visa Secure Using the REST API
- Authorization with an SCA Exemption
  - Required Fields for Processing Basic Authorizations Using the REST API
  - REST Example: Authorization with an SCA Exemption for Low Value Transactions

Debit and Prepaid Card Processing
- Processing Debit and Prepaid Authorizations
  - Required Fields for Debit and Prepaid Authorizations Using REST APIs
    - payments-debit-prepaid-auth-required-country
  - Optional Field for Debit and Prepaid Authorizations Using REST APIs
  - REST Example: Debit and Prepaid Authorizations
- Enabling Debit and Prepaid Partial Authorizations
  - Required Field for Enabling Debit and Prepaid Partial Authorizations Using REST APIs
  - Optional Field for Enabling Debit and Prepaid Partial Authorizations Using REST APIs
  - Enabling Partial Authorizations
  - Example: Enabling Debit and Prepaid Partial Authorizations Using the REST API
- Disabling Debit and Prepaid Partial Authorizations
  - Required Field for Disabling Debit and Prepaid Partial Authorizations Using REST APIs
  - Optional Field for Disabling Debit and Prepaid Partial Authorizations Using REST APIs
  - Disabling Partial Authorizations
  - Example: Disabling Debit and Prepaid Partial Authorizations Using the REST API

On This Page

REST API | GPX

Authorization with Line Itemization

This section shows you how to process an authorization request with line items.

Fields Specific to this Use Case

Remove the

orderInformation.amountDetails.totalAmount

field used in a basic authorization and include one or more line items in the

lineItem[]

array.

Using Line Items

These

fields

are required for each line item that you use:

orderInformation.lineItems[].unitPrice

orderInformation.lineItems[].quantity

orderInformation.lineItems[].productCode

orderInformation.lineItems[].productSku

(optional when

item_#_productCode

is set to

default

,

shipping_only

,

handling_only

, or

shipping_and_handling

)

orderInformation.lineItems[].productName

(optional when

item_#_productCode

is set to

default

,

shipping_only

,

handling_only

, or

shipping_and_handling

)

At a minimum, you must include the

item_#_unitPrice

field in order to include a line item in an authorization. When this field is the only field included in the authorization, the system sets:

orderInformation.lineItems[].productCode

: default

orderInformation.lineItems[].quantity

: 1

For example, these three line items are valid.

"orderInformation": {
  "lineItems": [
    {
      "unitPrice": "10.00"
    },
    {
      "unitPrice": "5.99",
      "quantity": "3",
      "productCode": "shipping_only"
    },
    {
      "unitPrice": "29.99",
      "quantity": "3",
      "productCode": "electronic_good",
      "productSku": "12384569",
      "productName": "receiver"
    }
  ]
}

Endpoint

POST https://api.cybersource.com/pts/v2/payments

Back to top