Idea+Cash Developers
Login
PIX Out

Pix Out por chave Pix

Executa um fluxo de saída de Pix utilizando a chave Pix do beneficiário.

POST/integration/v1/pix/transfers
Corpo da requisição
CampoTipoDescrição
verifyobjectExemplo: {"type":"ALLOW"}
transaction*object

Exemplo de requisição

curl -X POST https://apiapp.dev.ideabank.com.br/integration/v1/pix/transfers \
  -H "Authorization: Bearer $TOKEN" \
  -H "tenantid: $TENANT_ID" -H "hostdevelop: apiapp.dev.ideabank.com.br" -H "Content-Type: application/json" \
  -d '{
  "verify": {
    "type": "ALLOW"
  },
  "transaction": {
    "remoteId": "11111111-2222-3333-4444-555555555555",
    "amount": 125.45,
    "reason": "Transferência Pix para fornecedor",
    "pixInfo": {
      "key": "+5511999999999",
      "keyType": 3,
      "description": "Pagamento de fornecedor via chave Pix"
    }
  }
}'

Exemplo de resposta (200)

{
  "id": "7f1d664d-73c7-4cbf-a984-2d0ec9c2ba81",
  "amount": 125.45,
  "status": 2,
  "flow": 2,
  "type": 6,
  "endToEndId": "E18236120202406111234S9X8Y7Z6W5V4U3",
  "description": "Pagamento Pix processado com sucesso",
  "pixInfo": {
    "key": "+5511999999999",
    "branch": "0001",
    "account": "123456789",
    "ispb": "12345678",
    "name": "Fornecedor Exemplo LTDA",
    "taxIdentifier": "12345678000195"
  }
}

Códigos de resposta

HTTPDescrição
200Pix Out por chave Pix processado com sucesso
401
403
409
422
500
Fonte
Esta página é gerada a partir do Swagger oficial. Para o payload autoritativo, consulte também a especificação viva.

← Voltar para o índice