Editar uma transferência

🚧 Somente é possível editar uma transferência que esteja com o status de erro.

PUT{apiUrl}/pixout/transfer/{batch_id}/{transfer_id}

URL base da API

Token de autenticação

Path Params

batch_idstringrequired

id do lote da transferência

transfer_idstringrequired

id da transferência

Body Params

pix_key_typestringrequired

Tipo de chave Pix

pix_keystringrequired

Chave Pix

idempotency_keystringoptional

Chave de idempotência

curl --request PUT \
  --url "{apiUrl}/pixout/transfer/{batch_id}/{transfer_id}" \
  --header "Content-Type: application/json" 
  --data '{}'

Response

Choose an example:

application/json

Campos da resposta

transfer_idstring

UUID da transferência

statusstring

Status: pending, paid, failed

namestring

Nome do recebedor

documentstring

CPF ou CNPJ do recebedor

pix_key_typestring

Tipo da chave Pix

pix_keystring

Chave Pix

external_referencestring

Referência externa

amountnumber

Valor da transferência

idempotency_keystring

Chave de idempotência

bank_receipt_urlstring

URL do comprovante bancário

paid_datestring

Data de pagamento (ISO 8601)