Introduction

Base URL: https://api.meupagamento.com.br

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer Bearer {YOUR_AUTH_TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

API Tokens

Gerenciamento de tokens de API para autenticação

Listar tokens de API do usuário

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/tokens" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/tokens"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Tokens de API obtidos com sucesso",
    "data": [
        {
            "id": 1,
            "name": "My API Token",
            "abilities": [
                "*"
            ],
            "expires_at": "2024-12-31T23:59:59.000000Z",
            "created_at": "2024-01-01T00:00:00.000000Z",
            "last_used_at": "2024-01-15T10:30:00.000000Z",
            "is_active": true
        }
    ]
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Criar novo token de API

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/tokens" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"My API Token\",
    \"abilities\": [
        \"read\",
        \"write\"
    ],
    \"expires_at\": \"2024-12-31T23:59:59Z\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/tokens"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "My API Token",
    "abilities": [
        "read",
        "write"
    ],
    "expires_at": "2024-12-31T23:59:59Z"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "message": "Token de API criado com sucesso",
    "data": {
        "token": "1|abcdef123456...",
        "name": "My API Token",
        "abilities": [
            "read",
            "write"
        ],
        "expires_at": "2024-12-31T23:59:59.000000Z"
    }
}

Example response (422):


{
    "message": "The given data was invalid.",
    "errors": {
        "name": [
            "Nome do token é obrigatório"
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/tokens

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

name string

Nome do token. Example: My API Token

abilities string[] optional

Opcional. Permissões do token.

expires_at string optional

Opcional. Data de expiração do token. Example: 2024-12-31T23:59:59Z

Obter informações do token atual

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/tokens/current" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/tokens/current"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Revogar token de API

requires authentication

Example request:

curl --request DELETE \
    "https://api.meupagamento.com.br/api/v1/tokens/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/tokens/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/v1/tokens/{tokenId}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

tokenId string

Example: architecto

Revogar todos os tokens de API do usuário

requires authentication

Example request:

curl --request DELETE \
    "https://api.meupagamento.com.br/api/v1/tokens" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/tokens"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Inicia o processo de autenticação com um provedor social (Google, Apple ou Facebook). Retorna a URL de redirecionamento para o provedor social.

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/auth/social/redirect/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/auth/social/redirect/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):


{
    "success": true,
    "data": {
        "redirect_url": "https://accounts.google.com/oauth/authorize?...",
        "provider": "google"
    }
}

Example response (500, error):


{
    "success": false,
    "message": "Erro ao iniciar autenticação social",
    "error": "Provedor social não suportado: twitter"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/auth/social/callback/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/auth/social/callback/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):


{
    "success": true,
    "message": "Login realizado com sucesso",
    "data": {
        "user": {
            "id": 1,
            "name": "João Silva",
            "email": "joao@example.com",
            "avatar_url": "https://lh3.googleusercontent.com/...",
            "social_provider": "google",
            "user_type": "debtor",
            "is_verified": true,
            "created_at": "2025-01-27T10:00:00.000000Z",
            "updated_at": "2025-01-27T10:00:00.000000Z"
        },
        "token": "1|abcdef123456...",
        "token_type": "Bearer"
    }
}

Example response (400, invalid_code):


{
    "success": false,
    "message": "Código de autorização não fornecido"
}

Example response (400, invalid_state):


{
    "success": false,
    "message": "Sessão expirada. Tente novamente."
}

Example response (500, error):


{
    "success": false,
    "message": "Erro ao processar autenticação social",
    "error": "Erro interno do servidor"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/auth/social/connected-accounts" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/auth/social/connected-accounts"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):


{
    "success": true,
    "data": {
        "connected_accounts": [
            {
                "provider": "google",
                "connected_at": "2025-01-27T10:00:00.000000Z",
                "avatar_url": "https://lh3.googleusercontent.com/..."
            }
        ],
        "has_social_login": true,
        "social_provider": "google"
    }
}

Example response (500, error):


{
    "success": false,
    "message": "Erro ao listar contas sociais"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/auth/social/disconnect/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/auth/social/disconnect/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, success):


{
    "success": true,
    "message": "Conta social desconectada com sucesso"
}

Example response (400, invalid_provider):


{
    "success": false,
    "message": "Provedor social inválido"
}

Example response (400, not_connected):


{
    "success": false,
    "message": "Usuário não possui login com este provedor"
}

Example response (500, error):


{
    "success": false,
    "message": "Erro ao desconectar conta social"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Endpoints

GET api/v1/health

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/health" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/health"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "status": "ok"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/test

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/test" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/test"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Test endpoint working"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Register a new user

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/auth/register" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"João Silva\",
    \"email\": \"joao@example.com\",
    \"password\": \"password123\",
    \"password_confirmation\": \"password123\",
    \"phone\": \"11999999999\",
    \"document\": \"12345678901\",
    \"user_type\": \"individual\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/auth/register"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "João Silva",
    "email": "joao@example.com",
    "password": "password123",
    "password_confirmation": "password123",
    "phone": "11999999999",
    "document": "12345678901",
    "user_type": "individual"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "message": "User registered successfully",
    "user": {
        "id": 1,
        "name": "João Silva",
        "email": "joao@example.com",
        "phone": "11999999999",
        "user_type": "individual",
        "is_active": true
    }
}

Example response (422):


{
    "message": "Validation failed",
    "errors": {
        "name": [
            "Nome é obrigatório"
        ],
        "email": [
            "Email é obrigatório"
        ],
        "password": [
            "Senha é obrigatória"
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/auth/register

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

name string

Nome completo do usuário. Example: João Silva

email string

Email do usuário. Example: joao@example.com

password string

Senha do usuário (mínimo 8 caracteres). Example: password123

password_confirmation string

Confirmação da senha. Example: password123

phone string optional

Opcional. Telefone do usuário. Example: 11999999999

document string optional

Opcional. Documento do usuário. Example: 12345678901

user_type string optional

Opcional. Tipo do usuário. Example: individual

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/auth/login" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"joao@example.com\",
    \"password\": \"password123\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/auth/login"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "joao@example.com",
    "password": "password123"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Login successful",
    "user": {
        "id": 1,
        "name": "João Silva",
        "email": "joao@example.com",
        "phone": "11999999999",
        "user_type": "individual",
        "is_active": true
    },
    "token": "1|abcdef123456..."
}

Example response (401):


{
    "message": "Credenciais inválidas"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/auth/login

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

email string

Email do usuário. Example: joao@example.com

password string

Senha do usuário. Example: password123

Reset password

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/auth/reset-password" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/auth/reset-password"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (422):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Validation failed",
    "errors": {
        "email": [
            "The email field is required."
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Verify password reset token

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/auth/verify-reset-token" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/auth/verify-reset-token"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (422):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Validation failed",
    "errors": {
        "email": [
            "The email field is required."
        ],
        "token": [
            "The token field is required."
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update password with reset token

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/auth/update-password-with-token" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/auth/update-password-with-token"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (422):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Validation failed",
    "errors": {
        "email": [
            "The email field is required."
        ],
        "token": [
            "The token field is required."
        ],
        "password": [
            "The password field is required."
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Logout user

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/auth/logout" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/auth/logout"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get authenticated user

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/auth/me" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/auth/me"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/user

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/user" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/user"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Display a listing of recipients.

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/recipients" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/recipients"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Store a newly created recipient.

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/recipients" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/recipients"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Validate document.

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/recipients/validate-document" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/recipients/validate-document"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Display the specified recipient.

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/recipients/564" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/recipients/564"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/recipients/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the recipient. Example: 564

Update the specified recipient.

requires authentication

Example request:

curl --request PUT \
    "https://api.meupagamento.com.br/api/v1/recipients/564" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/recipients/564"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/v1/recipients/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the recipient. Example: 564

Remove the specified recipient.

requires authentication

Example request:

curl --request DELETE \
    "https://api.meupagamento.com.br/api/v1/recipients/564" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/recipients/564"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/v1/recipients/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the recipient. Example: 564

Get recipient history.

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/recipients/564/history" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/recipients/564/history"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/recipients/{id}/history

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the recipient. Example: 564

Listar cobranças

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/charges" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Criar nova cobrança

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/charges" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Pagamento de serviços\",
    \"amount\": \"100.50\",
    \"due_date\": \"2024-12-31\",
    \"recipient_id\": 1,
    \"installments\": 3,
    \"payment_methods\": [
        \"pix\",
        \"credit_card\"
    ],
    \"metadata\": {
        \"order_id\": \"12345\"
    }
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "description": "Pagamento de serviços",
    "amount": "100.50",
    "due_date": "2024-12-31",
    "recipient_id": 1,
    "installments": 3,
    "payment_methods": [
        "pix",
        "credit_card"
    ],
    "metadata": {
        "order_id": "12345"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "message": "Cobrança criada com sucesso",
    "data": {
        "id": 1,
        "description": "Pagamento de serviços",
        "amount": 100.5,
        "due_date": "2024-12-31",
        "status": "pending",
        "recipient_id": 1,
        "created_at": "2024-01-01T00:00:00.000000Z"
    }
}

Example response (422):


{
    "message": "The given data was invalid.",
    "errors": {
        "description": [
            "Descrição é obrigatória"
        ],
        "amount": [
            "Valor é obrigatório"
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/charges

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

description string

Descrição da cobrança Example: Pagamento de serviços

amount numeric

Valor da cobrança Example: 100.50

due_date date

Data de vencimento Example: 2024-12-31

recipient_id integer

ID do destinatário Example: 1

installments integer optional

Opcional. Número de parcelas Example: 3

payment_methods string[] optional

Opcional. Métodos de pagamento aceitos

metadata object optional

Opcional. Metadados adicionais

POST api/v1/charges/test

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/charges/test" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/test"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v1/charges/new

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/charges/new" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/new"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter métricas de cobranças

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/charges/metrics" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/metrics"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter resumo das cobranças (alias para statistics)

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/charges/summary" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/summary"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter estatísticas das cobranças

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/charges/statistics" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/statistics"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter cobrança específica

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/charges/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/charges/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the charge. Example: architecto

Atualizar cobrança

requires authentication

Example request:

curl --request PUT \
    "https://api.meupagamento.com.br/api/v1/charges/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/v1/charges/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the charge. Example: architecto

Cancelar cobrança

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/charges/architecto/cancel" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/architecto/cancel"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/charges/{id}/cancel

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the charge. Example: architecto

Reenviar notificação de cobrança

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/charges/architecto/resend" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"channel\": \"email\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/architecto/resend"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "channel": "email"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Notificação reenviada com sucesso",
    "data": {
        "id": "<charge_id>",
        "channel": "email"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/charges/{id}/resend

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the charge. Example: architecto

Body Parameters

channel string

Canal de notificação. Ex.: email|sms|whatsapp Example: email

Gerar link de pagamento

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/charges/architecto/payment-link" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/architecto/payment-link"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/charges/{id}/payment-link

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the charge. Example: architecto

Calcular taxas

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/charges/architecto/fees" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/architecto/fees"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/charges/{id}/fees

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the charge. Example: architecto

Obter parcelas pendentes de uma cobrança

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/charges/architecto/pending-installments" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/architecto/pending-installments"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/charges/{id}/pending-installments

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the charge. Example: architecto

Obter resumo financeiro da cobrança

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/charges/architecto/financial-summary" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/architecto/financial-summary"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/charges/{id}/financial-summary

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the charge. Example: architecto

Obter métricas gerais do dashboard

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/metrics" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/metrics"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter métricas de cobranças

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/charges" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/charges"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter métricas de pagamentos

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/payments" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/payments"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter métricas de usuários

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/users" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/users"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter métricas de devedores

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/debtors" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/debtors"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter métricas de receita

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/revenue" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/revenue"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter métricas de performance

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/performance" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/performance"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter dados para gráficos

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/chart/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/chart/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/dashboard/chart/{type}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

type string

Example: architecto

Obter atividades recentes

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/activities" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/activities"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter alertas e notificações

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/alerts" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/alerts"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter métricas em tempo real

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/realtime" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/realtime"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter estatísticas de uso

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/usage" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/usage"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter resumo completo do dashboard

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/summary" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/summary"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter métricas do extrato

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/ledger" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/ledger"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter resumo do extrato

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/dashboard/ledger/summary" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/ledger/summary"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Limpar cache do dashboard

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/dashboard/clear-cache" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/dashboard/clear-cache"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Calcular taxas e valores de pagamento

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/calculator/calculate" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/calculator/calculate"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Calcular apenas taxas (método simplificado)

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/calculator/fees" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/calculator/fees"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter métodos de pagamento disponíveis

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/calculator/payment-methods" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/calculator/payment-methods"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter métodos de pagamento manual disponíveis

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/manual-payments/methods" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/manual-payments/methods"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Validar dados de pagamento manual

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/manual-payments/validate" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/manual-payments/validate"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get ledger summary for dashboard

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/ledger/summary" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/ledger/summary"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get specific ledger entry

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/ledger/1" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/ledger/1"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/ledger/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the ledger. Example: 1

GET api/v1/bank-accounts

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/bank-accounts" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/bank-accounts"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v1/bank-accounts

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/bank-accounts" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/bank-accounts"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/bank-accounts/{id}

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/bank-accounts/564" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/bank-accounts/564"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/bank-accounts/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the bank account. Example: 564

PUT api/v1/bank-accounts/{id}

requires authentication

Example request:

curl --request PUT \
    "https://api.meupagamento.com.br/api/v1/bank-accounts/564" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/bank-accounts/564"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/v1/bank-accounts/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the bank account. Example: 564

DELETE api/v1/bank-accounts/{id}

requires authentication

Example request:

curl --request DELETE \
    "https://api.meupagamento.com.br/api/v1/bank-accounts/564" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/bank-accounts/564"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/v1/bank-accounts/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the bank account. Example: 564

GET api/v1/penalty-settings

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/penalty-settings" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/penalty-settings"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

PUT api/v1/penalty-settings

requires authentication

Example request:

curl --request PUT \
    "https://api.meupagamento.com.br/api/v1/penalty-settings" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/penalty-settings"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Exibir cobrança pública por ID (ULID)

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/public/charge/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/public/charge/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Cobrança não encontrada",
    "error": "CHARGE_NOT_FOUND"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/public/charge/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the charge. Example: architecto

Calcular taxas e valores de pagamento

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/public/calculator/calculate" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/public/calculator/calculate"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (422):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "success": false,
    "message": "Parâmetros inválidos",
    "errors": {
        "total_amount": [
            "The total amount field is required."
        ],
        "installments": [
            "The installments field is required."
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Calcular apenas taxas (método simplificado)

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/public/calculator/fees" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/public/calculator/fees"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (422):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "success": false,
    "message": "Parâmetros inválidos",
    "errors": {
        "total_amount": [
            "The total amount field is required."
        ],
        "installments": [
            "The installments field is required."
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter métodos de pagamento disponíveis

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/public/calculator/payment-methods" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/public/calculator/payment-methods"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "success": true,
    "data": [
        {
            "value": "pix",
            "name": "PIX",
            "description": "Pagamento instantâneo via PIX",
            "fee_percentage": "0.9900",
            "min_fee": "0.30",
            "max_fee": null,
            "is_instant": true,
            "requires_qr_code": true,
            "is_card": false,
            "is_manual": false,
            "metadata": {
                "icon": "pix",
                "color": "#32BCAD",
                "gateway": "pix"
            }
        },
        {
            "value": "pix_manual",
            "name": "PIX Manual",
            "description": "PIX com confirmação manual",
            "fee_percentage": "0.0000",
            "min_fee": "0.00",
            "max_fee": null,
            "is_instant": true,
            "requires_qr_code": true,
            "is_card": false,
            "is_manual": true,
            "metadata": {
                "icon": "pix",
                "color": "#32BCAD",
                "gateway": "pix_manual"
            }
        },
        {
            "value": "credit_card",
            "name": "Cartão de Crédito",
            "description": "Pagamento com cartão de crédito",
            "fee_percentage": "3.4900",
            "min_fee": "0.50",
            "max_fee": null,
            "is_instant": true,
            "requires_qr_code": false,
            "is_card": true,
            "is_manual": false,
            "metadata": {
                "icon": "credit-card",
                "color": "#007BFF",
                "gateway": "stripe",
                "supports_installments": true
            }
        },
        {
            "value": "debit_card",
            "name": "Cartão de Débito",
            "description": "Pagamento com cartão de débito",
            "fee_percentage": "1.9900",
            "min_fee": "0.30",
            "max_fee": null,
            "is_instant": true,
            "requires_qr_code": false,
            "is_card": true,
            "is_manual": false,
            "metadata": {
                "icon": "credit-card",
                "color": "#28A745",
                "gateway": "stripe",
                "supports_installments": false
            }
        },
        {
            "value": "bank_slip",
            "name": "Boleto Bancário",
            "description": "Pagamento via boleto bancário",
            "fee_percentage": "1.4500",
            "min_fee": "0.30",
            "max_fee": null,
            "is_instant": false,
            "requires_qr_code": false,
            "is_card": false,
            "is_manual": false,
            "metadata": {
                "icon": "barcode",
                "color": "#FFC107",
                "gateway": "boleto",
                "processing_days": 1
            }
        },
        {
            "value": "manual",
            "name": "Pagamento Manual",
            "description": "Pagamento com confirmação manual",
            "fee_percentage": "0.0000",
            "min_fee": "0.00",
            "max_fee": null,
            "is_instant": true,
            "requires_qr_code": false,
            "is_card": false,
            "is_manual": true,
            "metadata": {
                "icon": "hand",
                "color": "#6C757D",
                "gateway": "manual"
            }
        }
    ],
    "message": "Métodos de pagamento obtidos com sucesso"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/banks

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/banks" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/banks"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "current_page": 1,
    "data": [
        {
            "id": 116,
            "COMPE": "237",
            "ISPB": "60746948",
            "Document": "60.746.948/0001-12",
            "LongName": "Banco Bradesco S.A.",
            "ShortName": "BCO BRADESCO S.A.",
            "Network": "Banco Múltiplo",
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 1,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": "Banco folha e Destinatário",
            "Products": "Capital de Giro,Cheque Especial,Consignado,Imobiliário,Pessoal,Troca de Modalidade,Veículos",
            "Url": "https://www.bradesco.com.br",
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": "2020-11-03 06:30:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 1,
            "COMPE": "001",
            "ISPB": "00000000",
            "Document": "00.000.000/0001-91",
            "LongName": "Banco do Brasil S.A.",
            "ShortName": "BCO DO BRASIL S.A.",
            "Network": "Banco Múltiplo",
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 1,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": "Banco folha e Destinatário",
            "Products": "Capital de Giro,Cheque Especial,Consignado,Imobiliário,Outros Créditos,Pessoal,Troca de Modalidade,Veículos",
            "Url": "https://www.bb.com.br",
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": "2020-11-03 06:30:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 17,
            "COMPE": "033",
            "ISPB": "90400888",
            "Document": "90.400.888/0001-42",
            "LongName": "BANCO SANTANDER (BRASIL) S.A.",
            "ShortName": "BCO SANTANDER (BRASIL) S.A.",
            "Network": "Banco Múltiplo",
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 1,
            "DetectaFlow": 1,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": "Banco folha e Destinatário",
            "Products": "Capital de Giro,Cheque Especial,Consignado,Imobiliário,Pessoal,Troca de Modalidade,Veículos",
            "Url": "https://www.santander.com.br",
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": "2020-11-03 06:30:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 57,
            "COMPE": "104",
            "ISPB": "00360305",
            "Document": "00.360.305/0001-04",
            "LongName": "Caixa Econômica Federal",
            "ShortName": "CAIXA ECONOMICA FEDERAL",
            "Network": "Caixa Econômica Federal",
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 1,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": "Banco folha e Destinatário",
            "Products": "Capital de Giro,Cheque Especial,Consignado,Imobiário,Pessoal,Troca de Modalidade,Veículos",
            "Url": "https://caixa.gov.br",
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": "2020-11-03 06:30:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 180,
            "COMPE": "341",
            "ISPB": "60701190",
            "Document": "60.701.190/0001-04",
            "LongName": "ITAÚ UNIBANCO S.A.",
            "ShortName": "ITAÚ UNIBANCO S.A.",
            "Network": "Banco Múltiplo",
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 1,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": "Banco folha e Destinatário",
            "Products": "Capital de Giro,Cheque Especial,Consignado,Imobiliário,Outros Créditos,Pessoal,Troca de Modalidade,Veículos",
            "Url": "https://www.itau.com.br",
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": "2020-11-03 06:30:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 403,
            "COMPE": "644",
            "ISPB": "54647259",
            "Document": "54.647.259/0001-58",
            "LongName": "321 SOCIEDADE DE CRÉDITO DIRETO S.A.",
            "ShortName": "321 SCD S.A.",
            "Network": null,
            "Type": null,
            "PixType": "Internet",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2024-06-13",
            "DatePixStarted": null,
            "DateRegistered": "2024-06-07 12:08:28",
            "DateUpdated": "2024-06-07 12:08:28",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 475,
            "COMPE": "769",
            "ISPB": "24313102",
            "Document": "24.313.102/0001-25",
            "LongName": "99PAY INSTITUICAO DE PAGAMENTO S.A.",
            "ShortName": "99PAY IP S.A.",
            "Network": null,
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2025-08-18",
            "DatePixStarted": "2025-08-18 10:10:00",
            "DateRegistered": "2025-08-18 12:09:55",
            "DateUpdated": "2025-08-19 12:09:19",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 359,
            "COMPE": "574",
            "ISPB": "48756121",
            "Document": "48.756.121/0001-94",
            "LongName": "A55 SOCIEDADE DE CRÉDITO DIRETO S.A.",
            "ShortName": "A55 SCD S.A.",
            "Network": null,
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2025-02-21",
            "DatePixStarted": "2025-02-21 11:00:00",
            "DateRegistered": "2025-02-17 12:08:34",
            "DateUpdated": "2025-02-18 12:08:11",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 230,
            "COMPE": "406",
            "ISPB": "37715993",
            "Document": "37.715.993/0001-98",
            "LongName": "ACCREDITO - SOCIEDADE DE CRÉDITO DIRETO S.A.",
            "ShortName": "ACCREDITO SCD S.A.",
            "Network": null,
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2020-11-27",
            "DatePixStarted": "2023-03-15 10:00:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 175,
            "COMPE": "332",
            "ISPB": "13140088",
            "Document": "13.140.088/0001-99",
            "LongName": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO",
            "ShortName": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO",
            "Network": null,
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": "Banco folha e Destinatário",
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2019-08-16",
            "DatePixStarted": "2020-11-03 06:30:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2022-12-13 12:06:52",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 414,
            "COMPE": "663",
            "ISPB": "44782130",
            "Document": "44.782.130/0001-07",
            "LongName": "ACTUAL DISTRIBUIDORA DE TÍTULOS E VALORES MOBILIÁRIOS S.A.",
            "ShortName": "ACTUAL DTVM S.A.",
            "Network": null,
            "Type": null,
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2024-12-16",
            "DatePixStarted": null,
            "DateRegistered": "2024-12-10 12:09:00",
            "DateUpdated": "2024-12-10 12:09:00",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 64,
            "COMPE": "117",
            "ISPB": "92856905",
            "Document": "92.856.905/0001-86",
            "LongName": "ADVANCED CORRETORA DE CÂMBIO LTDA",
            "ShortName": "ADVANCED CC LTDA",
            "Network": null,
            "Type": null,
            "PixType": "Internet",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": "https://advancedcorretora.com.br/",
            "DateOperationStarted": "2011-10-03",
            "DatePixStarted": null,
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2021-05-05 09:11:12",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 132,
            "COMPE": "272",
            "ISPB": "00250699",
            "Document": "00.250.699/0001-48",
            "LongName": "AGK CORRETORA DE CAMBIO S.A.",
            "ShortName": "AGK CC S.A.",
            "Network": null,
            "Type": null,
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2018-11-21",
            "DatePixStarted": null,
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2021-05-05 09:11:12",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 353,
            "COMPE": "565",
            "ISPB": "74014747",
            "Document": "74.014.747/0001-35",
            "LongName": "ÁGORA CORRETORA DE TITULOS E VALORES MOBILIARIOS S.A.",
            "ShortName": "ÁGORA CTVM S.A.",
            "Network": null,
            "Type": null,
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2023-11-20",
            "DatePixStarted": null,
            "DateRegistered": "2023-11-14 12:06:11",
            "DateUpdated": "2023-11-14 12:06:11",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 383,
            "COMPE": "599",
            "ISPB": "36321990",
            "Document": "36.321.990/0001-07",
            "LongName": "AGORACRED S/A SOCIEDADE DE CRÉDITO, FINANCIAMENTO E INVESTIMENTO",
            "ShortName": "AGORACRED S/A SCFI",
            "Network": null,
            "Type": null,
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2024-08-07",
            "DatePixStarted": null,
            "DateRegistered": "2024-08-05 12:07:23",
            "DateUpdated": "2024-08-05 12:07:23",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 184,
            "COMPE": "349",
            "ISPB": "27214112",
            "Document": "27.214.112/0001-00",
            "LongName": "AL5 S.A. CRÉDITO, FINANCIAMENTO E INVESTIMENTO",
            "ShortName": "AL5 S.A. CFI",
            "Network": null,
            "Type": "IDRT",
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": "Banco folha e Destinatário",
            "Products": "Capital de Giro,Consignado,Imobiliário,Outros,Pessoal,Troca de Modalidade,Veículos",
            "Url": null,
            "DateOperationStarted": "2019-10-24",
            "DatePixStarted": "2023-08-01 15:22:55",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2023-10-21 12:05:56",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 358,
            "COMPE": "572",
            "ISPB": "51414521",
            "Document": "51.414.521/0001-26",
            "LongName": "ALL IN CRED SOCIEDADE DE CREDITO DIRETO S.A.",
            "ShortName": "ALL IN CRED SCD S.A.",
            "Network": null,
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2023-12-22",
            "DatePixStarted": "2024-12-10 11:00:00",
            "DateRegistered": "2023-12-18 12:06:50",
            "DateUpdated": "2024-12-05 12:08:35",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 160,
            "COMPE": "313",
            "ISPB": "16927221",
            "Document": "16.927.221/0001-40",
            "LongName": "AMAZÔNIA CORRETORA DE CÂMBIO LTDA.",
            "ShortName": "AMAZÔNIA CC LTDA.",
            "Network": null,
            "Type": null,
            "PixType": "Internet",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2020-08-28",
            "DatePixStarted": null,
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2021-05-05 09:11:12",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 289,
            "COMPE": "482",
            "ISPB": "42259084",
            "Document": "42.259.084/0001-22",
            "LongName": "ARTTA SOCIEDADE DE CRÉDITO DIRETO S.A",
            "ShortName": "ARTTA SCD",
            "Network": null,
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2022-10-11",
            "DatePixStarted": "2024-12-11 11:00:00",
            "DateRegistered": "2022-10-04 12:08:42",
            "DateUpdated": "2025-05-08 12:09:16",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 379,
            "COMPE": "594",
            "ISPB": "48703388",
            "Document": "48.703.388/0001-13",
            "LongName": "ASA SOCIEDADE DE CRÉDITO FINANCIAMENTO E INVESTIMENTO S.A.",
            "ShortName": "ASA SCFI S.A.",
            "Network": null,
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2024-03-11",
            "DatePixStarted": "2024-07-05 09:00:00",
            "DateRegistered": "2024-03-05 12:06:35",
            "DateUpdated": "2025-08-27 12:09:03",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 273,
            "COMPE": "461",
            "ISPB": "19540550",
            "Document": "19.540.550/0001-21",
            "LongName": "ASAAS GESTÃO FINANCEIRA INSTITUIÇÃO DE PAGAMENTO S.A.",
            "ShortName": "ASAAS IP S.A.",
            "Network": null,
            "Type": "DRCT",
            "PixType": "Internet",
            "Charge": 1,
            "CreditDocument": 0,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2021-10-29",
            "DatePixStarted": "2021-11-01 09:00:00",
            "DateRegistered": "2021-11-22 11:00:23",
            "DateUpdated": "2025-09-20 12:08:16",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 304,
            "COMPE": "513",
            "ISPB": "44728700",
            "Document": "44.728.700/0001-72",
            "LongName": "ATF SOCIEDADE DE CRÉDITO DIRETO S.A.",
            "ShortName": "ATF SCD S.A.",
            "Network": null,
            "Type": "IDRT",
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 0,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2022-12-02",
            "DatePixStarted": "2025-04-25 10:36:24",
            "DateRegistered": "2022-11-30 12:07:13",
            "DateUpdated": "2025-04-25 23:36:40",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 316,
            "COMPE": "527",
            "ISPB": "44478623",
            "Document": "44.478.623/0001-40",
            "LongName": "ATICCA - SOCIEDADE DE CRÉDITO DIRETO S.A.",
            "ShortName": "ATICCA SCD S.A.",
            "Network": null,
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 0,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2023-02-06",
            "DatePixStarted": "2025-06-04 10:00:00",
            "DateRegistered": "2023-03-03 14:56:55",
            "DateUpdated": "2025-05-08 12:09:18",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 100,
            "COMPE": "188",
            "ISPB": "33775974",
            "Document": "33.775.974/0001-04",
            "LongName": "ATIVA INVESTIMENTOS S.A. CORRETORA DE TÍTULOS, CÂMBIO E VALORES",
            "ShortName": "ATIVA S.A. INVESTIMENTOS CCTVM",
            "Network": null,
            "Type": null,
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2017-07-28",
            "DatePixStarted": null,
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2021-05-05 09:11:12",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 299,
            "COMPE": "508",
            "ISPB": "61384004",
            "Document": "61.384.004/0001-05",
            "LongName": "AVENUE SECURITIES DISTRIBUIDORA DE TÍTULOS E VALORES MOBILIÁRIOS LTDA.",
            "ShortName": "AVENUE SECURITIES DTVM LTDA.",
            "Network": null,
            "Type": null,
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2022-08-18",
            "DatePixStarted": null,
            "DateRegistered": "2022-08-13 12:30:35",
            "DateUpdated": "2022-08-13 12:30:35",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 351,
            "COMPE": "562",
            "ISPB": "18684408",
            "Document": "18.684.408/0001-95",
            "LongName": "AZIMUT BRASIL DISTRIBUIDORA DE TÍTULOS E VALORES MOBILIÁRIOS LTDA",
            "ShortName": "AZIMUT BRASIL DTVM LTDA",
            "Network": null,
            "Type": "IDRT",
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2024-01-08",
            "DatePixStarted": "2025-01-27 08:12:51",
            "DateRegistered": "2024-01-09 12:06:15",
            "DateUpdated": "2025-01-27 12:34:41",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 275,
            "COMPE": "463",
            "ISPB": "40434681",
            "Document": "40.434.681/0001-10",
            "LongName": "AZUMI DISTRIBUIDORA DE TíTULOS E VALORES MOBILIáRIOS LTDA.",
            "ShortName": "AZUMI DTVM",
            "Network": null,
            "Type": null,
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2021-12-21",
            "DatePixStarted": null,
            "DateRegistered": "2022-01-05 11:00:34",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 119,
            "COMPE": "246",
            "ISPB": "28195667",
            "Document": "28.195.667/0001-06",
            "LongName": "Banco ABC Brasil S.A.",
            "ShortName": "BCO ABC BRASIL S.A.",
            "Network": "Banco Múltiplo",
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": null,
            "Products": "Capital de Giro,Cheque Especial,Consignado,Outros Créditos,Pessoal,Troca de Modalidade",
            "Url": "https://www.abcbrasil.com.br",
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": "2020-11-03 06:30:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 32,
            "COMPE": "075",
            "ISPB": "03532415",
            "Document": "03.532.415/0001-02",
            "LongName": "BANCO ABN AMRO CLEARING S.A.",
            "ShortName": "BANCO ABN AMRO CLEARING S.A.",
            "Network": "Banco Múltiplo",
            "Type": null,
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": "https://www.abnamro.com",
            "DateOperationStarted": "2005-11-11",
            "DatePixStarted": null,
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-06-24 12:07:23",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 150,
            "COMPE": "299",
            "ISPB": "04814563",
            "Document": "04.814.563/0001-74",
            "LongName": "BANCO AFINZ S.A. - BANCO MÚLTIPLO",
            "ShortName": "BCO AFINZ S.A. - BM",
            "Network": null,
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 0,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 0,
            "SalaryPortability": null,
            "Products": "Consignado,Pessoal e Veículos",
            "Url": null,
            "DateOperationStarted": "2018-12-03",
            "DatePixStarted": "2023-05-15 10:00:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 67,
            "COMPE": "121",
            "ISPB": "10664513",
            "Document": "10.664.513/0001-50",
            "LongName": "Banco Agibank S.A.",
            "ShortName": "BCO AGIBANK S.A.",
            "Network": "Banco Comercial",
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 1,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": "Destinatário",
            "Products": "Cheque Especial,Consignado,Pessoal,Troca de Modalidade",
            "Url": "https://www.agibank.com.br",
            "DateOperationStarted": "2012-04-04",
            "DatePixStarted": "2020-11-03 06:30:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 15,
            "COMPE": "025",
            "ISPB": "03323840",
            "Document": "03.323.840/0001-83",
            "LongName": "Banco Alfa S.A.",
            "ShortName": "BCO ALFA S.A.",
            "Network": "Banco Comercial",
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": null,
            "Products": "Consignado,Pessoal,Veículos",
            "Url": null,
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": "2020-11-03 06:30:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 27,
            "COMPE": "065",
            "ISPB": "48795256",
            "Document": "48.795.256/0001-69",
            "LongName": "Banco AndBank (Brasil) S.A.",
            "ShortName": "BCO ANDBANK S.A.",
            "Network": "Banco Múltiplo",
            "Type": null,
            "PixType": "RSFN",
            "Charge": 0,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": "Capita de Giro PJ,Crédito Consignado,Crédito Imobiliário,Crédito Pessoal,Financiamento de Veículos,Troca de Modalidade",
            "Url": null,
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": null,
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2025-06-17 12:10:04",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 110,
            "COMPE": "213",
            "ISPB": "54403563",
            "Document": "54.403.563/0001-50",
            "LongName": "Banco Arbi S.A.",
            "ShortName": "BCO ARBI S.A.",
            "Network": "Banco Comercial",
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": "Banco folha e Destinatário",
            "Products": "Consignado",
            "Url": "https://www.bancoarbi.com.br",
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": "2020-11-03 06:30:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 50,
            "COMPE": "096",
            "ISPB": "00997185",
            "Document": "00.997.185/0001-50",
            "LongName": "Banco B3 S.A.",
            "ShortName": "BCO B3 S.A.",
            "Network": "Banco Comercial",
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 0,
            "SalaryPortability": null,
            "Products": null,
            "Url": "https://www.bmfbovespa.com.br/bancobmfbovespa/",
            "DateOperationStarted": "2004-11-12",
            "DatePixStarted": "2023-09-11 11:00:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 14,
            "COMPE": "024",
            "ISPB": "10866788",
            "Document": "10.866.788/0001-77",
            "LongName": "Banco Bandepe S.A.",
            "ShortName": "BCO BANDEPE S.A.",
            "Network": "Banco Múltiplo",
            "Type": null,
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": "https://www.santander.com.br",
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": null,
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2021-05-05 09:11:12",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 173,
            "COMPE": "330",
            "ISPB": "00556603",
            "Document": "00.556.603/0001-74",
            "LongName": "BANCO BARI DE INVESTIMENTOS E FINANCIAMENTOS S.A.",
            "ShortName": "BANCO BARI S.A.",
            "Network": null,
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 0,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": null,
            "Products": "Consignado,Imobiliário,Pessoal,Troca de Modalidade,Veículos",
            "Url": null,
            "DateOperationStarted": "2019-07-22",
            "DatePixStarted": "2021-02-25 09:00:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 176,
            "COMPE": "334",
            "ISPB": "15124464",
            "Document": "15.124.464/0001-87",
            "LongName": "BANCO BESA S.A.",
            "ShortName": "BANCO BESA S.A.",
            "Network": null,
            "Type": null,
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2023-02-22",
            "DatePixStarted": null,
            "DateRegistered": "2023-03-03 14:56:55",
            "DateUpdated": "2023-03-03 14:56:55",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 396,
            "COMPE": "630",
            "ISPB": "58497702",
            "Document": "58.497.702/0001-02",
            "LongName": "BANCO BLUEBANK S.A.",
            "ShortName": "BCO BLUEBANK S.A.",
            "Network": "Banco Múltiplo",
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": "2020-11-03 06:30:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2025-03-24 17:11:52",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 121,
            "COMPE": "250",
            "ISPB": "50585090",
            "Document": "50.585.090/0001-06",
            "LongName": "BANCO BMG CONSIGNADO S.A.",
            "ShortName": "BANCO BMG CONSIGNADO S.A.",
            "Network": "Banco Múltiplo",
            "Type": null,
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": null,
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-07-30 12:30:20",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 162,
            "COMPE": "318",
            "ISPB": "61186680",
            "Document": "61.186.680/0001-74",
            "LongName": "Banco BMG S.A.",
            "ShortName": "BCO BMG S.A.",
            "Network": "Banco Múltiplo",
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": "Banco folha e Destinatário",
            "Products": "Consignado,Imobiliário,Pessoal,Troca de Modalidade,Veículos",
            "Url": "https://www.bancobmg.com.br",
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": "2020-11-03 06:30:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 115,
            "COMPE": "233",
            "ISPB": "62421979",
            "Document": "62.421.979/0001-29",
            "LongName": "BANCO BMG SOLUÇÕES FINANCEIRAS S.A.",
            "ShortName": "BANCO BMG SOLUÇÕES FINANCEIRAS S.A.",
            "Network": "Banco Múltiplo",
            "Type": null,
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": null,
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2025-04-08 12:08:49",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 461,
            "COMPE": "752",
            "ISPB": "01522368",
            "Document": "01.522.368/0001-82",
            "LongName": "Banco BNP Paribas Brasil S.A.",
            "ShortName": "BCO BNP PARIBAS BRASIL S A",
            "Network": "Banco Múltiplo",
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 1,
            "SalaryPortability": null,
            "Products": "Capital de Giro,Consiginado,Outros Créditos,Pessoal,Troca de Modalidade,veículos",
            "Url": "https://www.bnpparibas.com.br",
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": "2024-06-24 09:00:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 59,
            "COMPE": "107",
            "ISPB": "15114366",
            "Document": "15.114.366/0001-69",
            "LongName": "Banco Bocom BBM S.A.",
            "ShortName": "BCO BOCOM BBM S.A.",
            "Network": "Banco Múltiplo",
            "Type": null,
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 0,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": null,
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 25,
            "COMPE": "063",
            "ISPB": "04184779",
            "Document": "04.184.779/0001-01",
            "LongName": "Banco Bradescard S.A.",
            "ShortName": "BANCO BRADESCARD",
            "Network": "Banco Múltiplo",
            "Type": null,
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": "Imobiliário,Pessoal,Troca de Modalidade,Veículos",
            "Url": null,
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": null,
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2025-02-25 12:08:29",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 18,
            "COMPE": "036",
            "ISPB": "06271464",
            "Document": "06.271.464/0001-19",
            "LongName": "Banco Bradesco BBI S.A.",
            "ShortName": "BCO BBI S.A.",
            "Network": "Banco Múltiplo",
            "Type": null,
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": "https://www.bradescobbi.com.br",
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": null,
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2021-05-05 09:11:12",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 68,
            "COMPE": "122",
            "ISPB": "33147315",
            "Document": "33.147.315/0001-15",
            "LongName": "Banco Bradesco BERJ S.A.",
            "ShortName": "BCO BRADESCO BERJ S.A.",
            "Network": "Banco Múltiplo",
            "Type": null,
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": null,
            "Url": null,
            "DateOperationStarted": "2011-11-08",
            "DatePixStarted": null,
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2022-06-23 13:48:15",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 219,
            "COMPE": "394",
            "ISPB": "07207996",
            "Document": "07.207.996/0001-50",
            "LongName": "Banco Bradesco Financiamentos S.A.",
            "ShortName": "BCO BRADESCO FINANC. S.A.",
            "Network": "Banco Múltiplo",
            "Type": null,
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": "Consignado,Pessoal,Troca de Modalidade,Veículos",
            "Url": "https://www.bradescofinanciamentos.com.br",
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": null,
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2023-10-21 12:05:56",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 205,
            "COMPE": "378",
            "ISPB": "01852137",
            "Document": "01.852.137/0001-37",
            "LongName": "BANCO BRASILEIRO DE CRÉDITO SOCIEDADE ANÔNIMA",
            "ShortName": "BCO BRASILEIRO DE CRÉDITO S.A.",
            "Network": null,
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": null,
            "CreditDocument": null,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": null,
            "PCRP": null,
            "SalaryPortability": null,
            "Products": "Capita de Giro PJ,Crédito Pessoal,Financiamento de Veículos,Outros,Troca de Modalidade",
            "Url": null,
            "DateOperationStarted": "2020-09-11",
            "DatePixStarted": "2024-03-18 06:00:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-08-31 12:29:47",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 112,
            "COMPE": "218",
            "ISPB": "71027866",
            "Document": "71.027.866/0001-34",
            "LongName": "Banco BS2 S.A.",
            "ShortName": "BCO BS2 S.A.",
            "Network": "Banco Múltiplo",
            "Type": "DRCT",
            "PixType": "RSFN",
            "Charge": 1,
            "CreditDocument": 1,
            "LegalCheque": 0,
            "DetectaFlow": 0,
            "PCR": 1,
            "PCRP": 0,
            "SalaryPortability": "Destinatário",
            "Products": "Consignado",
            "Url": "https://www.bs2.com/banco/",
            "DateOperationStarted": "2002-04-22",
            "DatePixStarted": "2020-11-03 06:30:00",
            "DateRegistered": "2021-05-05 09:11:12",
            "DateUpdated": "2024-05-15 16:49:45",
            "created_at": null,
            "updated_at": null
        }
    ],
    "first_page_url": "https://api.meupagamento.com.br/api/v1/banks?page=1",
    "from": 1,
    "last_page": 10,
    "last_page_url": "https://api.meupagamento.com.br/api/v1/banks?page=10",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "page": null,
            "active": false
        },
        {
            "url": "https://api.meupagamento.com.br/api/v1/banks?page=1",
            "label": "1",
            "page": 1,
            "active": true
        },
        {
            "url": "https://api.meupagamento.com.br/api/v1/banks?page=2",
            "label": "2",
            "page": 2,
            "active": false
        },
        {
            "url": "https://api.meupagamento.com.br/api/v1/banks?page=3",
            "label": "3",
            "page": 3,
            "active": false
        },
        {
            "url": "https://api.meupagamento.com.br/api/v1/banks?page=4",
            "label": "4",
            "page": 4,
            "active": false
        },
        {
            "url": "https://api.meupagamento.com.br/api/v1/banks?page=5",
            "label": "5",
            "page": 5,
            "active": false
        },
        {
            "url": "https://api.meupagamento.com.br/api/v1/banks?page=6",
            "label": "6",
            "page": 6,
            "active": false
        },
        {
            "url": "https://api.meupagamento.com.br/api/v1/banks?page=7",
            "label": "7",
            "page": 7,
            "active": false
        },
        {
            "url": "https://api.meupagamento.com.br/api/v1/banks?page=8",
            "label": "8",
            "page": 8,
            "active": false
        },
        {
            "url": "https://api.meupagamento.com.br/api/v1/banks?page=9",
            "label": "9",
            "page": 9,
            "active": false
        },
        {
            "url": "https://api.meupagamento.com.br/api/v1/banks?page=10",
            "label": "10",
            "page": 10,
            "active": false
        },
        {
            "url": "https://api.meupagamento.com.br/api/v1/banks?page=2",
            "label": "Next &raquo;",
            "page": 2,
            "active": false
        }
    ],
    "next_page_url": "https://api.meupagamento.com.br/api/v1/banks?page=2",
    "path": "https://api.meupagamento.com.br/api/v1/banks",
    "per_page": 50,
    "prev_page_url": null,
    "to": 50,
    "total": 476
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Estatísticas de uso dos bancos

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/banks/statistics" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/banks/statistics"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "most_used_banks": [
        {
            "id": 125,
            "COMPE": "260",
            "LongName": "NU PAGAMENTOS S.A. - INSTITUIÇÃO DE PAGAMENTO",
            "ShortName": "NU PAGAMENTOS - IP",
            "PixType": "RSFN",
            "usage_count": 1,
            "default_count": 1
        },
        {
            "id": 17,
            "COMPE": "033",
            "LongName": "BANCO SANTANDER (BRASIL) S.A.",
            "ShortName": "BCO SANTANDER (BRASIL) S.A.",
            "PixType": "RSFN",
            "usage_count": 1,
            "default_count": 0
        },
        {
            "id": 57,
            "COMPE": "104",
            "LongName": "Caixa Econômica Federal",
            "ShortName": "CAIXA ECONOMICA FEDERAL",
            "PixType": "RSFN",
            "usage_count": 1,
            "default_count": 1
        },
        {
            "id": 220,
            "COMPE": "395",
            "LongName": "F.D'GOLD - DISTRIBUIDORA DE TÍTULOS E VALORES MOBILIÁRIOS LTDA.",
            "ShortName": "F D GOLD DTVM LTDA",
            "PixType": "Internet",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 108,
            "COMPE": "208",
            "LongName": "Banco BTG Pactual S.A.",
            "ShortName": "BANCO BTG PACTUAL S.A.",
            "PixType": "RSFN",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 476,
            "COMPE": "772",
            "LongName": "COOPERATIVA DE CRÉDITO MÚTUO DOS EMPREGADOS DO CENTRO UNIVERSITÁRIO NEWTON PAIVA LTDA. - CREDIPAIVA",
            "ShortName": "CC MECUNP",
            "PixType": "RSFN",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 364,
            "COMPE": "579",
            "LongName": "QUADRA SOCIEDADE DE CRÉDITO DIRETO S.A.",
            "ShortName": "QUADRA SCD",
            "PixType": "Internet",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 252,
            "COMPE": "435",
            "LongName": "DELCRED SOCIEDADE DE CRÉDITO DIRETO S.A.",
            "ShortName": "DELCRED SCD S.A.",
            "PixType": "RSFN",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 140,
            "COMPE": "283",
            "LongName": "RB INVESTIMENTOS DISTRIBUIDORA DE TITULOS E VALORES MOBILIARIOS LIMITADA",
            "ShortName": "RB INVESTIMENTOS DTVM LTDA.",
            "PixType": "RSFN",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 28,
            "COMPE": "066",
            "LongName": "BANCO MORGAN STANLEY S.A.",
            "ShortName": "BCO MORGAN STANLEY S.A.",
            "PixType": "RSFN",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 396,
            "COMPE": "630",
            "LongName": "BANCO BLUEBANK S.A.",
            "ShortName": "BCO BLUEBANK S.A.",
            "PixType": "RSFN",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 284,
            "COMPE": "475",
            "LongName": "Banco Yamaha Motor do Brasil S.A.",
            "ShortName": "BCO YAMAHA MOTOR S.A.",
            "PixType": "RSFN",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 172,
            "COMPE": "329",
            "LongName": "QI Sociedade de Crédito Direto S.A.",
            "ShortName": "QI SCD S.A.",
            "PixType": "RSFN",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 60,
            "COMPE": "108",
            "LongName": "PORTOCRED S.A. - CREDITO, FINANCIAMENTO E INVESTIMENTO",
            "ShortName": "PORTOCRED S.A. - CFI",
            "PixType": "RSFN",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 428,
            "COMPE": "679",
            "LongName": "PAY INSTITUICAO DE PAGAMENTO S.A.",
            "ShortName": "PAY IP S.A.",
            "PixType": "Internet",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 316,
            "COMPE": "527",
            "LongName": "ATICCA - SOCIEDADE DE CRÉDITO DIRETO S.A.",
            "ShortName": "ATICCA SCD S.A.",
            "PixType": "RSFN",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 204,
            "COMPE": "377",
            "LongName": "BMS SOCIEDADE DE CRÉDITO DIRETO S.A.",
            "ShortName": "BMS SCD S.A.",
            "PixType": "RSFN",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 92,
            "COMPE": "159",
            "LongName": "Casa do Crédito S.A. Sociedade de Crédito ao Microempreendedor",
            "ShortName": "CASA CREDITO S.A. SCM",
            "PixType": "RSFN",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 460,
            "COMPE": "751",
            "LongName": "Scotiabank Brasil S.A. Banco Múltiplo",
            "ShortName": "SCOTIABANK BRASIL",
            "PixType": "RSFN",
            "usage_count": 0,
            "default_count": 0
        },
        {
            "id": 348,
            "COMPE": "559",
            "LongName": "KANASTRA FINANCEIRA S.A, CREDITO, FINANCIAMENTO E INVESTIMENTO",
            "ShortName": "KANASTRA CFI",
            "PixType": "RSFN",
            "usage_count": 0,
            "default_count": 0
        }
    ],
    "total_banks": 476,
    "total_accounts": 3
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/banks/{id}

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/banks/1" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/banks/1"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "id": 1,
    "COMPE": "001",
    "ISPB": "00000000",
    "Document": "00.000.000/0001-91",
    "LongName": "Banco do Brasil S.A.",
    "ShortName": "BCO DO BRASIL S.A.",
    "Network": "Banco Múltiplo",
    "Type": "DRCT",
    "PixType": "RSFN",
    "Charge": 1,
    "CreditDocument": 1,
    "LegalCheque": 1,
    "DetectaFlow": 0,
    "PCR": 1,
    "PCRP": 1,
    "SalaryPortability": "Banco folha e Destinatário",
    "Products": "Capital de Giro,Cheque Especial,Consignado,Imobiliário,Outros Créditos,Pessoal,Troca de Modalidade,Veículos",
    "Url": "https://www.bb.com.br",
    "DateOperationStarted": "2002-04-22",
    "DatePixStarted": "2020-11-03 06:30:00",
    "DateRegistered": "2021-05-05 09:11:12",
    "DateUpdated": "2024-05-15 16:49:45",
    "created_at": null,
    "updated_at": null
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/banks/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the bank. Example: 1

Processar webhook do PagarMe

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/webhooks/pagarme" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/webhooks/pagarme"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "status": "success",
    "message": "Webhook recebido e será processado"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Processar webhook do Stripe

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/webhooks/stripe" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/webhooks/stripe"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "status": "success",
    "message": "Webhook recebido e será processado"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Processar webhook do Mercado Pago

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/webhooks/mercadopago" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/webhooks/mercadopago"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "status": "success",
    "message": "Webhook recebido e será processado"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Processar webhook genérico

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/webhooks/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/webhooks/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "status": "success",
    "message": "Webhook recebido e será processado"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/webhooks/{gateway}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

gateway string

Example: architecto

Register a new user

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/register" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"João Silva\",
    \"email\": \"joao@example.com\",
    \"password\": \"password123\",
    \"password_confirmation\": \"password123\",
    \"phone\": \"11999999999\",
    \"document\": \"12345678901\",
    \"user_type\": \"individual\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/register"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "João Silva",
    "email": "joao@example.com",
    "password": "password123",
    "password_confirmation": "password123",
    "phone": "11999999999",
    "document": "12345678901",
    "user_type": "individual"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "message": "User registered successfully",
    "user": {
        "id": 1,
        "name": "João Silva",
        "email": "joao@example.com",
        "phone": "11999999999",
        "user_type": "individual",
        "is_active": true
    }
}

Example response (422):


{
    "message": "Validation failed",
    "errors": {
        "name": [
            "Nome é obrigatório"
        ],
        "email": [
            "Email é obrigatório"
        ],
        "password": [
            "Senha é obrigatória"
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/register

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

name string

Nome completo do usuário. Example: João Silva

email string

Email do usuário. Example: joao@example.com

password string

Senha do usuário (mínimo 8 caracteres). Example: password123

password_confirmation string

Confirmação da senha. Example: password123

phone string optional

Opcional. Telefone do usuário. Example: 11999999999

document string optional

Opcional. Documento do usuário. Example: 12345678901

user_type string optional

Opcional. Tipo do usuário. Example: individual

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/login" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"joao@example.com\",
    \"password\": \"password123\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/login"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "joao@example.com",
    "password": "password123"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Login successful",
    "user": {
        "id": 1,
        "name": "João Silva",
        "email": "joao@example.com",
        "phone": "11999999999",
        "user_type": "individual",
        "is_active": true
    },
    "token": "1|abcdef123456..."
}

Example response (401):


{
    "message": "Credenciais inválidas"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/login

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

email string

Email do usuário. Example: joao@example.com

password string

Senha do usuário. Example: password123

Extrato

Listar extrato do credor (com filtro opcional por cobrança)

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/ledger" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/ledger"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Financiamento

GET api/v1/financings

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/financings" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/financings"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v1/financings

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/financings" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/financings"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v1/financings/simulate

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/financings/simulate" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"interest_rate_monthly\": 4326.41688
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/financings/simulate"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "interest_rate_monthly": 4326.41688
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/financings/simulate

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

interest_rate_monthly number

Taxa ao mês. Aceita 0.02 (2%) ou 2 (2%). Example: 4326.41688

GET api/v1/financings/{id}

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/financings/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/financings/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/financings/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the financing. Example: architecto

POST api/v1/financings/{id}/generate-charge

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/financings/architecto/generate-charge" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/financings/architecto/generate-charge"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/financings/{id}/generate-charge

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the financing. Example: architecto

POST api/v1/financings/{id}/anticipate

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/financings/architecto/anticipate" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"count\": 16,
    \"amount\": 4326.41688
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/financings/architecto/anticipate"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "count": 16,
    "amount": 4326.41688
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/financings/{id}/anticipate

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the financing. Example: architecto

Body Parameters

count integer optional

Número de parcelas a antecipar. Exemplo: 3 Example: 16

amount number optional

Valor para antecipar. Exemplo: 1500.00 Example: 4326.41688

POST api/v1/financings/{id}/anticipate/apply

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/financings/architecto/anticipate/apply" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount\": 4326.41688,
    \"mode\": \"architecto\",
    \"manual_payment_method\": \"architecto\",
    \"manual_payment_notes\": \"architecto\",
    \"manual_payment_date\": \"architecto\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/financings/architecto/anticipate/apply"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "amount": 4326.41688,
    "mode": "architecto",
    "manual_payment_method": "architecto",
    "manual_payment_notes": "architecto",
    "manual_payment_date": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/financings/{id}/anticipate/apply

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the financing. Example: architecto

Body Parameters

amount number

Valor a antecipar. Exemplo: 1500.00 Example: 4326.41688

mode string

Estratégia: reduce_term ou reduce_installment Example: architecto

manual_payment_method string optional

Opcional. Método para registrar pagamento manual Example: architecto

manual_payment_notes string optional

Opcional. Observações do pagamento Example: architecto

manual_payment_date date optional

Opcional. Data do pagamento manual Example: architecto

My Charges

Endpoints para visualização de cobranças do usuário autenticado. As cobranças são vinculadas dinamicamente por email (verificado ou social login) ou telefone (verificado).

Listar cobranças do usuário

requires authentication

Lista todas as cobranças vinculadas ao usuário autenticado. As cobranças são vinculadas por:

Email verificado OU login social
Telefone verificado

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/my-charges" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/my-charges"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter estatísticas das cobranças

requires authentication

Retorna estatísticas das cobranças do usuário autenticado.

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/my-charges/statistics" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/my-charges/statistics"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Visualizar cobrança específica

requires authentication

Exibe detalhes de uma cobrança específica do usuário autenticado.

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/my-charges/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/my-charges/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/my-charges/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the my charge. Example: architecto

PIX Manual

Gerenciamento de pagamentos PIX Manual

Criar pagamento PIX Manual

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/pix-manual/create" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"charge_id\": 1,
    \"installment_id\": 1,
    \"pix_manual_amount\": 100,
    \"pix_key\": \"12345678901\",
    \"pix_manual_notes\": \"Pagamento via PIX\",
    \"pix_manual_date\": \"2024-01-01\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/pix-manual/create"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "charge_id": 1,
    "installment_id": 1,
    "pix_manual_amount": 100,
    "pix_key": "12345678901",
    "pix_manual_notes": "Pagamento via PIX",
    "pix_manual_date": "2024-01-01"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "message": "Pagamento PIX Manual criado com sucesso",
    "data": {
        "id": 1,
        "charge_id": 1,
        "installment_id": 1,
        "amount": 10000,
        "status": "pending",
        "payment_method": "pix_manual",
        "pix_key": "PIX-000001-20240101120000",
        "pix_manual_confirmation_code": "ABC12345",
        "created_at": "2024-01-01T00:00:00.000000Z"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/pix-manual/create

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

charge_id integer

ID da cobrança. Example: 1

installment_id integer

ID da parcela. Example: 1

pix_manual_amount number optional

Opcional. Valor do pagamento. Example: 100

pix_key string optional

Opcional. Chave PIX. Example: 12345678901

pix_manual_notes string optional

Opcional. Observações. Example: Pagamento via PIX

pix_manual_date string optional

Opcional. Data do pagamento. Example: 2024-01-01

Confirmar pagamento PIX Manual

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/pix-manual/1/confirm" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"confirmation_code\": \"ABC12345\",
    \"confirmation_notes\": \"Pagamento confirmado\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/pix-manual/1/confirm"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "confirmation_code": "ABC12345",
    "confirmation_notes": "Pagamento confirmado"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Pagamento PIX Manual confirmado com sucesso",
    "data": {
        "id": 1,
        "status": "approved",
        "pix_manual_confirmed_at": "2024-01-01T00:00:00.000000Z"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/pix-manual/{id}/confirm

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

ID do pagamento. Example: 1

Body Parameters

confirmation_code string optional

Opcional. Código de confirmação. Example: ABC12345

confirmation_notes string optional

Opcional. Observações da confirmação. Example: Pagamento confirmado

Cancelar pagamento PIX Manual

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/pix-manual/1/cancel" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reason\": \"Pagamento não realizado\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/pix-manual/1/cancel"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reason": "Pagamento não realizado"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Pagamento PIX Manual cancelado com sucesso",
    "data": {
        "id": 1,
        "status": "cancelled",
        "pix_manual_cancelled_at": "2024-01-01T00:00:00.000000Z"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/pix-manual/{id}/cancel

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

ID do pagamento. Example: 1

Body Parameters

reason string optional

Opcional. Motivo do cancelamento. Example: Pagamento não realizado

Listar pagamentos PIX Manual pendentes

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/pix-manual/pending" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/pix-manual/pending"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Pagamentos PIX Manual pendentes obtidos com sucesso",
    "data": [
        {
            "id": 1,
            "charge_id": 1,
            "installment_id": 1,
            "amount": 10000,
            "status": "pending",
            "pix_key": "PIX-000001-20240101120000",
            "pix_manual_confirmation_code": "ABC12345",
            "created_at": "2024-01-01T00:00:00.000000Z"
        }
    ]
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Estatísticas de PIX Manual

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/pix-manual/statistics" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/pix-manual/statistics"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Estatísticas de PIX Manual obtidas com sucesso",
    "data": {
        "total_payments": 10,
        "pending_payments": 3,
        "approved_payments": 6,
        "cancelled_payments": 1,
        "total_amount": 100000,
        "pending_amount": 30000,
        "approved_amount": 60000
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Pagamentos Manuais

Cobranças (Charges) Permite registrar pagamentos manuais para parcelas específicas, informando seus IDs. Para distribuir automaticamente um valor entre parcelas (quitar + abater), utilize o endpoint de Alocação Automática.

Processar quitação manual de parcelas

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/charges/architecto/manual-payment" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"installment_ids\": [
        \"architecto\"
    ],
    \"manual_payment_method\": \"architecto\",
    \"manual_payment_notes\": \"architecto\",
    \"manual_payment_date\": \"architecto\",
    \"manual_payment_amount\": 4326.41688
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/architecto/manual-payment"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "installment_ids": [
        "architecto"
    ],
    "manual_payment_method": "architecto",
    "manual_payment_notes": "architecto",
    "manual_payment_date": "architecto",
    "manual_payment_amount": 4326.41688
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Pagamentos processados com sucesso",
    "data": {
        "payments": [
            {
                "id": 123,
                "installment_id": 456,
                "amount": 300,
                "payment_method": "manual",
                "status": "approved"
            }
        ],
        "charge": {
            "id": "01K5T9B6R8XCBSZ0FXZGH9RKC7"
        }
    }
}

Example response (422):


{
    "message": "Uma ou mais parcelas já foram quitadas"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/charges/{id}/manual-payment

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

ULID da cobrança. Exemplo: 01K5T9B6R8XCBSZ0FXZGH9RKC7 Example: architecto

Body Parameters

installment_ids string[]

IDs das parcelas a serem quitadas. Exemplo: [123, 456]

manual_payment_method string

Método do pagamento manual. Um de: dinheiro, transferencia, pix, pix_manual, cheque, deposito, outros. Exemplo: pix_manual Example: architecto

manual_payment_notes string optional

Observações do pagamento manual. Máx 1000 caracteres. Exemplo: Pagamento manual da parcela 1 Example: architecto

manual_payment_date date optional

Data em que o pagamento foi realizado. Não pode ser futura. Exemplo: 2025-09-23 Example: architecto

manual_payment_amount number optional

Valor do pagamento. Se omitido, assume o valor da parcela. Example: 4326.41688

Cobranças (Charges)

Endpoints para aplicar pagamentos manuais em cobranças e parcelas.

Aplica automaticamente um valor pago para quitar o máximo de parcelas pendentes de uma cobrança. Se houver um valor residual que não quite a próxima parcela, este valor será abatido do valor dessa próxima parcela (ela permanece pendente). A soma do total pago + total faltante é validada para ser igual ao total da cobrança ao final da operação.

Alocação automática de pagamento manual (quita + abate)

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/charges/architecto/manual-payment/automatic-allocation" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount\": 4326.41688,
    \"manual_payment_method\": \"architecto\",
    \"manual_payment_notes\": \"architecto\",
    \"manual_payment_date\": \"architecto\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/charges/architecto/manual-payment/automatic-allocation"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "amount": 4326.41688,
    "manual_payment_method": "architecto",
    "manual_payment_notes": "architecto",
    "manual_payment_date": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Alocação automática processada com sucesso",
    "data": {
        "payments": [
            {
                "id": 123,
                "charge_id": "01K5T9B6R8XCBSZ0FXZGH9RKC7",
                "installment_id": 456,
                "amount": 300,
                "payment_method": "manual",
                "status": "approved",
                "manual_payment_method": "pix_manual",
                "confirmed_at": "2025-09-23T12:00:00Z"
            }
        ],
        "charge": {
            "id": "01K5T9B6R8XCBSZ0FXZGH9RKC7",
            "installments": [
                {
                    "id": 456,
                    "installment_number": 1,
                    "amount": 300,
                    "status": "paid"
                },
                {
                    "id": 789,
                    "installment_number": 2,
                    "amount": 300,
                    "status": "paid"
                },
                {
                    "id": 1011,
                    "installment_number": 3,
                    "amount": 350,
                    "status": "pending"
                }
            ]
        }
    }
}

Example response (422):


{
    "message": "Erro ao processar alocação automática",
    "error": "Valor informado excede o total pendente das parcelas"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/charges/{id}/manual-payment/automatic-allocation

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

ULID da cobrança. Exemplo: 01K5T9B6R8XCBSZ0FXZGH9RKC7 Example: architecto

Body Parameters

amount number

Valor a ser alocado automaticamente entre as parcelas. Exemplo: 650.00 Example: 4326.41688

manual_payment_method string

Método do pagamento manual. Um de: dinheiro, transferencia, pix, pix_manual, cheque, deposito, outros. Exemplo: pix_manual Example: architecto

manual_payment_notes string optional

Observações do pagamento manual. Máx 1000 caracteres. Exemplo: Pagamento manual de 650 Example: architecto

manual_payment_date date optional

Data em que o pagamento foi realizado. Não pode ser futura. Exemplo: 2025-09-23 Example: architecto

Payments

Gerenciamento de pagamentos do sistema

Listar pagamentos

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/payments" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/payments"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Pagamentos obtidos com sucesso",
    "data": {
        "data": [
            {
                "id": 1,
                "charge_id": 1,
                "amount": 10000,
                "status": "pending",
                "payment_method": "pix",
                "gateway_transaction_id": "tx_123456",
                "created_at": "2024-01-01T00:00:00.000000Z"
            }
        ],
        "meta": {
            "total": 100,
            "per_page": 15,
            "current_page": 1,
            "total_pages": 7
        }
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Criar pagamento

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/payments" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"charge_id\": 1,
    \"amount\": 10000,
    \"payment_method\": \"pix\",
    \"gateway\": \"pagarme\",
    \"metadata\": []
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/payments"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "charge_id": 1,
    "amount": 10000,
    "payment_method": "pix",
    "gateway": "pagarme",
    "metadata": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "message": "Pagamento criado com sucesso",
    "data": {
        "id": 1,
        "charge_id": 1,
        "amount": 10000,
        "status": "pending",
        "payment_method": "pix",
        "gateway": "pagarme",
        "created_at": "2024-01-01T00:00:00.000000Z"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/payments

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

charge_id integer

ID da cobrança. Example: 1

amount integer

Valor em centavos. Example: 10000

payment_method string

Método de pagamento. Example: pix

gateway string

Gateway de pagamento. Example: pagarme

metadata object optional

Opcional. Metadados adicionais.

Estatísticas de pagamentos

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/payments/statistics" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/payments/statistics"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Estatísticas obtidas com sucesso",
    "data": {
        "total_payments": 100,
        "total_amount": 1000000,
        "pending_payments": 10,
        "paid_payments": 80,
        "failed_payments": 10,
        "average_amount": 10000
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Exibir pagamento

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/payments/1" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/payments/1"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Pagamento obtido com sucesso",
    "data": {
        "id": 1,
        "charge_id": 1,
        "amount": 10000,
        "status": "pending",
        "payment_method": "pix",
        "gateway": "pagarme",
        "created_at": "2024-01-01T00:00:00.000000Z"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/payments/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

ID do pagamento. Example: 1

Atualizar pagamento

requires authentication

Example request:

curl --request PUT \
    "https://api.meupagamento.com.br/api/v1/payments/1" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"paid\",
    \"gateway_transaction_id\": \"tx_123456\",
    \"metadata\": []
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/payments/1"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": "paid",
    "gateway_transaction_id": "tx_123456",
    "metadata": []
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Pagamento atualizado com sucesso",
    "data": {
        "id": 1,
        "charge_id": 1,
        "amount": 10000,
        "status": "paid",
        "payment_method": "pix",
        "gateway": "pagarme",
        "updated_at": "2024-01-01T00:00:00.000000Z"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/v1/payments/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

ID do pagamento. Example: 1

Body Parameters

status string optional

Opcional. Status do pagamento. Example: paid

gateway_transaction_id string optional

Opcional. ID da transação no gateway. Example: tx_123456

metadata object optional

Opcional. Metadados adicionais.

Estornar pagamento

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/payments/1/refund" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reason\": \"Solicitação do cliente\",
    \"amount\": 10000
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/payments/1/refund"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reason": "Solicitação do cliente",
    "amount": 10000
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Pagamento estornado com sucesso",
    "data": {
        "id": 1,
        "charge_id": 1,
        "amount": 10000,
        "status": "refunded",
        "payment_method": "pix",
        "gateway": "pagarme",
        "updated_at": "2024-01-01T00:00:00.000000Z"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/payments/{id}/refund

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

ID do pagamento. Example: 1

Body Parameters

reason string optional

Opcional. Motivo do estorno. Example: Solicitação do cliente

amount integer optional

Opcional. Valor do estorno em centavos. Example: 10000

Status do pagamento

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/payments/1/status" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/payments/1/status"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Status obtido com sucesso",
    "data": {
        "id": 1,
        "status": "paid",
        "gateway_status": "approved",
        "last_updated": "2024-01-01T00:00:00.000000Z"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/payments/{id}/status

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

ID do pagamento. Example: 1

Plans

Gerenciamento de planos de usuários

Listar planos ativos

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/plans" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/plans"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Meu plano atual

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/plans/me" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/plans/me"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Atribuir plano ao usuário autenticado

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/plans/assign" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"plan_id\": 16,
    \"starts_at\": \"architecto\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/plans/assign"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "plan_id": 16,
    "starts_at": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/plans/assign

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

plan_id integer

ID do plano Example: 16

starts_at date optional

Opcional. Data de início Example: architecto

Recipients

Search recipients

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/recipients/search" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/recipients/search"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": 10,
            "name": "Maria Oliveira",
            "email": "maria@example.com",
            "document": "12345678901",
            "document_type": "cpf",
            "is_active": true
        }
    ]
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

RelayO Webhooks

Recebimento de eventos do RelayO (WhatsApp)

Recebe eventos do WhatsApp

requires authentication

Endpoint público para receber callbacks do RelayO contendo mensagens e eventos de instância.

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/webhooks/relayo/whatsapp/receive" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"http_params\": []
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/webhooks/relayo/whatsapp/receive"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "http_params": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/webhooks/relayo/whatsapp/receive

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

http_params object

Conteúdo do evento conforme exemplos fornecidos

RelayO WhatsApp Management

Lista todas as instâncias WhatsApp disponíveis no RelayO e sincroniza com o banco local.

Lista todas as instâncias WhatsApp

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/relayo/instances" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/relayo/instances"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "data": [
        {
            "id": 1,
            "name": "Instância Principal",
            "instance_id": "relayo_instance_123",
            "status": "connected",
            "is_connected": true,
            "last_connected_at": "01/10/2025 22:30:00",
            "created_at": "01/10/2025 22:00:00"
        }
    ],
    "message": "Instâncias listadas com sucesso"
}

Example response (500):


{
    "success": false,
    "message": "Erro ao listar instâncias",
    "error": "Mensagem de erro"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obtém detalhes de uma instância específica

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/relayo/instances/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/relayo/instances/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "data": {
        "id": 1,
        "name": "Instância Principal",
        "instance_id": "relayo_instance_123",
        "status": "connected",
        "is_connected": true,
        "last_connected_at": "01/10/2025 22:30:00",
        "created_at": "01/10/2025 22:00:00"
    },
    "message": "Instância obtida com sucesso"
}

Example response (404):


{
    "success": false,
    "message": "Instância não encontrada"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/relayo/instances/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

ID da instância Example: architecto

Obtém o QR Code de uma instância

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/relayo/instances/architecto/qrcode" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/relayo/instances/architecto/qrcode"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "data": {
        "qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
        "status": "disconnected"
    },
    "message": "QR Code obtido com sucesso"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/relayo/instances/{id}/qrcode

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

ID da instância Example: architecto

Ativa/desativa uma instância

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/relayo/instances/architecto/toggle" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/relayo/instances/architecto/toggle"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "data": {
        "id": 1,
        "is_active": false
    },
    "message": "Instância desativada"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/relayo/instances/{id}/toggle

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

ID da instância Example: architecto

Sincroniza as instâncias com o RelayO

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/relayo/instances/sync" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/relayo/instances/sync"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "data": {
        "instances_count": 3
    },
    "message": "Instâncias sincronizadas com sucesso"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Verifica o status do serviço RelayO

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/relayo/status" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/relayo/status"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "data": {
        "service_available": true,
        "total_instances": 3,
        "connected_instances": 2,
        "status": "online"
    },
    "message": "Status do serviço obtido com sucesso"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Testa o envio de uma mensagem

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/relayo/test-message" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"instance_id\": \"architecto\",
    \"phone_number\": \"architecto\",
    \"message\": \"architecto\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/relayo/test-message"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "instance_id": "architecto",
    "phone_number": "architecto",
    "message": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "data": {
        "success": true,
        "message_id": "msg_123456",
        "message": "Mensagem enviada com sucesso"
    },
    "message": "Mensagem enviada com sucesso"
}

Example response (422):


{
    "success": false,
    "message": "Dados inválidos",
    "errors": {
        "phone_number": [
            "O campo phone_number é obrigatório."
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/relayo/test-message

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

instance_id string

ID da instância no RelayO Example: architecto

phone_number string

Número do telefone (10-11 dígitos) Example: architecto

message string

Mensagem a ser enviada (máximo 1000 caracteres) Example: architecto

Subscription Adjustments

Lançamentos variáveis por período de uma assinatura.

Listar ajustes da assinatura (opcional filtro por período)

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/subscriptions/architecto/adjustments" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto/adjustments"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/subscriptions/{id}/adjustments

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the subscription. Example: architecto

Criar ajuste no período

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto/adjustments" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto/adjustments"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/subscriptions/{id}/adjustments

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the subscription. Example: architecto

Atualizar ajuste

requires authentication

Example request:

curl --request PUT \
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto/adjustments/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto/adjustments/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/v1/subscriptions/{id}/adjustments/{adjustmentId}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the subscription. Example: architecto

adjustmentId string

Example: architecto

Remover ajuste

requires authentication

Example request:

curl --request DELETE \
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto/adjustments/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto/adjustments/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/v1/subscriptions/{id}/adjustments/{adjustmentId}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the subscription. Example: architecto

adjustmentId string

Example: architecto

Subscriptions

Endpoints para gerenciamento de assinaturas recorrentes.

Listar assinaturas

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/subscriptions" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/subscriptions"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Criar assinatura

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/subscriptions" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/subscriptions"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Estatísticas das assinaturas do usuário autenticado

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/subscriptions/statistics" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/subscriptions/statistics"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Detalhar assinatura

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/subscriptions/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/subscriptions/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the subscription. Example: architecto

Atualizar assinatura

requires authentication

Example request:

curl --request PATCH \
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PATCH api/v1/subscriptions/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the subscription. Example: architecto

Prévia de cobrança do período

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/subscriptions/architecto/preview" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto/preview"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/subscriptions/{id}/preview

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the subscription. Example: architecto

Gerar cobrança do período (idempotente)

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto/generate" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto/generate"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/subscriptions/{id}/generate

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the subscription. Example: architecto

Recalcular cobrança existente do período

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto/recalculate" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/subscriptions/architecto/recalculate"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/subscriptions/{id}/recalculate

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the subscription. Example: architecto

System

Informações do sistema

Obter versão do sistema

requires authentication

Retorna a versão atual do sistema baseada no Git

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/version" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/version"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "version": "v1.2.3",
    "commit": "abc123def456",
    "branch": "main",
    "timestamp": "2024-01-01T12:00:00Z"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter informações detalhadas da versão

requires authentication

Retorna informações mais detalhadas sobre a versão atual

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/version/detailed" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/version/detailed"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "version": "v1.2.3",
    "commit": "abc123def456",
    "commit_short": "abc123d",
    "branch": "main",
    "timestamp": "2024-01-01T12:00:00Z",
    "author": "Developer Name",
    "message": "Commit message",
    "date": "2024-01-01T10:00:00Z"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Users

Gerenciamento de usuários do sistema

Listar usuários

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/users" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/users"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Usuários obtidos com sucesso",
    "data": {
        "data": [
            {
                "id": 1,
                "name": "João Silva",
                "email": "joao@example.com",
                "status": "active",
                "created_at": "2024-01-01T00:00:00.000000Z"
            }
        ],
        "meta": {
            "total": 100,
            "per_page": 15,
            "current_page": 1,
            "total_pages": 7
        }
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter perfil do usuário autenticado

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/users/profile" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/users/profile"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Atualizar perfil do usuário autenticado

requires authentication

Example request:

curl --request PUT \
    "https://api.meupagamento.com.br/api/v1/users/profile" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/users/profile"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Verificar se a chave PIX está ativada

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/users/pix-status" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/users/pix-status"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Status da chave PIX obtido com sucesso",
    "data": {
        "pix_activated": true,
        "chave_pix": "11999999999",
        "pix_key_type": "phone"
    }
}

Example response (401):


{
    "message": "Unauthenticated"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Buscar usuário por CPF ou email

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/users/find" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/users/find"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Verificar usuário por token

requires authentication

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/users/verify" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/users/verify"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Obter usuário específico

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/users/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/users/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/users/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the user. Example: architecto

Atualizar usuário

requires authentication

Example request:

curl --request PUT \
    "https://api.meupagamento.com.br/api/v1/users/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/users/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/v1/users/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the user. Example: architecto

Excluir usuário (soft delete)

requires authentication

Example request:

curl --request DELETE \
    "https://api.meupagamento.com.br/api/v1/users/architecto" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"confirmation\": \"DELETE\",
    \"reason\": \"Usuário solicitou exclusão de dados\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/users/architecto"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "confirmation": "DELETE",
    "reason": "Usuário solicitou exclusão de dados"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Usuário excluído com sucesso",
    "data": {
        "id": 1,
        "name": "João Silva",
        "email": "joao@example.com",
        "deleted_at": "2024-01-01T00:00:00.000000Z"
    }
}

Example response (400):


{
    "message": "Confirmação inválida",
    "error": "INVALID_CONFIRMATION"
}

Example response (404):


{
    "message": "Usuário não encontrado",
    "error": "USER_NOT_FOUND"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/v1/users/{id}

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the user. Example: architecto

Body Parameters

confirmation string

Confirmação da exclusão. Must be "DELETE". Example: DELETE

reason string optional

optional Motivo da exclusão. Example: Usuário solicitou exclusão de dados

Obter estatísticas do usuário

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/users/architecto/statistics" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/users/architecto/statistics"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/users/{id}/statistics

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the user. Example: architecto

Obter cobranças do devedor

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/users/architecto/debtor-charges" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/users/architecto/debtor-charges"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/users/{id}/debtor-charges

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the user. Example: architecto

Obter pagamentos do devedor

requires authentication

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/users/architecto/debtor-payments" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/users/architecto/debtor-payments"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS, PATCH
access-control-allow-headers: Content-Type, Authorization, X-Requested-With, Accept, Origin, X-CSRF-TOKEN
access-control-allow-credentials: true
access-control-max-age: 86400


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/users/{id}/debtor-payments

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the user. Example: architecto

Verificação de E-mail

Endpoints para verificação de e-mail via código

Enviar código de verificação

requires authentication

Envia um código de verificação de 6 dígitos para o e-mail do usuário. Apenas usuários que não fizeram login via redes sociais podem solicitar.

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/email-verification/send-code" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/email-verification/send-code"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "gbailey@example.net"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Código de verificação enviado com sucesso",
    "expires_at": "2024-01-01T12:15:00.000000Z"
}

Example response (400):


{
    "success": false,
    "message": "Usuário social não pode solicitar verificação de e-mail"
}

Example response (422):


{
    "success": false,
    "message": "Dados inválidos",
    "errors": {
        "email": [
            "O campo e-mail é obrigatório"
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/email-verification/send-code

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

email string

E-mail para envio do código Example: gbailey@example.net

Verificar código

requires authentication

Verifica o código de verificação enviado para o e-mail.

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/email-verification/verify-code" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"architecto\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/email-verification/verify-code"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "E-mail verificado com sucesso",
    "email": "usuario@exemplo.com"
}

Example response (400):


{
    "success": false,
    "message": "Código inválido ou expirado"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/email-verification/verify-code

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

code string

Código de 6 dígitos recebido Example: architecto

Status da verificação

requires authentication

Retorna o status atual da verificação do e-mail do usuário.

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/email-verification/status" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/email-verification/status"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "data": {
        "is_verified": true,
        "email": "usuario@exemplo.com",
        "verified_at": "2024-01-01T12:00:00.000000Z",
        "can_request_verification": true,
        "is_social_user": false
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Verificação de Telefone

Endpoints para verificação de telefone via SMS/WhatsApp

Enviar código de verificação

requires authentication

Envia um código de verificação de 6 dígitos para o telefone do usuário via WhatsApp.

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/phone-verification/send-code" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"phone\": \"architecto\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/phone-verification/send-code"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "phone": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Código de verificação enviado com sucesso",
    "expires_at": "2024-01-01T12:10:00.000000Z"
}

Example response (422):


{
    "success": false,
    "message": "Dados inválidos",
    "errors": {
        "phone": [
            "O campo telefone é obrigatório"
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/phone-verification/send-code

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

phone string

Telefone para envio do código (formato: 11999999999) Example: architecto

Verificar código

requires authentication

Verifica o código de verificação enviado para o telefone.

Example request:

curl --request POST \
    "https://api.meupagamento.com.br/api/v1/phone-verification/verify-code" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"architecto\"
}"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/phone-verification/verify-code"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Telefone verificado com sucesso",
    "phone": "11999999999"
}

Example response (400):


{
    "success": false,
    "message": "Código inválido ou expirado"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/phone-verification/verify-code

Headers

Authorization

Example: Bearer Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

code string

Código de 6 dígitos recebido Example: architecto

Status da verificação

requires authentication

Retorna o status atual da verificação do telefone do usuário.

Example request:

curl --request GET \
    --get "https://api.meupagamento.com.br/api/v1/phone-verification/status" \
    --header "Authorization: Bearer Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.meupagamento.com.br/api/v1/phone-verification/status"
);

const headers = {
    "Authorization": "Bearer Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "data": {
        "is_verified": true,
        "phone": "11999999999",
        "verified_at": "2024-01-01T12:00:00.000000Z"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Introduction

Authenticating requests

API Tokens

Listar tokens de API do usuário

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Criar novo token de API

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Obter informações do token atual

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Revogar token de API

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Revogar todos os tokens de API do usuário

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Autenticação Social

Redirecionar para o provedor social

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Processar callback do provedor social

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Listar contas sociais conectadas

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Desconectar conta social

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Endpoints

GET api/v1/health

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/v1/test

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Register a new user

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Login user

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Reset password

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Verify password reset token

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Update password with reset token

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Logout user

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Get authenticated user

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/v1/user

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Display a listing of recipients.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Store a newly created recipient.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Validate document.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Display the specified recipient.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request