v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Listar recorrências

get/payments-recurrences

Response

successful operation

Example response

{
  "data": [
    {
      "id": "35455c30-49eb-4143-ac69-1887be87de78",
      "type": "PAYMENT",
      "status": "STARTED",
      "systemOrigin": "bc3c0faf-8ce0-40e7-a660-13ee735e9d09",
      "periodicity": {
        "type": "WEEKLY",
        "detail": {
          "startDate": "2025-06-16",
          "endDate": "2025-07-28",
          "quantity": 7
        }
      },
      "basePayment": {
        "type": "PIX_KEY",
        "amount": 0.55,
        "debitParty": {
          "name": "VECHI CONSULTORIA E PROJETOS LTDA",
          "taxId": "37297902000141",
          "account": {
            "type": "CC",
            "ispb": "30306294",
            "branch": "50",
            "number": "003886850",
            "bankCode": "208"
          }
        },
        "detail": {
          "creditParty": {
            "name": "BRUNO VIANA DE SIQUEIRA",
            "taxId": "***589211**",
            "account": {
              "bankCode": "208",
              "ispb": "30306294",
              "type": "**",
              "branch": "**",
              "number": "*********"
            }
          },
          "key": {
            "value": "06058921139",
            "type": "TAX_ID"
          }
        }
      },
      "errors": [
        {
          "detail": "Pendente aprovação de representante legal.",
          "code": "btg:enterprise:banking:payments:error:pending-approval",
          "arguments": {
            "contractId": "13287d0e-23c8-4d31-8cc7-989a3aaa6e16"
          }
        }
      ]
    }
  ]
}