Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Pagamentos

Listar um pagamento ou transferência específico

get/{companyId}/banking/payments/{paymentId}

Path parameters

companyIdstring required

CNPJ da empresa

Example:1234124210002
paymentIdstring required
Example:29d42888-a920-4a85-a163-aa25b4937b3f

Response

Pagamento

paymentIdstring
type'BANKSLIP' | 'PIX_QR_CODE' | 'UTILITIES' | 'TED' | 'PIX'

Boleto de cobrança

status'CONFIRMED' | 'CREATED' | 'CANCELED' | 'FAILED' | 'PROCESSED' | 'ADJOURNED' | 'REVERTED' | 'SCHEDULED'

Status do pagamento

amountnumber
paymentDatestring date

Example response

{
  "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"
}