We have several different RESTful API endpoints that you can use.

How to use the diagrams

In each diagram, navigate from the central bubble that is the base endpoint, then to the method (GET, POST, PUT, and DELETE), and then to any additional path parameters.

Each of the connections also has a short description of the operation.

However, some operations just use the base endpoint. For those, the method is given and then a pointer to a blank path parameter, which is meant to indicate that you do not add anything else for the described operation. These also have a parenthetical attached that gives the name of the operation as specified in the API.

View diagrams for the following endpoint groups:

• Payout
• Pay
• APM
• Auth
• Subscription
• Transaction
• Recovery
• Chargeback
• User
• Webhook

Payout

The payout endpoint is used to send a request from the payer (merchant or business, for example) to fund a recipient’s balance, wallet, or account. The endpoint group also allows for creating recipient records as well as viewing existing payouts and recipients.

Pay

The pay endpoint is for card and e-check transactions, as well as retail transactions.

APM

The apm endpoint is for transactions with alternative payment methods.

Auth

The auth endpoint logs in trusted users for retail transactions.

Subscription

The subscription endpoint is for subscription and payment plan transactions.

Transaction

The transaction endpoint is for getting reports about transactions.

Recovery

The recovery endpoint is for decline recovery operations.

Chargeback

The chargeback endpoint is for working with chargebacks and disputes.

User

The user endpoint is for working with Nexio user accounts.

Webhook

The webhook endpoint is for working with webhooks.