Cria uma nova solicitação vinculada a uma aplicação específica do parceiro autenticado.
Token de autenticação obtido no login do parceiro.
string| Cabeçalho | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo enviado no corpo da requisição. |
Authorization | Bearer {{ access_token }} | Token de autenticação obtido no login do parceiro. |
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
application_id | string | Sim | ID da aplicação à qual a solicitação estará vinculada. |
name | string | Sim | Nome do cliente final. |
document | string | Sim | Documento do cliente final (CPF, CNPJ, etc). |
email | string | Sim | E-mail do cliente final. |
phone | string | Sim | Telefone do cliente final. |
origin | string | Sim | Origem da solicitação (ex: partner). |
scopes | array | Sim | Lista de escopos autorizados para a solicitação. |
webhook_url | string | Opcional | URL para receber notificações sobre mudanças de status da solicitação. |
metadata | array | Opcional | Lista de informações adicionais relacionadas à solicitação. |
| Escopo | Descrição |
|---|---|
cob.read | Leitura de cobranças Pix |
cob.write | Criação e atualização de cobranças Pix |
merchants.read | Leitura de estabelecimentos |
merchants.write | Criação e atualização de estabelecimentos |
terminals.read | Leitura de terminais |
terminals.write | Criação e atualização de terminais |
transactions.read | Leitura de transações |
transactions.write | Criação e atualização de transações |
webhooks.read | Leitura de webhooks |
webhooks.write | Criação e atualização de webhooks |
dict.read | Leitura de dicionários |
dict.write | Criação e atualização de dicionários |
Em caso de sucesso, o servidor retorna um objeto JSON com os dados da solicitação criada, incluindo campos como id, status, created_at, entre outros.
| Campo | Tipo | Descrição |
|---|---|---|
id | string | ID único da solicitação criada. |
partner | object | Dados do parceiro que fez a solicitação. |
application | object | Dados da aplicação associada à solicitação. |
status | string | Status da solicitação (pending inicialmente). |
scopes | array | Escopos solicitados para a autorização. |
origin | string | Origem da solicitação. |
name | string | Nome do cliente final. |
document | string | Documento do cliente final. |
email | string | E-mail do cliente final. |
phone | string | Telefone do cliente final. |
webhook_url | string | URL para receber notificações de status. |
decision_at | string | Data da decisão do cliente (quando aplicável). |
user_id | string | ID do usuário no sistema (quando aplicável). |
account_id | string | ID da conta do usuário (quando aplicável). |
metadata | array | Informações adicionais da solicitação. |
created_at | string | Data de criação da solicitação (ISO8601). |
updated_at | string | Data da última atualização da solicitação (ISO8601). |
| Status | Descrição |
|---|---|
pending | Solicitação aguardando aprovação do cliente (status inicial). |
approved | Solicitação aprovada pelo cliente. |
rejected | Solicitação rejeitada pelo cliente. |
expired | Solicitação expirada. |
cancelled | Solicitação cancelada pelo parceiro. |
{{ access_token }} deve ser obtido via login do parceiro e inserido no cabeçalho Authorization.application_id deve ser o ID de uma aplicação previamente criada e aprovada.webhook_url para ser notificado sobre atualizações de status da solicitação.metadata permite incluir dados adicionais para referência interna.| Código | Significado | Descrição |
|---|---|---|
| 201 | Created | Solicitação criada com sucesso. |
| 400 | Bad Request | Parâmetros inválidos ou ausentes na requisição. |
| 401 | Unauthorized | Token de autenticação inválido ou expirado. |
| 403 | Forbidden | Parceiro não tem permissão para criar solicitações. |
| 409 | Conflict | Já existe uma solicitação pendente para este cliente e aplicação. |
| 500 | Internal Server Error | Erro interno do servidor. |
pending.{{ access_token }} deve ser obtido via login do parceiro e inserido no cabeçalho Authorization.application_id deve ser o ID de uma aplicação previamente criada e aprovada.webhook_url para ser notificado sobre atualizações de status da solicitação.metadata permite incluir dados adicionais para referência interna.curl --location 'https://dominio-ambiente.com.br/api/v2/partners/requests' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{ access_token }}' \
--data-raw '{
"application_id": "{{ partner_application_id }}",
"name": "NOME DO SEU CLIENTE",
"document": "0000000000000",
"email": "[email protected]",
"phone": "11999990002",
"origin": "partner",
"scopes": [
"cob.read",
"cob.write"
],
"webhook_url": "https://webhook.site/601f1864-c330-4fc0-baf0-f9c5524a9bfa",
"metadata": [
"TESTE 1",
"teste 2"
]
}'
const axios = require('axios');
const createAuthorizationRequest = async (token, requestData) => {
try {
const response = await axios.post('https://dominio-ambiente.com.br/api/v2/partners/requests', requestData, {
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${token}`
}
});
console.log('Solicitação criada:', response.data.id);
console.log('Status:', response.data.status);
return response.data;
} catch (error) {
console.error('Erro ao criar solicitação:', error.response?.data || error.message);
return null;
}
};
// Exemplo de uso
const requestData = {
application_id: "{{ partner_application_id }}",
name: "NOME DO SEU CLIENTE",
document: "0000000000000",
email: "[email protected]",
phone: "11999990002",
origin: "partner",
scopes: ["cob.read", "cob.write"],
webhook_url: "https://webhook.site/601f1864-c330-4fc0-baf0-f9c5524a9bfa",
metadata: ["TESTE 1", "teste 2"]
};
const token = "{{ access_token }}";
createAuthorizationRequest(token, requestData);
import requests
import json
def create_authorization_request(token, request_data):
url = "https://dominio-ambiente.com.br/api/v2/partners/requests"
headers = {
"Content-Type": "application/json",
"Authorization": f"Bearer {token}"
}
try:
response = requests.post(url, json=request_data, headers=headers)
response.raise_for_status()
data = response.json()
print(f"Solicitação criada: {data['id']}")
print(f"Status: {data['status']}")
print(f"Cliente: {data['name']}")
print(f"Documento: {data['document']}")
return data
except requests.exceptions.RequestException as e:
print(f"Erro na requisição: {e}")
return None
# Exemplo de uso
request_data = {
"application_id": "{{ partner_application_id }}",
"name": "NOME DO SEU CLIENTE",
"document": "0000000000000",
"email": "[email protected]",
"phone": "11999990002",
"origin": "partner",
"scopes": ["cob.read", "cob.write"],
"webhook_url": "https://webhook.site/601f1864-c330-4fc0-baf0-f9c5524a9bfa",
"metadata": ["TESTE 1", "teste 2"]
}
token = "{{ access_token }}"
result = create_authorization_request(token, request_data)
<?php
function createAuthorizationRequest($token, $requestData) {
$url = 'https://dominio-ambiente.com.br/api/v2/partners/requests';
// Configuração do cURL
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($requestData));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Content-Type: application/json',
'Authorization: Bearer ' . $token
]);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$error = curl_error($ch);
curl_close($ch);
if ($error) {
echo "Erro cURL: " . $error . "\n";
return null;
}
if ($httpCode !== 200 && $httpCode !== 201) {
echo "Erro HTTP: " . $httpCode . "\n";
echo "Resposta: " . $response . "\n";
return null;
}
$data = json_decode($response, true);
if (json_last_error() !== JSON_ERROR_NONE) {
echo "Erro ao decodificar JSON: " . json_last_error_msg() . "\n";
return null;
}
echo "Solicitação criada: " . $data['id'] . "\n";
echo "Status: " . $data['status'] . "\n";
return $data;
}
// Exemplo de uso
$requestData = [
'application_id' => '{{ partner_application_id }}',
'name' => 'NOME DO SEU CLIENTE',
'document' => '0000000000000',
'email' => '[email protected]',
'phone' => '11999990002',
'origin' => 'partner',
'scopes' => ['cob.read', 'cob.write'],
'webhook_url' => 'https://webhook.site/601f1864-c330-4fc0-baf0-f9c5524a9bfa',
'metadata' => ['TESTE 1', 'teste 2']
];
$token = '{{ access_token }}';
createAuthorizationRequest($token, $requestData);
?>
{
"id": "req-123-456-789",
"partner": {
"id": "partner-abc-def",
"name": "Minha Empresa",
"contact_email": "[email protected]",
"contact_phone": "11999999999",
"status": "active",
"scopes": ["cob.read", "cob.write", "merchants.read"]
},
"application": {
"id": "app-123-456-789",
"name": "Sistema de Cobrança",
"description": "Aplicação para gerenciar cobranças Pix",
"briefing": "Facilita a criação e gestão de cobranças",
"category": "Pagamentos",
"scopes": ["cob.read", "cob.write"],
"status": "active"
},
"status": "pending",
"scopes": [
"cob.read",
"cob.write"
],
"origin": "partner",
"name": "NOME DO SEU CLIENTE",
"document": "0000000000000",
"email": "[email protected]",
"phone": "11999990002",
"webhook_url": "https://webhook.site/601f1864-c330-4fc0-baf0-f9c5524a9bfa",
"decision_at": null,
"user_id": null,
"account_id": null,
"metadata": [
"TESTE 1",
"teste 2"
],
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}