v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Criar cobrança com vencimento

Essa API possibilita que seja realizado o vinculo de um QR Code a uma cobrança com vencimento, multa, juros, ou abatimentos (COBV).

post/collection/duedate

Request body

clientRequestIdstring required

Identificador único da transação fornecida pelo cliente. Este valor não pode ser repetido.

expirationAfterPaymentinteger required

Dias para expiração da cobrança após o vencimento.

duedatestring date required

Data de vencimento.

debtorobject required

Dados do pagador para cobranças com vencimento (COBV)

receiverobject required

Dados do recebedor para cobranças com vencimento (COBV)

locationIdinteger required

Identificador único do BRCode a ser associado a cobrança.

amountnumber double required

Valor original desta cobrança.

amountDicountobject

Desconto a ser oferecido de acordo com a modalidade escolhida.

amountAbatementobject

Abatimento consedido de acordo com a modalidade escolhida.

amountFineobject

Multa aplicada de acordo com a modalidade escolhida.

amountInterestobject

Juros aplicado de acordo com a modalidade escolhida.

payerQuestionstring

Informação que pode ser apresentada ao pagador no ato.

keystring required

Chave Pix que contém as informações de liquidação de pagamento.

Response

200

transactionIdentificationstring

transactionIdinteger

clientRequestIdstring

statusstring

lastUpdatestring

{"stackTrail":"paths:/collection/duedate:post:responses:200:content:application/json:schema:properties:payerQuestion","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/collection/duedate:post:responses:200:content:application/json:schema:properties:additionalInformation","oasType":"schema","type":"unknown"}

keystring

createAtstring

Example response

{
  "transactionIdentification": "kk6g232xel65a0daee4dd13kk9189382",
  "transactionId": 9189382,
  "clientRequestId": "9b26edb7cf254db09f5449c94bf13abc",
  "status": "ACTIVE",
  "lastUpdate": "2022-03-21T14:27:58.2106288+00:00",
  "debtor": {
    "name": "Fulano de Tal",
    "cnpj": "61360961000100"
  },
  "amount": {
    "original": 15.63,
    "discount": {
      "discountDateFixed": [
        {
          "date": "2022-03-21T00:00:00",
          "amountPerc": "1.00"
        }
      ],
      "modality": "FIXED_VALUE_UNTIL_THE_DATES_INFORMED"
    }
  },
  "location": {
    "merchant": {
      "postalCode": "01201005",
      "city": "Barueri",
      "merchantCategoryCode": "0000",
      "name": "Celcoin Pagamentos"
    },
    "url": "api-h.developer.btgpactual.com/v1/p/v2/cobv/8767107ce1db49fdb1058224e00c4ab1",
    "emv": "00020101021226980014br.gov.bcb.pix2576api-h.developer.btgpactual.com/v1/p/v2/cobv/8767107ce1db49fdb1058224e00c4ab15204000053039865802BR5918Celcoin Pagamentos6007Barueri61080120100562070503***630411F9",
    "type": "COBV",
    "locationId": "12731020"
  },
  "key": "testepix@celcoin.com.br",
  "receiver": {
    "name": "João da Silva",
    "fantasyName": "Nome de Comercial",
    "cnpj": "60904237000129"
  },
  "calendar": {
    "expirationAfterPayment": "10",
    "createdAt": "0001-01-01T00:00:00",
    "dueDate": "2022-03-22T00:00:00"
  },
  "createAt": "2022-03-21T14:27:58.2106288+00:00"
}