v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
Payment

Pagamento de conta.

post/billpayment

Request body

clientRequestIdstring required

Identificador do cliente.

amountnumber double required

Valor a ser pago.

accountstring required

Numero da conta a ser realizado o débito do boleto

transactionIdAuthorizeinteger required

ProtocoloId retornado no endpoint Authorize.

Example request

{
  "clientRequestId": "5555",
  "amount": 59.9,
  "account": "333333",
  "transactionIdAuthorize": 321,
  "tags": [
    {
      "key": "PaymentType",
      "value": "Contas Internas"
    }
  ],
  "barCodeInfo": {
    "digitable": "23793381286008301352856000063307789840000150000",
    "barCode": "23797898400001500003381260083013525600006330"
  }
}

Response

Ok

statusstring nullable

Status.

versionstring nullable

Versão da api.

Example response

{
  "status": "SUCCESS",
  "version": "1.0.0",
  "body": {
    "id": "ce9b8d9b-0617-42e1-b500-80bf9d8154cf",
    "clientRequestId": "5555",
    "amount": 59.9,
    "barCodeInfo": {
      "digitable": "23793381286008301352856000063307789840000150000",
      "barCode": "23797898400001500003381260083013525600006330"
    }
  }
}