Pular para o conteúdo

Listar planos

GEThttps://api.sandbox.cefispay.com.br/api/v1/plans

Lista os planos da sua conta. Só pagina quando a requisição traz page ou limit; sem nenhum dos dois, devolve todos os planos de uma vez, só com data (sem links e meta). Os filtros estão no guia de listagens.

Parâmetros de query

  • pageinteger≥ 1

    A página, a partir de 1.

    Padrão: 1

  • limitinteger≥ 1≤ 100

    Itens por página, de 1 a 100.

    Padrão: 10

Respostas

200A página de planos

Corpo da resposta

application/json

Exemplo

{
  "data": [
    {
      "id": "string",
      "uuid": "string",
      "name": "string",
      "public_name": "string",
      "methods": [
        "string"
      ],
      "value": 0,
      "fine": 0,
      "interest": 0,
      "interval": 0,
      "interval_type": "string",
      "charges": 0,
      "trial_days": 0,
      "retry_days": 0,
      "automatic_cancel": true,
      "url": "string",
      "custom_layout_enabled": true,
      "custom_layout": "string",
      "redirect_uri": "string",
      "status": "active",
      "custom_fields": [
        "string"
      ],
      "billing_products": [
        "string"
      ],
      "company": {},
      "charge_enabled": true,
      "billing_settings": {},
      "dunning": {},
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 0,
    "last_page": 0,
    "per_page": 0,
    "total": 0
  }
}
401Não autenticado

Corpo da resposta

application/json

  • codestring

    O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.

  • messagestring

    A mensagem do erro.

  • errorsobject

    Os erros de cada campo, quando o code é VALIDATION_ERROR.

  • timestampstringdate-time

    A data e hora do erro, em UTC.

  • request_idstring

    Um identificador único gerado para esta resposta de erro.

  • documentation_urlstring

    O endereço desta documentação.

  • suggestionstring

    Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "AUTHENTICATION_ERROR",
  "message": "Não autenticado.",
  "timestamp": "2026-10-22T12:03:44+00:00",
  "request_id": "f2a7e962-6083-4525-816e-f14d4a602e0a",
  "documentation_url": "https://docs.ninepay.com.br"
}
422Erro na validação dos dados

Corpo da resposta

application/json

  • codestring

    O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.

  • messagestring

    A mensagem do erro.

  • errorsobject

    Os erros de cada campo, quando o code é VALIDATION_ERROR.

  • timestampstringdate-time

    A data e hora do erro, em UTC.

  • request_idstring

    Um identificador único gerado para esta resposta de erro.

  • documentation_urlstring

    O endereço desta documentação.

  • suggestionstring

    Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "VALIDATION_ERROR",
  "message": "Os dados informados são inválidos.",
  "errors": {
    "email": [
      "O campo email é obrigatório."
    ]
  },
  "timestamp": "2026-10-22T12:03:54+00:00",
  "request_id": "64d62d36-e797-45ed-a9d5-c203bde81032",
  "documentation_url": "https://docs.ninepay.com.br",
  "suggestion": "Corrija os campos e tente novamente."
}
500Erro inesperado

Corpo da resposta

application/json

  • codestring

    O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.

  • messagestring

    A mensagem do erro.

  • errorsobject

    Os erros de cada campo, quando o code é VALIDATION_ERROR.

  • timestampstringdate-time

    A data e hora do erro, em UTC.

  • request_idstring

    Um identificador único gerado para esta resposta de erro.

  • documentation_urlstring

    O endereço desta documentação.

  • suggestionstring

    Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "UNEXPECTED_ERROR",
  "message": "Houve um erro inesperado.",
  "timestamp": "2026-10-22T12:04:46+00:00",
  "request_id": "868443d3-38fd-4c92-8ea8-7cccbbce4308",
  "documentation_url": "https://docs.ninepay.com.br",
  "suggestion": "Verifique todos os parâmetros da requisição. Se o erro persistir, entre em contato com nossa equipe em ti@ninepay.com.br."
}

Linguagem

Credenciais

Header
Header
curl --request GET \
     --url https://api.sandbox.cefispay.com.br/api/v1/plans \
     --header 'accept: application/json'

Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui

Ou escolha um exemplo:

application/json