Solicitar transferência em lote
POST
https://{apiUrl}/pixout/transferAtualizado em · 3 min de leitura
Endpoint: POST https://{apiUrl}/pixout/transfer
Envia um lote de transferências PIX. Além do token de autenticação, este endpoint requer que o payload seja assinado com uma chave RSA privada. Consulte a página de Autenticação com assinatura RSA para configurar sua chave.
Parâmetros
POST
https://{apiUrl}/pixout/transferURL base da API
Token de autenticação
Body Params
transfersarrayrequired
Lista de transferências PIX do lote
curl --request POST \
--url "https://{apiUrl}/pixout/transfer" \
--header "Content-Type: application/json"
--data '{}'Response
Choose an example:
application/json
Sub-campos de transfers[]
Cada item de transfers[]:
Body Params
keystringrequired
Chave Pix do destinatário
key_typestringrequired
Tipo: CPF, CNPJ, EMAIL, PHONE ou EVP
valuefloatrequired
Valor em reais a transferir
documentstringrequired
CPF ou CNPJ do destinatário
namestringrequired
Nome do destinatário
descriptionstringoptional
Descrição ou motivo da transferência
Exemplo de requisição
json
{
"transfers": [
{
"key": "joao@exemplo.com",
"key_type": "EMAIL",
"value": 150.00,
"document": "11111111111",
"name": "João da Silva",
"description": "Pagamento referência #001"
}
]
}Exemplo de resposta
json
{
"batch_id": "lote-uuid-aqui",
"status": "pending",
"created_at": "2024-10-01T15:36:00Z"
}Campos da resposta
batch_idstring
UUID do lote criado — use para consultar o status das transferências
statusstring
Estado inicial do lote: pending
created_atstring
Data de criação do lote no formato ISO 8601
Exemplo de requisição
curl --request POST \
--url "https://{apiUrl}/pixout/transfer" \
--header "Authorization: Bearer {token}" \
--header "Signature: {assinatura-rsa-em-base64}" \
--header "Content-Type: application/json" \
--data '{
"transfers": [
{
"key": "joao@exemplo.com",
"key_type": "EMAIL",
"value": 150.00,
"document": "11111111111",
"name": "João da Silva",
"description": "Pagamento referência #001"
}
]
}'Esta página foi útil?