Skip to main content
POST
Process an eCheck sale

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

API support various types of use. Required fields are defined by the most basic call. For other uses be sure to send the required information defined in the schema and examples.

subMerchantId
string
required

Unique identifier of the submerchant.

amount
number
required

The amount to debit.

paymentToken
object
required

The payment credential to charge: a one-time token from the web component or a stored Jupico token.

description
string

Free-text description.

customerId
string

Unique identifier of the customer.

checkNumber
string

Check number to record with this debit.

checkType
string

Type of check used for the debit.

taxAmount
number

Sales tax portion of the amount.

referenceId
string

Your own reference for this transaction. Returned in responses and query results for reconciliation.

dynamicFee
Dynamic fee · object

Defines the platform fee that the service provider charges the merchant for the transaction. The fee is calculated using fixed and discountRatePerc and deducted from the merchant's transaction proceeds when payouts are calculated. It does not increase or otherwise modify the transaction amount submitted for processing.

processingDynamicFee
Dynamic processing fee · object

Defines the payment-processing fee that the service provider charges the merchant for the transaction. The fee is calculated using the supported fixed and percentage values, deducted from the merchant's transaction proceeds, and accounted for separately from the platform fee. It does not increase or otherwise modify the transaction amount submitted for processing.

billing
object

Billing contact and address details for the payer.

shipping
object

Shipping contact and address details for the order.

metadata
object

metadata is an object that can host as much as 50 key-value pairs, where the keys can be at most 40 char length and can’t include the characters “[“ or “]”, and the values must be strings and cannot exceed 500 chars Learn more about metadata

Response

200 - application/json

Successful eCheck operation

data
object

The response payload.

success
boolean

Whether the request was processed successfully. Declines return HTTP 200 with success: false.

message
string

Human-readable result message.

code
string

Machine-readable result code. See the Error Codes reference.

Last modified on August 31, 2026