Details about the payment.

totalAmount
number
required

Total amount to be charged. If a service fee is sent, then this amount should include the service fee."

categories
object[] | null

Array of payment categories/line items describing the amount to be paid Note: These categories are for information only and are not validated against the total amount provided.

checkImage
object | null

Object containing image of paper check.

checkNumber
string | null

A check number to be used in the ach transaction. Required for payment method = 'check'.

currency
string | null

Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is USD.

serviceFee
number | null

Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually.

splitFunding
object[] | null

Split funding instructions for the transaction. See Split a Transaction for more.

Was this page helpful?