v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Pagamentos

Listar iniciação de pagamento ou transferência

get/{companyId}/banking/payments

Path parameters

companyIdstring required

CNPJ da empresa

Example:1234124210002

Query parameters

pageSizenumber required

Número de itens a serem incluidos na página

pageNumbernumber required

Número da página onde começará a query

paymentTypestring

Tipo do pagamento(TED, PIX_MANUAL, etc...)

receiverstring

CNPJ da parte creditada

batchIdstring

Id do lote de transferências/pagamentos

minPaymentDatestring

Data minima de pagamento

maxPaymentDatestring

Data máxima de pagamento

minAmountnumber

Valor minimo da transação

maxAmountnumber

Valor maximo da transação

statusstring

Status do pagamento ou transferências

Response

Lista de Pagamentos

Example response

{
  "data": [
    {
      "paymentId": "29d42888-a920-4a85-a163-aa25b4937b3f",
      "status": "CREATED",
      "amount": 0.01,
      "debitParty": {
        "taxId": "00000000000141",
        "name": "NOME DA EMPRESA",
        "number": "000000050",
        "branchCode": "50",
        "bankCode": "208"
      },
      "detail": {
        "digitableLine": "20890050091195069626700021179601493360000000001",
        "dueDate": "2024-06-18T00:00:00.000Z",
        "payee": {
          "document": "00000000000125",
          "fantasyName": "VECHI CONSULTORIA E PROJETOS LTDA",
          "socialName": "VECHI CONSULTORIA E PROJETOS LTDA",
          "bankCode": "208",
          "bankName": "VECHI CONSULTORIA E PROJETOS LTDA"
        }
      },
      "tags": {
        "externalId": "8725b04c-1354-4ad7-91db-4bbb2138e390",
        "originTransactionId": "48b33060-7960-4093-bc93-ed9105c3c657"
      },
      "paymentDate": "2023-03-20T00:00:00.000Z"
    }
  ],
  "_links": {
    "next": {
      "href": "/v1/companies/30306294000145/payments?cursor=cGFnZT0yJml0ZW1zUGVyUGFnZT0xMCZ0eXBlPW51bGwmc3RhdHVzPVNFTlQ=",
      "method": "GET"
    }
  }
}