Payment Read

Summary

image-20240328-032006.png
image-20240328-032836.png
image-20240328-032836.png
image-20240710-160022.png

 

These set of APIs will let you:

  1. Get all payments.

  2. Get payment by an order number.

  3. Get all available payments made by type of payment.

  4. Get items and payment details into a single API endpoint.

 

EndPoints:

  • Payment/Get

  • GetByOrderNumber

  • GetAvailableTypes

  • GetItemPayment

 

Field

Data Type

Definition

PaymentID

Integer

Unique Id provided to a payment

EventCode

String

An 8 alpha numerical code provided to an event. (EX.AFTS0124 = 4 letter event code and month and year of the event)

OrderNumber

Integer

A unique ID provided to an order

PaymentType

String

Type of Payment (Visa, Master card….)

AccountNumber

String

Payment account number

ExpirationDate

 String

Expiration date for a credit card/ Debit card

FirstName

String

Payees First name

MiddleInitial

String

Payees middle initial

LastName

String

Payees last name

ChargeDate

String

Payment processed date and time.

ConfirmationNumber

String

Approval code provided by the payment processor

TotalDue

Number

Total amount due

AmountPaid

Number

Total amount paid

CashierId

String

Username (cashier) for manually processed payments.

Notes

String

Payment note

StatusFlag

String

Two digit code provided if the payment was approved (AP), canceled (CX)…

Fpbatch

String

Tag assigned to record based on method.

EftOrderNumber

String

Electronic funds transfer (EFT) number provided by the payment processor

Company

String

Payees Company

Address

String

Payees address (House/Building number, street name…)

City

String

Payees City

State

String

Payees State

Zip

String

Payees Zipcode

Country

String

Payees Country

Phone

String

Payees phone number

ModifiedBy

String

Username of who made a change to the payment

ModifiedDate

String

Date payment was modified

AvsAddReturnCode

String

Address verification service return code for verification of the address

AvsZipReturnCode

String

Address verification service return code for verification of the zip or postal code

CscReturnCode

String

Card security code verification return code

CscNumber

String

Card security code number

CreatedDate

String

Date and time when the payment was created.

ThirdPartyKey

String

Used to store third party key.

ExtraInfo1-5

String

Extra payment related information fields definable per event

RecordStatus

Integer

Status flag indicating whether the payment is active or not.

PaymentCode

String

Two digit payment code provided to type of a payment (American Express (AE), Check (CK), Cash (CA)

Description

String

Description of what type of payment (American Express, Check, Cash)

ItemCode

String

Unique code provided for an item by CDS (internal item identifier)

Price

Number

Price of an Item

Quantity

Integer

Number of Items purchased.

ItemStatus

String

Status flag for the item.

 

Related content