Introduction

Make sure you have successfully onboarded and acquired API key.

This guide walks you through the core payment operations and essential integration steps. By the end of this guide, you will be able to fully interact with the Altery Payments System via API, enabling automation within your own system.

We provide concise yet detailed request examples to help you understand how to structure and submit API calls correctly. Step by step, you will become familiar with the required request formats and integration workflow.

In the Sandbox environment, execute the operations below step by step to observe the full end-to-end payment flow.

Please keep in mind that for each request you have to provide two headers: X-Key-Id and X-Signature, so our system will be able to recognize and authorize your requests. The signature implementation examples we have described in the general guide.

Steps to Make a Payment

Step №1 (Optional). Check your balance

Retrieve account balances across supported currencies.

Reference: https://altery.readme.io/reference/get_v1-user-balance-total

Step №2 (Optional): Make a preflight request

Get information about the possible result of a transaction before undertaking it. The preflight method does not check partner service availability and cannot predict approval of the transfer, yet it can:

• Check for possible errors in the transfer request.
• Calculate the transfer fee and conversion rate where it could be applied.

The method is not mandatory for conducting a mass payment, but we recommend using it before a transaction execution.

Reference: https://altery.readme.io/reference/post_v2-payments-preflight

Step №3: Create a new payment request

Start a payment execution: it accepts a list of transfers, validates and prepares them, and submits the operation for processing.

By default, you want to make a next order of actions:

1. Create a preflight request and make sure it is successful,
2. Copy preflight request body and use it for the create payment request operation,
3. ChangeexternalId in the body so our system will treat it as a unique request.

Reference: https://altery.readme.io/reference/post_v2-payments