Solicitar transferência em lote

Além do token de autenticação, este endpoint requer que o payload seja assinado com uma chave RSA privada. Consulte Autenticação com assinatura RSA para configurar sua chave.

POST{apiUrl}/pixout/transfer

URL base da API

Token de autenticação

Body Params

descriptionstringrequired

Descrição do lote de transferências

postbackUrlstringoptional

URL que receberá atualizações das transferências

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

Response

Choose an example:

application/json

Campos da resposta

batch_idstring

UUID do lote criado

descriptionstring

Descrição do lote

created_atstring

Data de criação (ISO 8601)

postbackUrlstring

URL de postback configurada

total_grossnumber

Valor bruto total do lote

total_transfernumber

Valor líquido total a ser transferido

total_feenumber

Total de taxas cobradas

receiversarray

Lista de recebedores processados

receivers[].transfer_idstring

UUID da transferência individual

receivers[].statusstring

Status: pending, paid, failed

receivers[].namestring

Nome do recebedor

receivers[].documentstring

CPF ou CNPJ do recebedor

receivers[].pix_key_typestring

Tipo da chave Pix

receivers[].pix_keystring

Chave Pix

receivers[].external_referencestring

Referência externa

receivers[].amountnumber

Valor da transferência

receivers[].idempotency_keystring

Chave de idempotência

receivers[].bank_receipt_urlstring

URL do comprovante bancário

receivers[].paid_datestring

Data de pagamento (ISO 8601)

curl --request POST \
  --url "{apiUrl}/pixout/transfer" \
  --header "Authorization: Bearer {token}" \
  --header "Signature: {assinatura-rsa-em-base64}" \
  --header "Content-Type: application/json" \
  --data '{
    "description": "Pagamentos em lote",
    "receivers": [
      {
        "name": "Maria da Silva",
        "document": "11111111111",
        "pix_key_type": "CPF",
        "pix_key": "11111111111",
        "external_reference": "PIX01",
        "amount": 1.5,
        "idempotency_key": "5e5b095c-c941-442e-85de-2f6a92461314"
      }
    ]
  }'