Get started with Payiano APIs

The Payiano API is structured following the REST architectural style, ensuring a streamlined and intuitive design. It features URLs that are focused on specific resources, making them predictable and easy to understand. When sending requests, the API accepts bodies encoded in the JSON format. In response, it provides data encoded in the JSON format, adhering to common web standards. Additionally, it employs standard HTTP response codes for clear communication of the status of requests.

This API also utilizes conventional HTTP methods (verbs) and authentication techniques to ensure secure and reliable interactions. There is a versatile feature of the Payiano API that allows users to operate in a test mode. This mode is particularly useful for development and testing purposes, as it has no impact on your actual live data and does not engage with banking networks. The mode in which the API operates, whether live or test, is determined by the baseURL during request. This flexibility enables safe testing and development without risking any interference with live operations or data.

Payiano APIs authenticate with a token in the Authorization header of your request, and return HTTP response codes and responses encoded in JSON . This documentation provides developers with a comprehensive reference for confidently consuming our API endpoints in a secure manner.

Each resource is accurately documented, offering insight into the corresponding endpoint, HTTP method, and the essential parameters required for making API calls. The documentation also lays out anticipated responses and how to handle errors effectively, placing a strong emphasis on security practices. Moreover, it frequently incorporates illustrative code samples in different programming languages, ensuring developers have practical guidance for implementing API interactions. This documentation serves as a valuable resource for developers, empowering them to navigate our API ecosystem with clarity and security in mind.

1curl https://api.payiano.com/v1 \ 2 -H "Authorization: Bearer ACCESS-TOKEN"

When you make API calls, replace ACCESS-TOKEN with your access token in the Authorization header: -H Authorization: Bearer ACCESS-TOKEN.

1. About Authorization tokens

Authorization access tokens are intended to access resources on behalf of your personal individual account, company or business. You first need to create an Application in your Sandbox or Production enviroment to be able to consume our API resources.

Keep your Authorization access token secure and safe.

2. Get Sandbox Authorization token

The Payiano Sandbox is like a make-believe place where developers can practice and try out real transactions without messing up the real system. It helps them test things thoroughly before using them for real, making sure everything works smoothly. This sandbox is a crucial tool that makes financial activities and systems more dependable and efficient.

This practice area is super important because it enables you test everything thoroughly. Developers and businesses can pretend to do real money-related things, like transferring funds or making payments, just like they would in the real world. But here's the cool part: if they make a mistake or something goes wrong, it doesn't affect real money or systems. It's like a safe, controlled space for them to experiment.

3. API Requests

To make a REST API request, you combine the HTTP GET, POST, PUT, PATCH, or DELETE method, the URL to the API service, the URI to a resource to query, submit data to, update, or delete, and one or more HTTP request headers.

The URL to the API service is either:

  • Sandbox: https://api.payiano.dev/v1
  • Live: https://api.payiano.com/v1

4. Access token

It serves as a secure and efficient way to verify the identity of an individual, device, partner, or application and grant access to specific resources or actions within our system. Access tokens are typically unique strings of characters that are generated by our system. We use Bearer tokens.

In our system, we use different access tokens for different jobs. These tokens act like special permissions, letting users or apps do specific tasks securely and accurately. This way, we can control access in fine detail, making sure each token fits the task it's used for perfectly.