Add an Invoice Payment

post

https://sandbox-api.prioritycommerce.com/v1/checkout/v3/invoice/{id}/payment

Record a payment against an invoice. Supports partial and full payments to track invoice balance.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

Invoice ID.

Query Params

echo

boolean

Defaults to false

includeCustomerMatches

boolean

Defaults to false

Return customers that have this card vaulted in their account

Body Params

merchantId

string

required

Id of the merchant

amount

float

required

The payment amount. Must not be 0.

paymentType

string

Defaults to Sale

Type of transaction Values: Sale, Refund, CashAdvance, Prepaid, Adjustment, Void, Reversal, Authorization, SaleCompletion, PaymentTransaction, Withdrawal, Balance

authOnly

boolean

Defaults to false

Indicates that this payment should NOT be added to current batch. AuthOnly payment won't be settled.

isAuth

boolean

Defaults to false

Should this card be authorized?

tenderType

string

Values: Card, Check, Cash, Multiple, Loyalty, ACH

cardPresent

boolean

Is the credit card is present at the time of payment?

cardAccount

object

Card Account Object (Required if tenderType is Card)

bankAccount

object

Bank Account Object (Required if tenderType is Check or ACH)

entryClass

string

Defaults to WEB

Gets or sets the ACH entry class Values: CCD, PPD, TEL, WEB

isSettleFunds

boolean

Defaults to false

Should this transaction be settled?

customer

object

Associate the payment to an existing customer in your customer database.

customerName

string

Customer Name (256 char) (Does NOT associate payment to customer)

customerCode

string

Client provided customer reference number (Associates with Customer Number). Cannot be combined with invoiceId and clientReference if B2B is on

meta

string

Memo field

replayId

int32

A merchant-supplied identifier to uniquely identify a payment request to facilitate retries due to I/O related issues. This identifier must be unique. If supplied, we will check for a payment that matches this identifier. If found will return an identical response of the original request. Represents a bigInt value.

source

string

Defaults to API

Values: API, QuickPay, Recurring, Link2Pay, Terminal

clientReference

string

Client provided payment reference number; can be associated with multiple payments (17 char max)

invoice

string

Client provided invoice number (Generated by server if not provided,16 char max)

invoiceIds

array of strings

If there are multiple invoices, you can send in an array of existing invoice ids (Note: they must already exist in MX Merchant)

invoiceIds

orderIds

array of strings

If there are multiple orders, you can send in an array of existing order ids (Note: they must already exist in MX Merchant)

orderIds

tax

float

Tax Amount (included in amount)

taxExempt

boolean

Defaults to false

If true, tax amount must be 0

cardPresentType

string

Values: CardPresentKeyed, CardPresentSwiped, CardNotPresent

device

string

Gets/Sets the device identifier, this is the terminal id.

purchases

array

Gets/Sets the list of purchases. Used by level 3 data during settlement

purchases

shipAmount

float

Gets/Sets the ship amount, used by level 3 data during settlement

shipToCountry

string

Gets/Sets the 3-digit alphanumeric ship-to country code, i.e. USA, used by level 3 data during settlement

shipToZip

string

Gets/Sets the ship-to zip code, used by level 3 data during settlement

shouldVaultCard

boolean

Use this param to vault a new card to a new or existing customer. Send in customer.id to vault to an existing customer, and at a minimum, customer.firstName or customer.lastName to vault the card to a new customer.

tip

float

Gets/Sets the amount of the gratuity (included in amount).

vatAmount

float

Gets/Sets the vat amount, used by level 3 data during settlement

vatRate

float

Gets/Sets the VAT rate, used by level 3 data during settlement

201201

400400