API Reference

Autenticação

Autenticação na API da PoolPay

A PoolPay é uma plataforma de pagamentos que oferece aos seus clientes a possibilidade de realizar pagamentos de forma segura e conveniente. Para acessar a API da PoolPay, é necessário autenticar a sua aplicação. A autenticação é realizada através do tipo de autenticação client_credentials.

Passo 1: Onboarding PoolPay

Antes de começar a utilizar a API da PoolPay, os nossos clientes precisam ter realizado o processo de KYC para receber um username e password.

Passo 2: Autenticar na API da PoolPay

Para autenticar na API da PoolPay, é necessário enviar uma solicitação HTTP POST para a URL do endpoint de autenticação, passando as seguintes informações no corpo da solicitação:

{
    "grant_type": "client_credentials",
    "client_id": "SEU_ID_DE_CLIENTE",
    "client_secret": "SUA_CHAVE_SECRETA"
}

Substitua "SEU_ID_DE_CLIENTE" e "SUA_CHAVE_SECRETA" pelas suas credenciais de cliente fornecidas pela PoolPay.

Envie a solicitação HTTP POST para a URL do endpoint de autenticação da PoolPay. Se a autenticação for bem-sucedida, você receberá uma resposta que contém um token de acesso.

Passo 3: Utilizar o token de acesso

O token de acesso recebido na resposta da solicitação de autenticação deve ser incluído no cabeçalho de todas as solicitações da API da PoolPay. Para incluir o token de acesso, adicione o seguinte cabeçalho nas suas solicitações:

Authorization: Bearer SEU_TOKEN_DE_ACESSO

Substitua "SEU_TOKEN_DE_ACESSO" pelo token de acesso recebido na resposta da solicitação de autenticação.

A autenticação usando o tipo de autenticação client_credentials é uma forma segura e eficiente de controlar o acesso à API da PoolPay. Lembre-se de manter suas credenciais de cliente em segurança e nunca compartilhá-las com terceiros.

Authentication in PoolPay API

PoolPay is a payment platform that offers its clients the possibility of making payments securely and conveniently. To access the PoolPay API, it is necessary to authenticate your application. Authentication is done through the client_credentials authentication type.

Step 1: Onboarding PoolPay

Before starting to use the PoolPay API, our clients need to have completed the KYC process to receive a username and password.

Step 2: Authenticate in PoolPay API

To authenticate in the PoolPay API, it is necessary to send an HTTP POST request to the authentication endpoint URL, passing the following information in the request body:

{
    "grant_type": "client_credentials",
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET"
}

Replace "YOUR_CLIENT_ID" and "YOUR_CLIENT_SECRET" with your client credentials provided by PoolPay.

Send the HTTP POST request to the PoolPay authentication endpoint URL. If authentication is successful, you will receive a response containing an access token.

Step 3: Use the access token

The access token received in the authentication request response must be included in the header of all PoolPay API requests. To include the access token, add the following header to your requests:

Authorization: Bearer YOUR_ACCESS_TOKEN

Replace "YOUR_ACCESS_TOKEN" with the access token received in the authentication request response.

Authentication using the client_credentials authentication type is a secure and efficient way to control access to the PoolPay API. Remember to keep your client credentials safe and never share them with third parties.

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!