Payment

Description

The Payment object represents a payment in the EBizCharge platform.

Properties

Type

Name

Description

string

MerchantId

Unique identifier of the merchant associated with this object.

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

Internal identifier of 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 in the runTransaction response.

string

Last4

Last four digits of the card number or bank account.

string

PaymentMethod

Specifies the payment method used.

Examples
  • Visa
  • MasterCard
  • American Express
  • Discover
  • Check

string

DatePaid

Timestamp indicating when the payment was made.

string

PaidAmount

Amount paid toward the associated Invoice object.

string

PaymentInternalId

Unique internal identifier for this Payment object (automatically assigned by EBizCharge).

string

ScheduledPaymentInternalId

Unique identifier for the RecurringBillingDetails object associated with this payment, if applicable.

string

PaymentRequestDateTime

Timestamp indicating when this Payment object was created (automatically assigned by EBizCharge).

string

CustNum

Customer reference number assigned by EBizCharge.

string

PaymentMethodId

Identifies the associated PaymentMethodProfile object used for this payment.

string

PaymentType

Type of payment used.

Possible Values
  • InvoicePayment
  • QuickPayment
  • Recurring

string

TypeId

Type of transaction associated with the payment.

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

string

PaymentSourceId

Identifies the software integration or other source that processed the payment.

string

TransactionLookupKey

Unique key for transactions submitted using EbizWebForm.

string

ExternalTxnId

External transaction identifier used to locate payments submitted using the EBizWebForm.

string

Description

Description of this payment.

string

CustomerEmailAddress

Email address for the customer.

string

DocumentTypeId

Identifies the associated PaidDocument object.

string

OrderId

Unique identifier for the transaction, with a maximum length of 64 characters.

Note: Required for Level 2 and Level 3.

string

CustomerName

Full name of the customer.