Getting started

Use the Nexpay API to build integrations that handle complex cross-border payment flows — from creating payees and getting FX quotes to collecting funds and tracking payments through to completion.

The Nexpay API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and verbs (GET, POST, PUT, DELETE).

Making your first payment

The typical integration flow follows these steps:

1. Create a payee — set up the recipient of funds.
2. Get a quote — check the exchange rate and fees.
3. Upload documents — provide identity and purpose proof.
4. Create a payment — submit the payment with payer details.
5. Confirm and initiate checkout — redirect the payer to pay.

For a complete walkthrough, see the Quick start guide.

Key concepts

Before building your integration, familiarize yourself with these concepts:

• Terminology — understand Nexpay's key terms (payments, payers, payees, payouts, quotes).
• Currencies & countries — how amounts, currency codes, and country codes work.
• Idempotency — safely retry payment requests without duplicates.
• Errors — how to handle error codes and HTTP status codes.
• Rate limiting — understand API request limits.

Errors

Nexpay uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error given the information provided. Codes in the 5xx range indicate an error with Nexpay's servers.

To learn more about how Nexpay handles errors, check this article.

Versioning

Nexpay's API is versioned to support future backwards-incompatible changes. Currently, our API version is v2.