Skip to main content

Como usar a API para criar uma cobrança (cob)?

Para criar uma cobrança Pix, você utiliza o endpoint /api/v1/charge da API.

Você pode acessar aqui a documentação referente a esse endpoint.

Os campos obrigatórios para criar uma cobrança Pix são os seguintes:

  • value: O valor em centavos da cobrança Pix a ser criado.
  • correlationID: Um identificador único para a cobrança Pix. CorrelationID

Exemplo​

O body da sua requisição será semelhante a este exemplo:

{
  "value": 100,
  "correlationID": "c782e0ac-833d-4a89-9e73-9b60b2b41d3a"
}

Após efetuar a requisição, se tudo ocorreu bem, o status code da requisição será 2xx e no body da resposta, retornaremos a cobrança criada.

Retornarmeros a seguinte resposta de exemplo:

{
  "charge": {
    "customer": null,
    "value": 100,
    "identifier": "996ed4b7cc1c...",
    "correlationID": "c782e0ac-833d-4a89-9e73-9b60b2b41d3a",
    "paymentLinkID": "86f574fb-73...",
    "transactionID": "996ed4b7cc1c...",
    "status": "ACTIVE",
    "giftbackAppliedValue": 0,
    "discount": 0,
    "valueWithDiscount": 1500,
    "expiresDate": "2023-02-25T20:09:06.141Z",
    "type": "DYNAMIC",
    "createdAt": "2023-02-24T20:09:06.141Z",
    "additionalInfo": [],
    "updatedAt": "2023-02-24T20:09:14.165Z",
    "expiresIn": 86400,
    "pixKey": "d65032a3-c0c...",
    "brCode": "0002010102...",
    "paymentLinkUrl": "http://url.com/pay/...",
    "qrCodeImage": "http://url.com/openpix/charge/brcode/image/...",
    "globalID": "Q2hhcmdlOjYzZjkxOTZhNjA3ODg1..."
  },
  "correlationID": "c782e0ac-833d-4a89-9e73-9b60b2b41d3a",
  "brCode": "0002010102..."
}

Exemplos em código​

  curl 'https://api.openpix.com.br/api/v1/charge' -X POST \
      -H "Accept: application/json" \
      -H "Content-Type: application/json" \
      -H "user-agent: node-fetch" \
      --data-binary '{"correlationID":"c782e0ac-833d-4a89-9e73-9b60b2b41d3a","value":1500}'