On This Page

Credits with Level III Data

This topic shows you how to process a

credit

with Level III data. These required fields and example are specific to Visa Platform Connect.

For required fields, optional fields, and examples specific to your processor see the Level II and Level III Processing developer guides.

Endpoint

Production:

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

Test:

POST https://apitest.cybersource.com/pts/v2/credits/

Required Fields for Processing a Credit with Level III Data

Use these required fields to process a credit that includes Level III data.

orderInformation.amountDetails.currency
orderInformation.amountDetails.nationalTaxIncluded: Set to
1
if the sum of all
orderInformation.lineItems[].taxDetails[].amount
values >
0
.
orderInformation.amountDetails.totalAmount
orderInformation.billTo.address1
orderInformation.billTo.administrativeArea
orderInformation.billTo.country
orderInformation.billTo.email
orderInformation.billTo.firstName
orderInformation.billTo.lastName
orderInformation.billTo.locality
orderInformation.billTo.postalCode
orderInformation.invoiceDetails.purchaseOrderNumber: Required for purchase/procurement cards only.
orderInformation.invoiceDetails.taxable: Required if the sum of all
orderInformation.lineItems[].taxAmount
values >
0
.
orderInformation.lineItems[].taxAmount
paymentInformation.card.expirationMonth
paymentInformation.card.expirationYear
paymentInformation.card.number
processingInformation.purchaseLevel: Set field to
3
.

Related Information

API field reference guide for the REST API

Optional Fields for Processing a Credit with Level III Data

You can use these optional fields to include additional information when processing a credit with Level III data.

buyerInformation.vatRegistrationNumber
merchantInformation.cardAcceptorReferenceNumber
merchantInformation.vatRegistrationNumber
order.vatTaxAmountSign
orderInformation.amountDetails.discountAmount
orderInformation.amountDetails.dutyAmount
orderInformation.amountDetails.freightAmount
orderInformation.amountDetails.taxAppliedAfterDiscount
orderInformation.amountDetails.taxAppliedLevel
orderInformation.amountDetails.taxDetails[].amount
orderInformation.amountDetails.taxDetails[].rate
orderInformation.invoiceDetails.commodityCode
orderInformation.invoiceDetails.purchaseContactName
orderInformation.invoiceDetails.purchaseOrderDate
orderInformation.invoiceDetails.vatInvoiceReferenceNumber
orderInformation.lineItems[].commodityCode
orderInformation.lineItems[].discountAmount
orderInformation.lineItems[].discountRate
orderInformation.lineItems[].invoiceNumber
orderInformation.lineItems[].productCode
orderInformation.lineItems[].productName
orderInformation.lineItems[].quantity
orderInformation.lineItems[].taxAppliedAfterDiscount
orderInformation.lineItems[].taxDetails[].amount
orderInformation.lineItems[].taxRate
orderInformation.lineItems[].taxStatusIndicator
orderInformation.lineItems[].totalAmount
orderInformation.lineItems[].typeOfSupply
orderInformation.lineItems[].unitOfMeasure
orderInformation.lineItems[].unitPrice
orderInformation.shippingDetails.shipFromPostalCode
orderInformation.shipTo.administrativeArea
orderInformation.shipTo.postalCode
senderInformation.vatRegistrationNumber

Related Information

API field reference guide for the REST API

REST Example: Processing a Credit with Level III Data

Request

{
  "processingInformation": {
    "purchaseLevel": "3"
  },
  "paymentInformation": {
    "card": {
      "number": "411111111111XXXX",
      "expirationMonth": "03",
      "expirationYear": "2031"
    }
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "200",
      "currency": "USD",
      "nationalTaxIncluded": "0",
      "lineItems": [
        {
          "productCode": "service",
          "productName": "TestProduct1",
          "quantity": "2",
          "unitPrice": "40.00",
          "unitOfMeasure": "EA",
          "totalAmount": "100.00",
          "taxAmount": "20.00"
        }
      ],
      "invoiceDetails": {
        "purchaseOrderNumber": "L3PurchaseOrderNo",
        "purchaseOrderDate": "2024-11-15",
        "taxable": true
      }
    },
    "billTo": {
      "firstName": "John",
      "lastName": "Deo",
      "address1": "900 Metro Center Blvd",
      "locality": "Foster City",
      "administrativeArea": "CA",
      "postalCode": "48104-2201",
      "country": "US",
      "email": "[email protected]",
      "phoneNumber": "9321499232"
    }
  }
}

Response to a Successful Request

{
  "_links": {
    "void": {
      "method": "POST",
      "href": "/pts/v2/credits/7320300261536812104951/voids"
    },
    "self": {
      "method": "GET",
      "href": "/pts/v2/credits/7320300261536812104951"
    }
  },
  "clientReferenceInformation": {
    "code": "1732030026199"
  },
  "creditAmountDetails": {
    "currency": "USD",
    "creditAmount": "200.00"
  },
  "id": "7320300261536812104951",
  "orderInformation": {
    "amountDetails": {
      "currency": "USD"
    }
  },
  "paymentAccountInformation": {
    "card": {
      "type": "001"
    }
  },
  "paymentInformation": {
    "tokenizedCard": {
      "type": "001"
    },
    "card": {
      "type": "001"
    }
  },
  "reconciliationId": "7320300261536812104951",
  "status": "PENDING",
  "submitTimeUtc": "2024-11-19T15:27:06Z"
}