Sign in
Ecommerce

Run echeck transaction

Allows you to process an echeck transaction in any of the following situations:

  • An initial transaction that uses a saved echeck token.
  • A subsequent transaction that uses a saved echeck token.

For more information about how to implement this endpoint, see the Creating an echeck checkout page with your own form or Running an echeck transaction with the API topic.

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you can use the credentials for your Sandbox API user.<br/><br/>You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right. username: docs@nexiopay.com password: JZdzoXpdDeH6VA<br/><br/>Include at least an amount, currency, and tokenex.token (the saved echeck token) as body parameters.

<div style="display:none;">

Request parameters

  • data
  • data.amount
  • data.currency
  • data.cart
  • data.cart.items
  • data.cart.items.item
  • data.cart.items.description
  • data.cart.items.quantity
  • data.cart.items.price
  • data.cart.items.type
  • data.customer
  • data.customer.billToAddressOne
  • data.customer.billToAddressTwo
  • data.customer.billToCity
  • data.customer.billToCountry
  • data.customer.billToPhone
  • data.customer.billToPostal
  • data.customer.billToState
  • data.customer.companyName
  • data.customer.createdAtDate
  • data.customer.customerRef
  • data.customer.email
  • data.customer.firstName
  • data.customer.invoice
  • data.customer.lastName
  • data.customer.orderNumber
  • data.customer.phone
  • data.customer.shipToAddressOne
  • data.customer.shipToAddressTwo
  • data.customer.shipToCity
  • data.customer.shipToCountry
  • data.customer.shipToPhone
  • data.customer.shipToPostal
  • data.customer.shipToState
  • data.customFields
  • data.customFields.exampleKey
  • secCode
  • settlementCurrency
  • tokenex
  • tokenex.token
  • tokenex.customerRefNumber
  • tokenex.lastFour
  • bank
  • bank.accountHolderName
  • bank.routingNumber
  • processingOptions
  • processingOptions.verboseResponse
  • processingOptions.merchantId

Response parameters

  • amount
  • authCode
  • bank
  • bank.accountHolderName
  • bank.routingNumber
  • bank.accountNumber
  • currency
  • data
  • data.amount
  • data.cart
  • data.cart.items
  • data.cart.items.item
  • data.cart.items.description
  • data.cart.items.quantity
  • data.cart.items.price
  • data.cart.items.type
  • data.currency
  • data.customFields
  • data.customFields.exampleKey
  • data.customer
  • data.customer.billToAddressOne
  • data.customer.billToAddressTwo
  • data.customer.billToCity
  • data.customer.billToCountry
  • data.customer.billToPhone
  • data.customer.billToPostal
  • data.customer.billToState
  • data.customer.companyName
  • data.customer.createdAtDate
  • data.customer.customerRef
  • data.customer.email
  • data.customer.firstName
  • data.customer.invoice
  • data.customer.lastName
  • data.customer.orderNumber
  • data.customer.phone
  • data.customer.shipToAddressOne
  • data.customer.shipToAddressTwo
  • data.customer.shipToCity
  • data.customer.shipToCountry
  • data.customer.shipToPhone
  • data.customer.shipToPostal
  • data.customer.shipToState
  • data.lodging
  • data.lodging.advanceDeposit
  • data.lodging.checkInDate
  • data.lodging.checkOutDate
  • data.lodging.noShow
  • data.lodging.roomNumber
  • data.lodging.roomRate
  • data.settlementCurrency
  • gatewayResponse
  • gatewayResponse.gatewayName
  • gatewayResponse.refNumber
  • id
  • merchantId
  • transactionDate
  • transactionStatus
  • transactionType
</div>
post/pay/v3/processECheck

Request body

Response

success

idId — unresolved $ref
merchantIdMerchantId — unresolved $ref
authCodeAuthCode — unresolved $ref
transactionTypeTransactionType — unresolved $ref
transactionDateTransactionDate — unresolved $ref
transactionStatusTransactionStatus — unresolved $ref
gatewayResponseGatewayResponse — unresolved $ref
currencyCurrency — unresolved $ref
amountnumber

The transaction amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point.

If including a surcharge, this value needs to include the transaction amount plus the surcharge amount.

When submitting a transaction for an installment period, This amount is the total amount to be paid rather than the amount per transaction. The following values are expected for each gateway or connection that supports this feature:

  • Cybersource - Accepted amount may depend on the currency or installment period used for the transaction. Contact Cybersource for more information.
  • Openpay - By default, the amount must be 300 and the currency must be MXN. The minimum amount can be changed by Openpay.

Changes

No recorded changes to this endpoint across all 1 revision of this API.