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.
Required if the sum of all
orderInformation.lineItems[].taxDetails[].amount
values =
0
.
Required for purchase/procurement cards only.
Required if the sum of all
orderInformation.lineItems.taxAmount
values =
0
.
Set field to
3
.

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[].taxAmount
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

REST Example: Processing a Credit with Level III Data

Request 
        
{
  "processingInformation": {
    "purchaseLevel": "3"
  },
  "paymentInformation": {
    "card": {
      "number": "411111111111XXXX",
      "expirationMonth": "12",
      "expirationYear": "2031"
    }
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "100.00",
      "currency": "usd"
    },
    "billTo": {
      "firstName": "RTS",
      "lastName": "VDP",
      "address1": "201 S. Division St.",
      "locality": "Ann Arbor",
      "administrativeArea": "MI",
      "postalCode": "48104-2201",
      "country": "US",
      "email": "
          "
    }
  }
}
Response to a Successful Request 
        
{
  "_links": {
    "void": {
      "method": "POST",
      "href": "/pts/v2/credits/6807067080966508003954/voids"
    },
    "self": {
      "method": "GET",
      "href": "/pts/v2/credits/6807067080966508003954"
    }
  },
  "clientReferenceInformation": {
    "code": "1680706708181"
  },
  "creditAmountDetails": {
    "currency": "usd",
    "creditAmount": "100.00"
  },
  "id": "6807067080966508003954",
  "orderInformation": {
    "amountDetails": {
      "currency": "usd"
    }
  },
  "paymentAccountInformation": {
    "card": {
      "type": "001"
    }
  },
  "paymentInformation": {
    "tokenizedCard": {
      "type": "001"
    },
    "card": {
      "type": "001"
    }
  },
  "processorInformation": {
    "approvalCode": "831000",
    "networkTransactionId": "016153570198200",
    "retrievalReferenceNumber": "309514102853",
    "responseCode": "00"
  },
  "reconciliationId": "6807067080966508003954",
  "status": "PENDING",
  "submitTimeUtc": "2023-04-05T14:58:28Z"
}