Stater Platform

Enviar TEF

POST /accounts/:accountId/tef/internal-payment — etapa 2 do fluxo (efetiva a transferência interna).

Enviar TEF

Etapa 2 do fluxo de transferência interna (TEF): executa o envio para uma conta Stric/WL usando o accountNumber confirmado em /tef/beneficiary. Retorna imediatamente com status PROCESSING — a liquidação interna é assíncrona.

POST/accounts/:accountId/tef/internal-payment

Etapa 2 de 2. Antes desta chamada, faça POST /tef/beneficiary pra resolver o documento e escolher a accountNumber correta — não envie TEF sem confirmar visualmente o beneficiário. amount em reais decimal (atenção: diferente da API Pix base, que usa centavos string). PIN incorreto retorna 4xx. TEF é interno: nunca cruza bancos externos (use Pix pra isso). O status final (SUCCEEDED, FAILED, etc.) chega por reconciliação — consulte a transação por id em /accounts/:accountId/transactions ou aguarde callbacks.

Path params

  • accountIdObrigatório
    string (UUID)
    ID da conta que vai enviar o TEF.

Headers

  • AcceptObrigatório
    string
    application/json
  • Content-TypeObrigatório
    string
    application/json
  • AuthorizationObrigatório
    string
    Bearer <token> — JWT de /authenticate.
  • X-Tenant-IdObrigatório
    string (UUID)
    Identificador do tenant.

Body

  • accountNumberObrigatório
    string
    Número da conta beneficiária. Use o valor de beneficiary.accounts[].accountNumber retornado em /tef/beneficiary.
  • amountObrigatório
    number
    Valor a transferir em reais (decimal). Ex.: 0.01 = 1 centavo, 100.50 = R$ 100,50.
  • pinObrigatório
    string
    PIN da entidade (4 dígitos numéricos, conforme política do tenant).

Exemplo de requisição

bash
curl -X POST https://baas.staterpay.io/accounts/00000000-0000-0000-0000-000000000010/tef/internal-payment \  -H "Accept: application/json" \  -H "Content-Type: application/json" \  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>" \  -H "X-Tenant-Id: 00000000-0000-0000-0000-000000000000" \  -d '{    "accountNumber": "1000002",    "amount": 0.01,    "pin": "1234"  }'

Resposta

  • payout
    object
    Resumo do payout TEF submetido.
  • payout.kind
    "submitted"
    Marca a criação como submetida.
  • payout.payoutId
    string (cuid)
    ID do payout TEF no sistema interno.
  • payout.status
    "PROCESSING" | "SUCCEEDED" | "FAILED" | "CANCELLED" | "REFUNDED"
    Estado inicial sempre PROCESSING.
  • payout.endToEndId
    string | null
    Sempre null na criação. Preenchido após liquidação no provider.
  • payout.providerTransactionId
    string
    ID da transação no provider subjacente.
json
{  "payout": {    "kind": "submitted",    "payoutId": "cmoxample0002qkxyztef000",    "status": "PROCESSING",    "endToEndId": null,    "providerTransactionId": "00000000"  }}
URL base:https://baas.staterpay.io

On this page