API diagrams

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 services and endpoint groups:

Payments APIs

Payouts APIs

  • Payout - Includes endpoints for Recipients, Payouts, and Spendbacks.

Reporting APIs

Management APIs

Dev Tools APIs

  • Webhook - Includes the Webhook Service endpoints.

Payments APIs

Pay

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

Pay service

Pay service
(click to view larger image)

Card

The card service is for viewing card or terminal tokens associated with the merchant account.

Card service

Card service
(click to view larger image)

Auth

The auth service is for creating a simple login for the Retail process.

Auth service

Auth service
(click to view larger image)

Subscription

The subscription service is for subscription and payment plan transactions.

Subscription service

Subscription service
(click to view larger image)

APM

The apm service is for transactions with alternative payment methods.

Alternative Payment Method service

APM service
(click to view larger image)

Payouts APIs

Payout

The payout service 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.

Payout service

Payout service
(click to view larger image)

Reporting APIs

Transaction

The transaction service is for getting reports about transactions.

Transaction service

Transaction service
(click to view larger image)

Recovery

The recovery service is for decline recovery operations.

Recovery service

Recovery service
(click to view larger image)

Chargeback

The chargeback service is for working with chargebacks and disputes.

Chargeback service

Chargeback service
(click to view larger image)

ACH

The ach service is for viewing deposit summaries.

ACH service

ACH service
(click to view larger image)

Management APIs

User

The user service is for working with Nexio user accounts.

User service

User service
(click to view larger image)

Merchant

The merchant service is for viewing a list of merchant accounts associated with the Nexio account.

Merchant service

Merchant service
(click to view larger image)

Dev Tools APIs

Webhook

The webhook service is for working with webhooks.

Webhook service

Webhook service
(click to view larger image)