Introduction

The NovaroPay API is a REST API. Requests and responses are JSON over HTTPS, and every request is authenticated with a secret key of a merchant account. It follows Stripe’s conventions wherever it can, so the errors, idempotency keys and versions work the way you know from Stripe; where we differ, the page says so.

The address

Every market’s accounts call the same address. The key tells us which account and market a request is for.

Base URL

https://api.63-180-91-99.sslip.io

Plain HTTP is not served. The API answers over IPv4 and IPv6.

The conventions

• Keys go in the Authorization header: Authentication.
• Failures come back as one error object with a conventional HTTP status: Errors.
• Retries of a request that changes something carry an Idempotency-Key, but for the few that take none: Idempotent requests.
• Lists answer a page at a time, newest first, with cursors: Pagination.
• Versions are pinned with the PSP-Version header: Versioning.
• Responses carry an X-Request-Id to quote when you write to us: Request IDs.
• New things appear without a new version: a new field in a response, a new optional parameter, a new value of a status or an error code. Write your code so that it ignores a field it does not know and handles a value it does not know.

The resources

Payments, Payouts and Status are listed under Resources as their endpoints go live. The Changelog names every change.