API v1
Em breve · Pagar Pix

Pagar Pix copia-e-cola

POST/v1/pix-code-paymentspix_code_payments:writeEM BREVE

Paga um BR Code a partir do seu saldo. A tarifa é somada ao valor.

Este recurso ainda não está disponível. O contrato abaixo mostra como ele vai funcionar, para você planejar a integração. Hoje a chamada é recusada e nada é criado; os campos podem mudar até a liberação, que sai no changelog.

Cabeçalhos

Authorizationstringobrigatório

Bearer seguido da sua chave: gw_test_ em teste, gw_live_ em produção.

Idempotency-Keystring · 8–128obrigatório

Corpo da requisição

external_idstring · 1–128obrigatório
copy_pastestring · 20–4096obrigatório
amount_centsinteger · mín. 1opcional

Obrigatório quando o código não tem valor fixo.

exemplo 4990 = R$ 49,90
confirm_recipienttrueobrigatório

Confirma que você conferiu o recebedor devolvido pelo decode.

metadataobject · até 20 chavesopcional

Pares chave-valor seus, até 2 KB.

Resposta 201

Sucesso.

iduuid
external_idstring
statusstring
PROCESSINGCOMPLETEDFAILEDUNKNOWN
amount_centsinteger
exemplo 4990 = R$ 49,90
fee_centsinteger
exemplo 149 = R$ 1,49
total_debit_centsinteger
exemplo 5139 = R$ 51,39
recipientobject | null
2 campos
namestring | null
bankstring | null
end_to_end_idstring | null
metadataobject · até 20 chaves

Pares chave-valor seus, até 2 KB.

created_atdatetime

Códigos de resposta

HTTPQuando acontece
201Sucesso.

Outras operações de Pagar Pix

POST/v1/pix-code-payments/decodeLer Pix copia-e-colaGET/v1/pix-code-payments/{pixCodePaymentId}Consultar pagamento de Pix copia-e-cola