v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Consultar os dados de uma conta

Essa API permite a consulta de uma conta (boleto) para validação dos seus dados. Veja o nosso artigo e saiba como realizar a implementação dessa API.

Entenda quais são os erros que essa API poderá retornar ao realizar a consulta de um pagamento, clique aqui.

Para testes em ambiente de sandbox recomendamos que seja utilizado a nossa massa de testes.

post/v5/transactions/billpayments/authorize

Request body

externalTerminalstring

Identificador do terminal do sistema cliente

externalNSUinteger

Identificador da transação do sistema cliente

Response

200

assignorstring

settleDatestring

dueDatestring

endHourstring

initeHourstring

nextSettlestring

digitablestring

transactionIdinteger

typeinteger

valuenumber

{"stackTrail":"paths:/v5/transactions/billpayments/authorize:post:responses:200:content:application/json:schema:properties:maxValue","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v5/transactions/billpayments/authorize:post:responses:200:content:application/json:schema:properties:minValue","oasType":"schema","type":"unknown"}

errorCodestring

{"stackTrail":"paths:/v5/transactions/billpayments/authorize:post:responses:200:content:application/json:schema:properties:message","oasType":"schema","type":"unknown"}

statusinteger

Example response

{
  "assignor": "BANCO BRADESCO S.A.",
  "registerData": {
    "documentRecipient": "21.568.259/0001-00",
    "documentPayer": "96.906.497/0001-00",
    "payDueDate": "2022-04-18T00:00:00",
    "dueDateRegister": "2022-02-15T00:00:00",
    "allowChangeValue": true,
    "recipient": "BENEFICIARIO AMBIENTE HOMOLOGACAO",
    "payer": "PAGADOR AMBIENTE HOMOLOGACAO",
    "minValue": 0.01,
    "originalValue": 502.27,
    "totalUpdated": 502.27,
    "totalPaymentPaid": 1,
    "totalValuePaid": 627.87,
    "maxPartialsAccepts": 99,
    "paymentSpecies": 31,
    "documentRecipientFinal": "19.101.991/0002-83",
    "recipientFinal": "BENEFICIARIO FINAL AMBIENTE HOMOLOGACAO"
  },
  "settleDate": "16/03/2022",
  "dueDate": "2022-02-15T00:00:00Z",
  "endHour": "23:00",
  "initeHour": "07:00",
  "nextSettle": "N",
  "digitable": "23792374039002121400385000334004688970000050227",
  "transactionId": 9180742,
  "type": 2,
  "value": 502.27,
  "errorCode": "000"
}