v1

latestOpenAPI 3.1.02026-07-24280138.8 KB

Pagar boleto em stage

Realize o pagamento de um boleto ou QR Code em ambiente de Stage através desta API, podendo auxiliar em testes no fluxo de gestão de faturas.

post/pay

Headers

Idempotency-Keystring required

Request body

idstring required

Response

200

idstring

amountTotalinteger

statusstring

documentUrlstring

{"stackTrail":"paths:/pay:post:responses:200:content:application/json:schema:properties:pix","oasType":"schema","type":"unknown"}

paymentFormsstring[]

createdAtstring

authenticationIdstring

{"stackTrail":"paths:/pay:post:responses:200:content:application/json:schema:properties:taxInfo","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/pay:post:responses:200:content:application/json:schema:properties:recurrence","oasType":"schema","type":"unknown"}

Example response

{
  "id": "d64a6b1c-52dc-4ee1-83f4-d29e39e198f1",
  "amountTotal": 1000,
  "status": "IN_PAYMENT",
  "documentUrl": "https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/boleto-e257d92a-fbcb-404b-9e83-bcd1af887ffb.pdf?generation=1650658115895756&alt=media",
  "buyer": {
    "name": "Gol Transportes Aereos Sa",
    "document": "34052649000178",
    "email": "email@email.com",
    "type": "PJ",
    "address": {
      "street": "Rua Gomes de Carvalho",
      "number": "1629",
      "district": "Vila Olímpia",
      "city": "São Paulo",
      "state": "SP",
      "complement": "N/A",
      "zip_code": "00111222"
    }
  },
  "seller": {
    "businessId": "77677794-7d5c-4d5a-bb7e-a82a44e8d130",
    "name": "Eva Inc",
    "document": "10810830000138",
    "type": "PJ"
  },
  "bankSlip": {
    "barcode": "00199919700000010000000003202047000001826217",
    "digitable": "00190000090320204700900018262179991970000001000",
    "registered": true,
    "url": "https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/boleto-e257d92a-fbcb-404b-9e83-bcd1af887ffb.pdf?generation=1650658115895756&alt=media",
    "documentSequence": 18262,
    "interestMonthlyPercent": 3.67,
    "fineValue": 200,
    "discountPercent": 1.5,
    "billType": "REGULAR"
  },
  "services": [
    {
      "name": "Nome Do Serviço",
      "description": "Descrição do serviço",
      "amount": 1000
    }
  ],
  "paymentTerms": {
    "dueDate": "2022-12-12",
    "interest": {
      "value": 367,
      "type": "PERCENT"
    },
    "fine": {
      "value": 200,
      "type": "FIXED",
      "startAt": "2022-12-13"
    },
    "discount": {
      "value": 150,
      "type": "PERCENT"
    }
  },
  "payments": [
    {
      "id": "6999b623-a07c-45e7-a2b7-1e5272503b81",
      "state": "IN_PROCESS",
      "createdAt": "2022-04-22T20:15:07Z",
      "amount": 1000,
      "order": 1
    }
  ],
  "paymentForms": [
    "BANK_SLIP"
  ],
  "createdAt": "2022-04-22T20:08:35Z",
  "authenticationId": "6999b623-a07c-45e7-a2b7-1e5272503b81",
  "notification": {
    "id": "0a794510-1f15-461e-92b4-2a6e7d701cc8",
    "channel": "EMAIL",
    "destination": {
      "name": "Fulano Ciclano Oliveira",
      "contact": "email@email.com"
    },
    "schedules": [
      {
        "rule": "NOTIFY_TEN_DAYS_AFTER_DUE_DATE",
        "status": "SCHEDULED",
        "scheduledTo": "2022-12-22"
      }
    ]
  }
}

All 28 operations