Iniciação de pagamento

Inicie ou agende pagamentos através desta API

post/initiate

Request

  • Base URL
    https://api.stage.cora.com.br/payments
  • URL
    https://api.stage.cora.com.br/payments/initiate
  • Auth
    OAuth 2

Headers

Idempotency-Keystring required

UUID aleatório gerado por você. Nós utilizamos esse header para evitar duplicidade de registros, ou seja, caso você não tenha recebido a resposta de alguma requisição e mandar o mesmo UUID, nós não duplicaremos o registro. Ela não cria um novo pagamento para um boleto que já foi iniciado: veja "Um pagamento por boleto" em Dicas de implementação.

Request body

codestring
digitable_linestring required

Código de barras da fatura a ser paga

scheduled_atstring

Response

201

idstring
statusstring
amountinteger
created_atstring
scheduled_atunknown
codestring

Example response

{
  "id": "pay_1BfWu4uq2hdK0EOXk73ZSY",
  "status": "INITIATED",
  "amount": 1105,
  "creditor": {
    "name": "Cora Bank",
    "document": "34052649000178",
    "type": "PF"
  },
  "services": [
    {
      "name": "Cora Bank",
      "amount": 1000
    }
  ],
  "bank_slip": {
    "barcode": "00194812100000000010000003202047002240474517",
    "digitable": "00190000090320204700900019957179991970000002735",
    "registered": true,
    "fine": 70,
    "interest": 35,
    "bill_type": "REGULAR"
  },
  "payment_terms": {
    "due_date": "2023-06-06"
  },
  "created_at": "2023-05-02T20:23:27",
  "code": "meu_id"
}

Changes

No recorded changes to this operation across all 1 revision of this API.