Running an echeck transaction with the API

This topic guides you through the steps for running an echeck transaction directly through the API, such as running a manual payment or a merchant-initiated transaction.

To run a transaction using the API, follow the steps below:

1. In order to run an echeck transaction through the API, you need to have an echeck token. Save an echeck token with your own form, with the save echeck token iframe, or directly through the API. Echeck tokens can be used to process through any MID on your account. They are not restricted to a specific merchant account or currency.

2. Post payment details, along with the card token, to the Run card transaction endpoint.

   You must at least include the saved card token, transaction amount, and the payment type (for properly flagging initial and subsequent transactions).

   Example Request

   curl -X POST https://api.nexiopaysandbox.com/pay/v3/processECheck \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json' \
     -H 'Authorization: Basic [Base64_encoded_login]'
     -d '{
     "data": {
       "amount": 29.99
     },
     "tokenex": {
       "token": "6ee140a0-05d1-4958-8325-b38a690dbb9d"
     }
   }'
   

   The response includes the id parameter. This is the payment ID and you can use it to query the status of the transaction (using the View transaction by payment ID endpoint) within about a minute. You may also want to store the transactionId. You can only get this parameter after the transaction runs. You get it in the webhook with the transactionId (note that this parameter is not returned for legacy webhooks) or in the id returned in any of the following endpoints:

   • View transaction by payment ID
   • View transaction by transaction ID
   • View transactions