Menu
Documentation
Documentation /Transferencia TED
API reference Producao Sandbox mTLS + JWT

Transferencia TED

Endpoint POST /hb/transfers/ted

Mesmo contrato

Sandbox e producao seguem a mesma referencia funcional para integracao.

Credencial separada

Cada ambiente exige token e certificado emitidos especificamente para ele.

Leitura operacional

Consulte autenticacao, seguranca e fluxos de accounts sem trocar de referencia.

Transferencia TED

Endpoint: POST /hb/transfers/ted

Formato padrao de resposta

Envelope de sucesso (interceptor global):

{
  "status_code": 200,
  "success": true,
  "message": "OK",
  "data": {}
}

Envelope de erro (filtro global):

{
  "status_code": 400,
  "code": "VALIDATION_ERROR",
  "message": "Erro de validacao",
  "timestamp": "2026-02-13T00:00:00.000Z",
  "path": "/exemplo",
  "details": []
}

POST /hb/transfers/ted

  • Autenticacao: Bearer JWT obrigatorio
  • Contexto de conta: Exige conta ativa quando aplicavel
  • Roles: OPERADOR, ADMIN, GERENTE
  • Scopes: ted.cashout.create

Request

Path params

Nao possui.

Query params

Nao possui.

Body

DTO: CreateTransferDto

CampoTipoObrigatorioDetalhes
amountnumberSim-
recipientRecipientDtoSimObjeto esperado: { accountType?: AccountType (enum: CHECKING, SAVINGS); document: string; bankCode: string; branch: string; account: string; name: string }
descriptionstringSim-
coordinatesCoordinatesDtoNaoObjeto esperado: { lat: number; lng: number }

Headers

  • Authorization: Bearer <jwt>: obrigatorio.
  • x-account-id: obrigatorio para informar a conta do contexto da operacao.

Exemplos de requisicao

bash
curl -X POST "https://uzepay-mtls.deploy.pixland.com.br/hb/transfers/ted" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer SEU_JWT" \
  -H "x-account-id: SEU_ACCOUNT_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1,
  "recipient": {
    "document": "12345678901",
    "bankCode": "string_exemplo",
    "branch": "0001",
    "account": "123456",
    "name": "string_exemplo"
  },
  "description": "string_exemplo"
}'

Response

Data (schema)

Nao tipado no retorno do controller. Informe um tipo de retorno para documentar automaticamente.

Sucesso (201):

{
  "status_code": 201,
  "success": true,
  "message": "Created",
  "data": "<resultado da operacao>"
}

Erro (contrato padrao):

{
  "status_code": 400,
  "code": "VALIDATION_ERROR",
  "message": "Erro de validacao",
  "timestamp": "2026-02-13T00:00:00.000Z",
  "path": "/hb/transfers/ted",
  "details": []
}