Como usar a API para criar uma cobrança com split?

info

Para a ultilização dessa funcionalidade é necessário possuir a funcionalidade BETA

Para criar uma cobrança Pix com split, 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 Split 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
• splits: Um array contendo as configurações de split realizado na hora do recebimento

Exemplo

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

{
  "value": 100,
  "correlationID": "c782e0ac-833d-4a89-9e73-9b60b2b41d3a",
  "splits": [
    { "pixKey": "destinatario@openpix.com.br", "value": 15 },
    { "pixKey": "2a33747b-1715-4f57-8b9d-4cb73c15b19b", "value": 30 }
  ]
}

O valor do campo value dentro do objeto no array de splits, é o valor desejado para a realização do split em centavos. O valor restante continuará na conta de origem da cobrança

Após efetuar a requisição, se tudo ocorreu bem, o status code da requisição será 2xx e no body da resposta, além dos campos normais de cobrança criada, retornaremos os seguintes campos:

{
  "charge": {
    ...Charge Payload
    "splits": [
      { "pixKey": "destinatario@openpix.com.br", "value": 15 },
      { "pixKey": "2a33747b-1715-4f57-8b9d-4cb73c15b19b", "value": 30 }
    ]
  },
  "correlationID": "c782e0ac-833d-4a89-9e73-9b60b2b41d3a",
  "brCode": "00020101021226990014br.gov.bcb.pix2577pix-h.bpp.com.br/23114447/qrs1/v2/011Q0PuArnNb5VzolFm8H9X0A7yQb5Ayi6wZ2Koj6RX52040000530398654043.335802BR5911Krusty_Krab6009Sao_Paulo62290525cac964d74db74c479add4eabc63047932"
}

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":100, "splits": [{ "pixKey": "destinatario@openpix.com.br", "value": 15 }, { "pixKey": "2a33747b-1715-4f57-8b9d-4cb73c15b19b", "value": 30 }]}'

JavaScript + Fetch

fetch('https://api.openpix.com.br/api/v1/charge', {
  method: 'POST',
  body: JSON.stringify({
    value: 100,
    correlationID: 'c782e0ac-833d-4a89-9e73-9b60b2b41d3a',
    splits: [
      { pixKey: 'destinatario@openpix.com.br', value: 15 },
      { pixKey: '2a33747b-1715-4f57-8b9d-4cb73c15b19b', value: 30 },
    ],
  }),
  headers: {
    Authorization: 'AUTHORIZATION',
    'Content-Type': 'application/json',
  },
}).then((res) => res.json());