API ResolveBank v2.0.0 - Documentação

POST /auth?token={token}

Obter token de acesso

Realiza a autenticação e retorna o access_token autorizado do usuário. O access_token será utilizado nas demais requisições

Parâmetros

Nome	Exemplo	Descrição
token * string (path)	?token=xxxxxxxxxxxxxx	Token de validação fornecido na URL. Fornecido na contratação
Authorization * string (header)	"Authorization: Bearer x1x2x3x4x5x6x7x8x9x1x2x3x4x5x6x7x8x9"	Utilize o prefixo "Bearer" e o autorization fornecido na contratação.

Responses

Code	Descrição
200	Sucesso `{ "status": 200, "access_token": "string" }`
403	Forbidden `{ "status": "Unauthorized" }` `{ "error": "Invalid token" }`

POST /pix?token={token}&hash={hash}

Executa conciliação e pagamento PIX

Chama a API de conciliação de PIX, criando um pagamento com os dados informados.

Parâmetros de Query & Header

Nome	Exemplo	Descrição
token * string (query)	?token=xxxxxxxxxxxxxxxx	Token de autenticação fornecido na contratação.
hash * string (query)	&hash=x1x2x3x4x5x6x7x8x9x1x2x3x4x5x6x7x8x9	Hash de validação do usuário.
Authorization * string (header)	"Authorization: Bearer qweqweqweqweqwe"	Bearer token retornado na autenticação.
Content-Type * string (header)	"application/json"	Define que o corpo da requisição está em JSON.

Corpo da Requisição (JSON)

Campo	Tipo	Descrição
conciliationId	string	ID de conciliação único de 26 a 34 caracteres. Uma string única definida pelo usuário gerador do pix no momento da requisição
addressingKey.value	string	Valor da chave de endereçamento (UUID).
addressingKey.type	string	Tipo da chave (ex.: "CPF", "CNPJ", "PHONE", "EMAIL", "EVP").
singlePayment	boolean	Indica pagamento único (true/false).
changeAmountType	string	Controle de alteração de valor ("NOT_ALLOWED").
amount	number	Valor do PIX em centavos (ex.: 2009 = R$20,09).
payer.name	string	Nome do pagador.
payer.documentNumber	string	CPF/CNPJ do pagador.
payer.type	string	Tipo de pagador (ex.: "CUSTOMER").
payer.address.addressLine	string	Logradouro.
payer.address.state	string	UF.
payer.address.city	string	Município.
payer.address.zipCode	string	CEP (somente números).


{
  "conciliationId": "b3f7e2d8-5a1c-4f9e-bc2d-8e9a1c2b3d4f",
  "addressingKey": {
    "value": "f2c9b1a7-3e6d-4a8f-9b1c-2d3e4f5a6b7c",
    "type": "EVP"
  },
  "singlePayment": true,
  "changeAmountType": "NOT_ALLOWED",
  "amount": 45950,
  "payer": {
    "name": "JOÃO PAULO DA SILVA",
    "documentNumber": "12345678901",
    "type": "CUSTOMER",
    "address": {
      "addressLine": "Avenida dos Pinheiros, 1234",
      "state": "RJ",
      "city": "Rio de Janeiro",
      "zipCode": "22041001"
    }
  }
}

Responses

Code	Descrição
200	Sucesso - retorna o base64 da chave copia/cola do PIX `{ "encodedValue": "MDAwMjAxMDEwMjEyMjY4MjAwMTRici5nb3YuYmNiLnBpeDI1NjBxci..." }`
400	Bad Request — Parâmetros inválidos ou faltando.
401	Unauthorized — Token ou hash inválido.

POST /boleto?token={token}&hash={hash}

Emite um boleto com os dados fornecidos

Chama a API de emissão de boleto para os pagadores e fatura informados no corpo da requisição.

Parâmetros de Query & Header

Nome	Exemplo	Descrição
token * string (query)	?token=xxxxxxxxxxxxxxxx	Token de autenticação fornecido na contratação.
hash * string (query)	&hash=x1x2x3x4x5x6x7x8x9x1x2x3x4x5x6x7x8x9	Hash de validação do usuário.
Authorization * string (header)	"Authorization: Bearer qweqweqweqweqwe"	Bearer token retornado na autenticação.
Content-Type * string (header)	"application/json"	Define que o corpo da requisição está em JSON.

Corpo da Requisição (JSON)

Campo	Tipo	Descrição
payers[0].document	string	CPF/CNPJ do pagador.
payers[0].name	string	Nome completo do pagador.
payers[0].tradeName	string	Nome fantasia ou razão social do pagador.
payers[0].email	string	E-mail de contato do pagador.
payers[0].address.addressLine	string	Logradouro e número.
payers[0].address.neighborhood	string	Bairro.
payers[0].address.city	string	Cidade.
payers[0].address.state	string	Unidade Federativa (UF).
payers[0].address.zipCode	string	CEP (somente números).
invoice.alias	string	Descrição da fatura.
invoice.amount	number	Valor da fatura (ex.: 152.75).
invoice.renewalCount	integer	Número de renovações automáticas.
invoice.type	string	Tipo de cobrança (ex.: "Service").
invoice.dueDate	string	Data de vencimento (YYYY-MM-DD).
invoice.closePayment	string	Data limite para pagamento (YYYY-MM-DD).


{
  "payers": [
    {
      "document": "12345678909",
      "name": "MARIA EDUARDA SOUZA",
      "tradeName": "ATELIÊ MARIA SOUZA",
      "email": "[email protected]",
      "address": {
        "addressLine": "Avenida Brasil, 2500",
        "neighborhood": "Centro",
        "city": "São Paulo",
        "state": "SP",
        "zipCode": "01010010"
      }
    }
  ],
  "invoice": {
    "alias": "Emissão de Fatura",
    "amount": 152.75,
    "renewalCount": 2,
    "type": "Service",
    "dueDate": "2025-07-15",
    "closePayment": "2025-07-16"
  }
}

Responses

Code	Descrição
200	Sucesso `[ { "status": "fulfilled", "value": { "issueId": "38c393f6-1064-4be1-a2dd-9a94fa0f03a8", "message": "Solicitação em processamento." } } ]`
400	Bad Request — Parâmetros inválidos ou faltando.
401	Unauthorized — Token ou hash inválido.

POST /boleto_get?token={token}&hash={hash}

Consulta status e retorna PDF do boleto

Envia o issueId gerado na solicitação anterior e, se o boleto já estiver disponível, retorna o PDF.

Parâmetros de Query & Header

Nome	Exemplo	Descrição
token * string (query)	?token=xxxxxxxxxxxxxxxx	Token de autenticação da API.
hash * string (query)	&hash=x1x2x3x4x5x6x7x8x9x1x2x3x4x5x6x7x8x9	Hash de validação do usuário.
Authorization * string (header)	"Authorization: Bearer <seu_jwt>"	Bearer token retornado na autenticação.
type string (query)	"data" ""	Retorna os dados do Boleto Vazio - retorna o PDF do boleto

Corpo da Requisição (JSON)


{
  "issueId": "<issueId gerado na ccriação do boleto>"
}

Responses

Code	Descrição
200	Sucesso — Retorna o PDF do boleto `(binary PDF stream ou base64, Content-Type: application/pdf)`
404	Not Found — issueId não encontrado ou boleto ainda não disponível.
401	Unauthorized — token ou hash inválido.
400	Bad Request — JSON mal formado ou faltando issueId.

GET /{conciliationId}/pix_page

Exibe QR Code, valor e chave para pagamento via PIX

Acessando esta URL você verá uma página de pagamento contendo:

Um QR Code dinâmico para leitura em aplicativos de pagamento;
O valor a ser pago;
A chave PIX no formato “copia e cola”.

Parâmetros de Path

Nome	Exemplo	Descrição
conciliationId * string (path)	asdf92s6cc50wef8744wfkb696e28d11a55	Identificador de conciliação do PIX gerado anteriormente.

Responses

Code	Descrição
200	Página HTML contendo: `<img src="data:image/svg+xml;base64,..." alt="QR Code"/>` Valor: exibido em reais (ex.: R$ 20,09). Chave PIX: string “copia e cola”.
404	ID de conciliação não encontrado — página não existe.

GET /{conciliationId}/boleto_page

Exibe código de barras, valor e PDF do boleto

Acessando esta URL você verá uma página de pagamento contendo:

O código de barras do boleto;
O valor a ser pago;
Um link ou embed do PDF do boleto.

Parâmetros de Path

Nome	Tipo	Descrição
conciliationId * string (path)	1de15de9-934a-42e9-aa5c-6e64dec29602	Identificador de conciliação do boleto gerado anteriormente.

Responses

Code	Descrição
200	Página HTML contendo: Código de Barras: exibido em texto ou imagem; Valor: exibido em reais (ex.: R$ 50,00); PDF do Boleto: link ou embed `<iframe src="boleto.pdf"></iframe>` para download/impressão.
404	ID de conciliação não encontrado — página não existe.

📬 Webhook de Retorno de Pagamento

Após a liquidação de um PIX ou boleto, enviaremos um POST para as URLs cadastradas no perfil do cliente. Podem ser fornecidas duas URLs distintas: uma para PIX e outra para boleto.

Serão feitas até 5 tentativas de entrega caso a resposta não seja 200 OK.
O campo receiverReconciliationId (PIX) retornará o mesmo conciliationId da geração.
O campo authenticationCode (boleto) retornará o mesmo código gerado no boleto_get (com type=data).

Exemplo de Retorno PIX


[{
  "entityId":"44bce63a923d4497b99eb994b7a47e01",
  "companyKey":"HIPERBANCO_RESOLVE",
  "idempotencyKey":"44bce63a923d4497b99eb994b7a47e01",
  "context":"Pix",
  "name":"PIX_CASH_IN_WAS_CLEARED",
  "timestamp":"2025-02-17T19:54:32.3625059Z",
  "correlationId":"8937f2ef-f1b1-4e3d-ab20-fdd4e9c6d12e",
  "metadata":null,
  "data":{
    "addressingKey":{"value":"57dfe6ee-869f-4658-ac1c-96349c47db44","type":"EVP"},
    "authenticationCode":"9d66e7b2-36bc-485b-ae8c-a14769ca5be4",
    "amount":{"value":154,"currency":"BRL"},
    "recipient":{
      "document":{"value":"24639016000107","type":"CNPJ"},
      "type":"Business",
      "account":{"branch":"0001","number":"1113682989","type":"Payment","bank":{"ispb":"13140088"}}
    },
    "channel":{
      "name":"SPI",
      "end2EndId":"E18236120202502171954s0683d71b0d",
      "receiverReconciliationId":"44bce63a923d4497b99eb994b7a47e01",
      "pixInitializationType":"DynamicQrCode",
      "pixPaymentPurpose":"Payment"
    },
    "createdAt":"2025-02-17T19:54:32.3101686Z"
  },
  "version":"1"
}]

Campo	Tipo	Descrição
entityId	string	ID da transação gerada.
companyKey	string	Identificador da instituição.
idempotencyKey	string	Chave de idempotência usada no envio.
context	string	“Pix” – indica tipo de retorno.
name	string	Evento disparado.
timestamp	string	Data e hora do evento (ISO-8601).
correlationId	string	UUID para correlação de logs.
data.authenticationCode	string	Código de autenticação do PIX.
data.amount.value	number	Valor do PIX (centavos).
data.amount.currency	string	Moeda (ex.: BRL).
data.channel.receiverReconciliationId	string	ID de conciliação (fallback para conciliationId).
data.createdAt	string	Timestamp de criação (ISO-8601).
version	string	Versão do payload.

Exemplo de Retorno Boleto


[{
  "entityId":"71526791-8926-4221-833d-67b981ab1111",
  "companyKey":"FLORESTA_ED",
  "idempotencyKey":"56b5d77e-18ac-4a46-93f2-010586c3081c",
  "context":"Boleto",
  "name":"BOLETO_CASH_IN_WAS_CLEARED",
  "timestamp":"2022-11-09T11:31:38.2669076Z",
  "correlationId":"71526791-8926-4221-833d-67b981ab1111",
  "data":{
    "authenticationCode":"71526791-8926-4221-833d-67b981ab1111",
    "barcode":"65597940700000001000001115801398869900725986",
    "digitable":"65590001151446968518579001874704188970000002000",
    "amount":{"value":50.0,"currency":"BRL"},
    "channel":{"name":"Boleto","ourNumber":"46478921539"},
    "createdAt":"2022-11-09T11:31:34.9106453Z"
  },
  "version":"1.0"
}]

Campo	Tipo	Descrição
entityId	string	ID da operação de boleto.
companyKey	string	Identificador da instituição.
idempotencyKey	string	Chave de idempotência usada no envio.
context	string	“Boleto” – indica tipo de retorno.
name	string	Evento disparado.
timestamp	string	Data e hora do evento (ISO-8601).
correlationId	string	UUID para correlação de logs.
data.authenticationCode	string	Código de autenticação do boleto.
data.barcode	string	Código de barras do boleto.
data.digitable	string	Linha digitável do boleto.
data.amount.value	number	Valor do boleto.
data.amount.currency	string	Moeda (ex.: BRL).
data.channel.ourNumber	string	Nosso número do boleto.
data.createdAt	string	Timestamp de criação (ISO-8601).
version	string	Versão do payload.