Express Checkout API Fields Supported By Digital Goods

Note: Express Checkout Digital Goods is no longer available for new integrations. This feature remains available for merchant accounts that already have Express Checkout Digital Goods enabled.

A subset of the Express Checkout API parameter fields are relevant in digital goods integrations.

Express Checkout NVP API Fields Supported By Digital Goods

SetExpressCheckout NVP Request Fields

SetExpressCheckout Request Fields

  • METHOD(Must be set to SetExpressCheckout)
  • TOKEN
  • RETURNURL
  • CANCELURL
  • LOCALECODE
  • NOSHIPPING
  • PAYMENTDETAILS

Payment Details Type Fields

  • PAYMENTREQUEST_n_AMT
  • PAYMENTREQUEST_n_CURRENCYCODE
  • PAYMENTREQUEST_n_ITEMAMT
  • PAYMENTREQUEST_n_TAXAMT
  • PAYMENTREQUEST_n_DESC
  • PAYMENTREQUEST_n_INVNUM
  • PAYMENTREQUEST_n_NOTIFYURL
  • PAYMENTREQUEST_n_PAYMENTACTION

Payment Details Item Type Fields

  • PAYMENTREQUEST_n_NAMEm
  • PAYMENTREQUEST_n_DESCm
  • PAYMENTREQUEST_n_AMTm
  • PAYMENTREQUEST_n_NUMBERm
  • PAYMENTREQUEST_n_QTYm
  • PAYMENTREQUEST_n_TAXAMTm
  • PAYMENTREQUEST_n_ITEMCATEGORYm

SetExpressCheckout NVP Response Fields

SetExpressCheckout Response Fields

  • TOKEN

GetExpressCheckoutDetails NVP Request Fields

GetExpressCheckoutDetails Request Fields

  • METHOD (Must be set to GetExpressCheckoutDetails)
  • TOKEN

GetExpressCheckoutDetails NVP Response Fields

GetExpressCheckoutDetails Response Fields

  • TOKEN
  • INVNUM
  • PHONENUM
  • NOTE
  • REDIRECTREQUIRED
  • CHECKOUTSTATUS

Payer Information Fields

  • EMAIL
  • PAYERID
  • PAYERSTATUS
  • COUNTRYCODE
  • BUSINESS

Payer Name Fields

  • SALUTATION
  • FIRSTNAME
  • MIDDLENAME
  • LASTNAME
  • SUFFIX

Payment Details Type Fields

  • PAYMENTREQUEST_n_AMT
  • PAYMENTREQUEST_n_CURRENCYCODE
  • PAYMENTREQUEST_n_ITEMAMT
  • PAYMENTREQUEST_n_TAXAMT
  • PAYMENTREQUEST_n_DESC
  • PAYMENTREQUEST_n_INVNUM
  • PAYMENTREQUEST_n_NOTIFYURL
  • PAYMENTREQUEST_n_TRANSACTIONID
  • PAYMENTREQUEST_n_PAYMENTREQUESTID

Payment Details Item Type Fields

  • L_PAYMENTREQUEST_n_NAMEm
  • L_PAYMENTREQUEST_n_DESCm
  • L_PAYMENTREQUEST_n_AMTm
  • L_PAYMENTREQUEST_n_NUMBERm
  • L_PAYMENTREQUEST_n_QTYm
  • L_PAYMENTREQUEST_n_TAXAMTm
  • L_PAYMENTREQUEST_n_ITEMCATEGORYm

NVP GetExpressCheckoutDetails Response Fields

  • TOKEN
  • INVNUM
  • PHONENUM
  • NOTE
  • REDIRECTREQUIRED
  • CHECKOUTSTATUS

DoExpressCheckoutPayment NVP Request Fields

DoExpressCheckoutPayment Request Fields

  • METHOD (Must be set to DoExpressCheckoutPayment)
  • TOKEN
  • RETURNURL
  • CANCELURL
  • NOSHIPPING
  • LOCALECODE

Payment Details Type Fields

  • PAYMENTREQUEST_n_AMT
  • PAYMENTREQUEST_n_CURRENCYCODE
  • PAYMENTREQUEST_n_ITEMAMT
  • PAYMENTREQUEST_n_TAXAMT
  • PAYMENTREQUEST_n_DESC
  • PAYMENTREQUEST_n_INVNUM
  • PAYMENTREQUEST_n_NOTIFYURL
  • PAYMENTREQUEST_n_PAYMENTACTION
  • PAYMENTREQUEST_n_PAYMENTREQUESTID

Payment Details Item Type Fields

  • PAYMENTREQUEST_n_NAMEm
  • PAYMENTREQUEST_n_DESCm
  • PAYMENTREQUEST_n_AMTm
  • PAYMENTREQUEST_n_NUMBERm
  • PAYMENTREQUEST_n_QTYm
  • PAYMENTREQUEST_n_TAXAMTm
  • PAYMENTREQUEST_n_ITEMCATEGORYm

DoExpressCheckoutPayment NVP Response Fields

DoExpressCheckoutPayment Response Fields

  • TOKEN
  • NOTE
  • REDIRECTREQUIRED

Payment Details Type Fields

  • PAYMENTREQUEST_n_AMT
  • PAYMENTREQUEST_n_CURRENCYCODE
  • PAYMENTREQUEST_n_ITEMAMT
  • PAYMENTREQUEST_n_TAXAMT
  • PAYMENTREQUEST_n_DESC
  • PAYMENTREQUEST_n_INVNUM
  • PAYMENTREQUEST_n_NOTIFYURL
  • PAYMENTREQUEST_n_PAYMENTACTION
  • PAYMENTREQUEST_n_PAYMENTREQUESTID

Payment Information Fields

  • PAYMENTINFO_n_TRANSACTIONID
  • PAYMENTINFO_n_TRANSACTIONTYPE
  • PAYMENTINFO_n_ORDERTIME
  • PAYMENTINFO_n_CURRENCYCODE
  • PAYMENTINFO_n_FEEAMT
  • PAYMENTINFO_n_SETTLEAMT
  • PAYMENTINFO_n_TAXAMT
  • PAYMENTINFO_n_EXCHANGERATE
  • PAYMENTINFO_n_PAYMENTSTATUS
  • PAYMENTINFO_n_PENDINGREASON
  • PAYMENTINFO_n_REASONCODE
  • PAYMENTINFO_n_FMFactionID
  • PAYMENTINFO_n_FMFactionNAME

Express Checkout NVP API Deprecated Request Fields

  • ALLOWNOTE
  • REQCONFIRMSHIPPING

Express Checkout SOAP API Fields Supported By Digital Goods

SetExpressCheckout SOAP Request Fields

SetExpressCheckout Request Fields

  • Token
  • ReturnURL
  • CancelURL
  • NoShipping
  • LocaleCode
  • PaymentDetails

Payment Details Type Fields

  • OrderTotal
  • ItemTotal
  • TaxTotal
  • OrderDescription
  • InvoiceID
  • NotifyURL
  • PaymentDetailsItem
  • PaymentAction

Payment Details Item Type Fields

  • Name
  • Description
  • Amount
  • Number
  • Quantity
  • Tax
  • ItemCategory

SetExpressCheckout SOAP Response Fields

SetExpressCheckout Response Fields

  • Token

GetExpressCheckoutDetails SOAP Request Fields

GetExpressCheckoutDetails Request Fields

  • Token

GetExpressCheckoutDetails SOAP Response Fields

GetExpressCheckoutDetails Response Fields

  • Token
  • InvoiceID
  • ContactPhone
  • Note
  • RedirectRequired
  • CheckoutStatus
  • PaymentDetails

Payer Information Fields

  • Payer
  • PayerID
  • PayerStatus
  • PayerCountry
  • PayerBusiness

Payer Name Fields

  • Salutation
  • FirstName
  • MiddleName
  • LastName
  • Suffix

Payment Details Type Fields

  • OrderTotal
  • ItemTotal
  • TaxTotal
  • OrderDescription
  • InvoiceID
  • NotifyURL
  • PaymentDetailsItem
  • TransactionID
  • PaymentRequestID

Payment Details Item Type Fields

  • Name
  • Description
  • Amount
  • Number
  • Quantity
  • Tax
  • ItemCategory

DoExpressCheckoutPayment SOAP Request Fields

DoExpressCheckoutPayment Request Fields

  • Token
  • PayerID
  • PaymentDetails
  • ReturnFMFDetails

Payment Details Type Fields

  • OrderTotal
  • ItemTotal
  • TaxTotal
  • OrderDescription
  • InvoiceID
  • NotifyURL
  • PaymentAction
  • PaymentDetailsItem
  • PaymentRequestID

Payment Details Item Type Fields

  • Name
  • Description
  • Amount
  • Number
  • Quantity
  • Tax
  • ItemCategory

DoExpressCheckoutPayment SOAP Response Fields

DoExpressCheckoutPayment Response Fields

  • Token
  • Note
  • RedirectRequired

Payment Information Fields

  • TransactionID
  • TransactionType
  • PaymentDate
  • GrossAmount
  • FeeAmount
  • SettleAmount
  • TaxAmount
  • ExchangeRate
  • PaymentStatus
  • PendingReason
  • ReasonCode

Express Checkout SOAP API Deprecated Request Fields

  • AllowNote
  • RegConfirmShipping