Bem vindo a API Reference do Iniciador! 👋
Nossa API para iniciação de pagamentos está em conformidade com as diretrizes definidas na arquitetura REST. A interação com a API se dá por meio de requisições HTTP responsáveis pelas operações básicas necessárias para a manipulação dos dados em cada endpoint. Cada requisição feita terá um código de status HTTP que pode ser utilizado para interpretação dos resultados, para maiores informações acesse a documentação Códigos de Resposta HTTP.
A facilidade de uso da API REST torna a comunicação rápida e segura independentemente da linguagem de programação utilizada.
A maioria das rotas da API são protegidas e obrigatoriamente é necessário repassar as chaves X-INICIADOR-API-AppKey e X-INICIADOR-API-AppToken no cabeçalho de cada requisição.
Recebendo o appKey e o appToken
Você receberá as chaves para integração assim que o processo de fechamento do contrato for concluído.
Usando o appKey e appToken para autenticar
Para autenticar é muito simples! 🔐
É obrigatório fornecer as chaves X-INICIADOR-API-AppKey e X-INICIADOR-API-AppToken no cabeçalho de cada requisição, assim estando autenticado como cliente e apto para comunicação.
Parâmetros comuns na documentação:
| Key | Value |
|---|---|
| {{X-INICIADOR-API-AppKey}} | O AppKey configurado pelo cliente |
| {{X-INICIADOR-API-AppToken}} | O AppToken configurado pelo cliente |
O callbackUrl é um campo obrigatório para criação do pagamento. O mesmo é utilizado pelo nosso provedor de pagamento para notificar sobre qualquer atualização que houver no status do pagamento.
A requisição é um POST contendo em seu corpo o mesmo corpo de resposta da Criação do pagamento. A requisição deve ser autenticada utilizando em cabeçalho suas credenciais X-INTEGRADOR-API-AppKey e X-INTEGRADOR-API-AppToken que devem ser fornecida no momento da integração.
Nossa documentação é construída utilizando o padrão Open API 3.0 (OAS 3.0), com ele você pode baixar os esquemas OAS 3.0 que estão disponíveis para download.
Assim que realizar o download do esquema, você pode importar nossos endpoints de API para o Postman.
Consultar status da aplicação
query Parameters
| indicator | Array of strings Items Enum: "database" "nats" Indicador do microserviço |
Responses
Response samples
- 200
{- "status": "ok",
- "info": {
- "uptime": {
- "status": "up",
- "uptime": 22
}
}, - "error": { },
- "details": {
- "uptime": {
- "status": "up",
- "uptime": 22
}
}
}Criar pagamento
Authorizations:
Request Body schema: application/json
| paymentId required | string Identificador do pagamento |
| value required | number >= 0.01 Valor do pedido |
| callbackUrl required | string URL para notificação de alterações de status do pagamento |
| returnUrl required | string URL necessária para redirecionar o usuário final de volta à loja do comerciante ao fim do fluxo de pagamento |
| sandboxMode | boolean Default: false Indica se esta solicitação é ou não para ambiente sandbox |
required | object (CreateBuyerRequest) |
Responses
Request samples
- Payload
{- "paymentId": "62a7a20a-df7d-402a-9f95-251c9575f7a9",
- "value": 95.9,
- "sandboxMode": false,
- "buyer": {
- "id": "62a7a20a-df7d-402a-9f95-251c9575f888",
- "name": "Rodrigo Lucio",
- "document": "94224506084",
- "documentType": "CPF",
- "email": "rodrigo.lucio@fcamara.com.br"
}
}Response samples
- 200
{- "paymentId": "62a7a20a-df7d-402a-9f95-251c9575f7a9",
- "status": "undefined",
- "tid": "E123456789123456789",
- "code": "string",
- "message": "string"
}Cancelar pagamento
Authorizations:
path Parameters
| paymentId required | any Identificador do pagamento |
Request Body schema: application/json
| paymentId required | string Identificador do pagamento |
| requestId required | string Identificador da requisição |
| sandboxMode | boolean Default: false Indica se esta solicitação é ou não para ambiente sandbox |
Responses
Request samples
- Payload
{- "paymentId": "62a7a20a-df7d-402a-9f95-251c9575f7a9",
- "requestId": "e04f146c-2758-4fbb-a2b2-75cbf9415dws",
- "sandboxMode": false
}Response samples
- 200
{- "paymentId": "62a7a20a-df7d-402a-9f95-251c9575f7a9",
- "code": "B00",
- "message": "Pagamento cancelado com sucesso",
- "requestId": "e04f146c-2758-4fbb-a2b2-75cbf9415dws",
- "cancellationId": "506975f1-ee84-4b2d-bfda-2fa3d981c6f5"
}Reembolso do pagamento
Authorizations:
path Parameters
| paymentId required | any Identificador do pagamento |
Request Body schema: application/json
| requestId required | string Identificador da requisição |
| settleId required | string Identificador do vendedor |
| paymentId required | string Identificador do pagamento |
| value required | number Valor do pedido |
| transactionId required | string Identificador da transação |
| sandboxMode | boolean Default: false Indica se esta solicitação é ou não para ambiente sandbox |
Responses
Request samples
- Payload
{- "requestId": "e04f146c-2758-4fbb-a2b2-75cbf9415dws",
- "settleId": "b7ba133c-e997-4e6d-b1cf-21781fcfd5c9",
- "paymentId": "62a7a20a-df7d-402a-9f95-251c9575f7a9",
- "value": 95.9,
- "transactionId": "e04f146c-2758-4fbb-a2b2-75cbf94ace83",
- "sandboxMode": false
}Response samples
- 501
{- "paymentId": "62a7a20a-df7d-402a-9f95-251c9575f7a9",
- "code": "E05",
- "message": "Método de reembolso não implementado",
- "requestId": "e04f146c-2758-4fbb-a2b2-75cbf9415dws",
- "value": 95.9,
- "refundId": "b397dd9c-62b2-4632-bce7-85f56666c083"
}Criar consentimento
Request Body schema: application/json
| paymentId required | string Identificador do pagamento |
| requestId required | string Identificador da requisição |
| pixMessage | string Informações adicionais sobre um pagamento, a serem enviadas ao destinatário |
required | object (OrganizationRequest) |
Responses
Request samples
- Payload
{- "paymentId": "62a7a20a-df7d-402a-9f95-251c9575f7a9",
- "requestId": "e04f146c-2758-4fbb-a2b2-75cbf9415dws",
- "pixMessage": "Pagamento da nota XPTO035-002",
- "organization": {
- "id": "e04f146c-2758-4fbb-a2b2-75cbf94acaaa",
- "name": "FCamara",
}
}
Response samples
- 200
{- "paymentId": "62a7a20a-df7d-402a-9f95-251c9575f7a9",
- "code": "A01",
- "message": "Pagamento foi requisitado",
- "requestId": "e04f146c-2758-4fbb-a2b2-75cbf9415dws",
- "consentId": "75671765-8b3f-42a8-9b9c-f1f3db31c20d",
- "organization": {
- "id": "e04f146c-2758-4fbb-a2b2-75cbf94acaaa",
- "name": "FCamara",
}
}Response samples
- 200
{- "paymentId": "62a7a20a-df7d-402a-9f95-251c9575f7a9",
- "value": 95.9,
- "sandboxMode": true,
- "status": "undefined",
- "pixMessage": "Pagamento da nota XPTO035-002",
- "createdAt": "2022-09-28T17:25:14.000Z",
- "updatedAt": "2022-09-28T17:42:22.000Z",
- "deletedAt": null,
- "client": {
- "name": "FCamara",
- "document": "12345678910"
}, - "buyer": {
- "name": "Rodrigo Lucio",
- "document": "94224506084"
}, - "organization": {
- "id": "e04f146c-2758-4fbb-a2b2-75cbf94acaaa",
- "name": "FCamara",
}, - "maskForDocument": { }
}Atualizar consentimento de sandbox
Request Body schema: application/json
| paymentId required | string |
| requestId required | string |
| authorized required | boolean |
Responses
Request samples
- Payload
{- "paymentId": "string",
- "requestId": "string",
- "authorized": true
}Response samples
- 200
{- "paymentId": "string",
- "code": "B02",
- "message": "Pagamento atualizado sucesso",
- "requestId": "string"
}Response samples
- 200
[- {
- "id": "e04f146c-2758-4fbb-a2b2-75cbf94acaaa",
- "name": "FCamara",
- "termsOfServiceUrl": "string"
}
]