Run echeck transaction with iframe

get https://api.nexiopaysandbox.com/pay/v3/processECheck

Returns an iframe that can be used to securely process an echeck transaction.

For instructions on how to implement this endpoint, see the Creating an echeck checkout page with the iframe topic.

⚠️
Try It
To use the Try It feature for this endpoint, you must first request a one-time-use token. The system uses the processing and UI options sent in the request for the creation of the one-time-use or saved echeck token in the display and functionality of the iframe.

Query Params

token

string

required

Your one-time-use token. This is a query parameter. The system uses the processing and UI options sent in the request for the creation of the one-time-use or saved echeck token in the display and functionality of the iframe.

shouldReturnHtml

string

Defaults to false

By default, a success response always returns HTML. However, when there is an error with the request, the system returns a JSON object to the iframe and a 400 error. In order to get HTML for errors also, include this parameter and set the value to true in order to force the system to return the response as HTML. Since a success response is also HTML, setting this to true can make handling error situations easier. Otherwise, you need to create a listener for the JSON object and a 400 error response. For more information, see Handling errors and declines in Guides.

Responses

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.nexiopaysandbox.com/pay/v3/processECheck?shouldReturnHtml=false' \
3
     --header 'accept: text/html'

Click Try It! to start a request and see the response here! Or choose an example:

text/html

application/json

Run echeck transaction with iframe

⚠️
Try It

Request parameters

Response parameters

200Success

401Unauthorized. For help with this error and other error codes, see Common errors in the Guides area.