Como usar a API para criar uma cobrança com uma subconta atrelada?

Criar cobrança com uma subconta atrelada via API

Para criar uma cobrança Pix com uma subconta atrelada, 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 com descontos 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
• subaccount: A chave da subconta que será atrelada à cobrança Pix.

Exemplo

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

{
  "correlationID": "c782e0ac-833d-4a89-9e73-9b60b2b41d3a",
  "value": 1600,
  "subaccount": "[email protected]" // Aqui estamos usando um email como chave Pix.
}

O campo subaccount é a chave Pix da subconta que será atrelada à cobrança Pix. Após o pagamento da cobrança, o valor será creditado (já aplicado a tarifa da plataforma) na subconta que você especificou na criação.

info

Antes de criar uma cobrança Pix com uma subconta atrelada, você precisa ter uma subconta cadastrada na plataforma OpenPix. Para saber como criar uma subconta, acesse esta documentação.

Exemplos em código

Shell + cURL

  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": 1600,
        "subaccount": "[email protected]"
      }'

JavaScript + Fetch

fetch('https://api.openpix.com.br/api/v1/charge', {
  method: 'POST',
  body: JSON.stringify({
    correlationID: 'c782e0ac-833d-4a89-9e73-9b60b2b41d3a',
    value: 1600,
    subaccount: '[email protected]',
  }),
  headers: {
    Authorization: 'AUTHORIZATION',
    'Content-Type': 'application/json',
  },
}).then((res) => res.json());