๐Ÿ•ด๏ธ GETTING STARTED

This page will help you get started with TurinPay. You'll be up and running in a jiffy!

โ„น๏ธ Overview

TurinPay offers a powerful REST API that supports bitcoin lightning network and standard on-chain operations with action events associated allowing you to receive and send microtransactions instantly.

Our API uses HTTP response codes and returns all error responses in JSON. To explore the API as much as possible.

Codesandbox from TurinPay

๐Ÿ”‘ Authentication

The TurinPay API uses API Keys to authenticate requests. You can view and manage your API Keys in the API keys section.

Authentication to the API is performed with a key. Provide your API key on the token header.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API Requests without authentication will also fail.

โš ๏ธ Errors

TurinPay uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the 2xxrange indicate success, in the 4xxrange indicate an error that failed given the information provided (usually a required parameter was omitted or incorrectly sent), in the 5xxrange indicate an error with TurinPay's servers.

Status Code

Meaning

HTTP Response

200 - OK

Everything worked as expected

{ data: { ... } }

201 - OK

Entity created with success

{ data: object }

400 - Bad Request

The request was unacceptable, often due to an incorrect or missing required parameter.

{ success: false, message: 'Error details' }

404 - Not Found

The requested resource doesn't exist

{ success: false, message: 'Error details' }

500 - Server Errors

Something went wrong with TurinPay's servers

{ success: false, message: 'Error details' }