Listar Planos

GET /plans

Para utilizar esse método, o access_token deve conter o scope plans.read

Retorna todas as informações dos planos de acordo com o filtro informado.

Dados da requisição

Nome

Tipo

Obrigatório

Explicação

myIds

string

Não

Ids do plano no seu sistema.
Separe cada id por vírgula.

galaxPayIds

string

Não

Ids do plano no cel_cash.
Separe cada id por vírgula.

createdAtFrom

date

Não

Data de criação inicial

createdAtTo

date

Não

Data de criação final.

createdOrUpdatedAtFrom

date

Não

Data de criação/atualização inicial.

createdOrUpdatedAtTo

date

Não

Data de criação/atualização final.

status

string

Não

Status do plano. Separe cada valor por vírgula.

Valor	Explicação
active	Ativo
inactive	Inativo

startAt

int

Sim

Ponteiro inicial para trazer os registros.

limit

int

Sim

Qtd máxima de registros para trazer.

order

string

Não

Ordenação do resultado. String que deverá ser montada da seguinte maneira:
campoDaEntidade.tipoDeOrdem

Caso queira passar mais de uma ordenação, separar por vírgula:
campoDaEntidade.tipoDeOrdem, campoDaEntidade2.tipoDeOrdem

Valor	Explicação
createdAt.asc	Plano criado em - Ordem crescente
createdAt.desc	Plano criado em - Ordem decrescente
updatedAt.asc	Plano alterado em - Ordem decrescente
updatedAt.desc	Plano alterado em - Ordem decrescente

URL da Requisição

https://api.sandbox.cel.cash/v2/plans

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "totalQtdFoundInPage": 1,
    "Plans": [
        {
            "galaxPayId": 1,
            "myId": "pay-664ad2ccc7e7f3.06160780",
            "name": "Plano mensal 2 pessoas",
            "periodicity": "monthly",
            "quantity": 12,
            "additionalInfo": "Lorem ipsum dolor sit amet.",
            "PlanPrices": [
                {
                    "payment": "creditcard",
                    "value": 12999
                }
            ]
        }
    ]
}

Nome

Tipo

Explicação

totalQtdFoundInPage

int 11 dígitos

Quantidade total de registros do retorno da busca na página atual.

Plans

Array de planos
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id no cel_cash

myId

string 255 caracteres

Id referente no seu sistema.

name

string 255 caracteres

Nome do plano.

periodicity

string 255 caracteres

Periodicidade do plano.

Valor

Explicação

weekly

Semanal

biweekly

Quinzenal

monthly

Mensal

bimonthly

Bimestral

quarterly

Trimestral

biannual

Semestral

yearly

Anual

quantity

int 11 dígitos

Quantidade de pagamentos total. Em caso de indeterminada irá retornar 0.

additionalInfo

text

Texto livre dedicado a informações adicionais internas.

PlanPrices

Array de preços por forma de pagamento.
Clique para ver os campos.

payment

string 30 caracteres

PaymentMethod.id
Id do pagamento

Valor

Explicação

creditcard

Cartão de Crédito

boleto

Boleto Bancário

value

int 11 dígitos

Preço em centavos.

error

Nó de erros, caso haja.
Clique para ver os campos.

message

string 255 caracteres

Mensagem que indica qual o erro.

details

Objeto com detalhes sobre o erro, mostrando qual o campo referente e qual o erro.
Clique para ver os campos.

Entity.field

array de string

Array cuja chave é Entidade.campo onde deu o erro e cada valor é uma descrição sobre o problema.

Código

Explicação

200

Sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.

404

Nenhum plano encontrado com os parâmetros utilizados.