REST API

orderInformation. invoiceDetails. purchaseOrderNumber

The values used by your customer to identify the order.
This field is supported only for
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
FDC Nashville Global
,
GPN
,
Visa Platform Connect
,
OmniPay Direct
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
, and
Worldpay VAP
.
This value is typically a purchase order number.
It is recommended that you do not populate the field with all zeros or nines.
IMPORTANT
Only alphanumeric characters are accepted on
FDC Nashville Global
. Do not include hyphens or other non-alphanumeric characters.
FDC Nashville Global
You must provide a value in this field or in the
clientReferenceInformation.code
field.

Specifications

  • Data Type:
    String
  • Data Length:
    • American Express Direct
      : 17
    • Elavon Americas
      : 17
    • Visa Platform Connect
      : 17
    • GPX
      : 17
    • Worldpay VAP
      : 17
    • GPN
      : 17 for Mastercard, 25 for Visa
    • OmniPay Direct
      : 17 for Mastercard, 25 for Visa
    • All other processors:
      25

Mapping Information

  • REST API Field:
    orderInformation.invoiceDetails.purchaseOrderNumber
  • SCMP API Field:
    user_po
  • Simple Order API Field:
    invoiceHeader_userPO

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:
  • American Express Direct
    :
    does not apply
  • Chase Paymentech Solutions
    :
    Customer Reference Number
  • Elavon Americas
    :
    Purchase Identifier
  • FDC Compass
    :
    Customer Reference Number
  • FDC Nashville Global
    :
    Customer Code
  • FDMS Nashville
    :
    does not apply
  • FDMS South
    :
    does not apply
  • GPN
    :
    Market Data - Customer Code and Reference Number
  • OmniPay Direct
    :
    Customer Code / Customer Reference ID
  • RBS WorldPay Atlanta
    :
    PC2 Customer ID
  • TSYS Acquiring Solutions
    :
    does not apply
  • Visa Platform Connect
    :
    customerCode
  • Worldpay VAP
    :
    customerReference