Gateway Crédito Direto
Entrar

API do Gateway

Pagamentos

Lotes e transferências Pix (cash-out) para parceiros e favorecidos.

GET/payments/batchesAutenticado

Listar lotes

Lista os lotes de cash-out (Pix em lote) da conta.

https://gateway.credito-direto.com/api/payments/batches

cURL

cURL
curl --request GET \
  --url 'https://gateway.credito-direto.com/api/payments/batches' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN'

Exemplo de resposta

Response JSON
{
  "items": [
    {
      "id": "bat_01",
      "name": "Folha 08/2026",
      "status": "draft",
      "created_at": "2026-08-21T09:00:00.000Z"
    }
  ]
}
POST/payments/batchesAutenticado

Criar lote

Abre um lote em rascunho para receber transferências Pix.

https://gateway.credito-direto.com/api/payments/batches

cURL

cURL
curl --request POST \
  --url 'https://gateway.credito-direto.com/api/payments/batches' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN' \
  --header 'content-type: application/json' \
  --data '{ "name": "Folha 08/2026" }'

Corpo da requisição

CampoTipoObrigatórioDescrição
namestringSimNome do lote (ex.: Folha 08/2026).

Exemplo de requisição

Body JSON
{ "name": "Folha 08/2026" }
POST/payments/batches/:id/closeAutenticado

Processar lote

Fecha o lote e dispara o processamento das transferências incluídas.

https://gateway.credito-direto.com/api/payments/batches/:id/close

cURL

cURL
curl --request POST \
  --url 'https://gateway.credito-direto.com/api/payments/batches/:id/close' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN'

Parâmetros de caminho

CampoTipoObrigatórioDescrição
idstringSimIdentificador do lote.
  • Só é possível fechar lotes que estejam em rascunho e contenham transferências.
GET/payments/transfersAutenticado

Listar transferências

Lista transferências Pix (cash-out). Filtre por lote com `batch_id`.

https://gateway.credito-direto.com/api/payments/transfers

cURL

cURL
curl --request GET \
  --url 'https://gateway.credito-direto.com/api/payments/transfers' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN'

Query string

CampoTipoObrigatórioDescrição
batch_idstringNãoRestringe ao lote informado.

Exemplo de resposta

Response JSON
{
  "items": [
    {
      "id": "tr_01",
      "batch_id": "bat_01",
      "status": "transferred",
      "value": 25000,
      "pix_description": "Repasse parceiro — ago/2026",
      "destination_bank_account": {
        "name": "João Souza",
        "cpf_cnpj": "98765432100",
        "pix_key": "joao@empresa.com"
      },
      "created_at": "2026-08-21T09:10:00.000Z"
    }
  ]
}
POST/payments/transfersAutenticado

Criar transferência Pix

Inclui um cash-out em um lote. Destino por chave Pix e/ou dados bancários. Valor em centavos.

https://gateway.credito-direto.com/api/payments/transfers

cURL

cURL
curl --request POST \
  --url 'https://gateway.credito-direto.com/api/payments/transfers' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN' \
  --header 'content-type: application/json' \
  --data '{ "batch_id": "bat_01", "value": 25000, "pix_description": "Repasse parceiro — ago/2026", "destination_bank_account": { "name": "João Souza", "cpf_cnpj": "98765432100", "pix_key": "joao@empresa.com" } }'

Corpo da requisição

CampoTipoObrigatórioDescrição
batch_idstringSimLote de destino (status draft).
valueintegerSimValor em centavos.
pix_descriptionstringNãoDescrição no comprovante Pix.
destination_bank_account.namestringSimNome do recebedor.
destination_bank_account.cpf_cnpjstringSimCPF ou CNPJ do recebedor, somente números.
destination_bank_account.pix_keystringNãoChave Pix de destino. Recomendado para Pix.
destination_bank_account.bank_codestringNãoCódigo do banco (quando não usar chave Pix).
destination_bank_account.agencystringNãoAgência.
destination_bank_account.accountstringNãoConta com dígito.

Exemplo de requisição

Body JSON
{
  "batch_id": "bat_01",
  "value": 25000,
  "pix_description": "Repasse parceiro — ago/2026",
  "destination_bank_account": {
    "name": "João Souza",
    "cpf_cnpj": "98765432100",
    "pix_key": "joao@empresa.com"
  }
}