Realizar Pagamento

POST /v2/pix/payment

Realizar Pagamento

cURL

curl --request POST \
  --url https://api.example.com/v2/pix/payment \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "external_id": "<string>",
  "payerQuestion": "<string>",
  "postbackUrl": "<string>",
  "creditParty": {
    "key": "<string>",
    "keyType": "<string>",
    "document": "<string>",
    "name": "<string>"
  }
}
'

Realiza um pagamento Pix para uma chave específica (Cash-out).

Headers

Header	Valor	Descrição
Authorization	Bearer <access_token>	Token de acesso.

Parâmetros do Body

amount · number · required

Valor do pagamento.

external_id · string · required

ID único para identificar o pagamento.

payerQuestion · string

Descrição do pagamento.

postbackUrl · string

URL para receber notificações de status.

creditParty · object · required

Dados do beneficiário.

Show properties

key · string · required

Chave Pix

keyType · string · required

Tipo de chave (EMAIL, CPF, CNPJ, PHONE, EVP)

document · string

CPF/CNPJ do beneficiário

name · string

Nome do beneficiário