PaymentRequest

Description

The PaymentRequest object contains the information for a payment request.

Properties

Type

Name

Description

string

MerchantId

Identifies the associated merchant.

string

CustomerId

Identifies the associated Customer object.

string

SubCustomerId

Identifies the associated SubCustomer object.

string

DivisionId

Unique identifier used within an organization's Enterprise Resource Planning (ERP) system to specifically designate a particular business unit, department, or division.

string

InvoiceNumber

Identifies the associated Invoice object.

string

InvoiceInternalId

Identifies the associated Invoice object.

string

InvoiceDate

Creation date of the invoice.

string

InvoiceDueDate

Due date for the invoice.

string

PoNum

Purchase order number.

string

SoNum

Sales order number.

string

InvoiceAmount

Total amount of the invoice.

string

AmountDue

Amount of the invoice due by the InvoiceDueDate.

string

Currency

Three-character ISO 4217 currency code.

string

AuthCode

Authorization code assigned by the issuing bank for the payment method.

string

RefNum

Reference number assigned by the gateway, returned by runTransaction.

string

Last4

Last four digits of the card number or bank account.

string

PaymentMethod

Specifies the payment method used.

Examples
  • Visa
  • MasterCard
  • American Express
  • Check

string

PaymentType

Type of payment used.

Possible Values
  • InvoicePayment
  • QuickPayment
  • Recurring

string

DatePaid

Timestamp indicating when the payment was made.

string

PaidAmount

Amount paid toward the associated Invoice object.

string

TypeId

Transaction type associated with the payment.

Possible Values
  • Invoice
  • Surcharge
  • InvCredit
  • EbizWebForm
  • QuickPay

string

Software

Name of the integration.

string

PaymentInternalId

Identifies the associated Payment object.