Editar pagamento da assinatura/contrato

PUT /subscriptions/{subscriptionId}/{typeId}

Para utilizar esse método, o access_token deve conter o scope subscriptions.write

Método utilizado para alterar o valor das próximas transações de uma assinatura/contrato dentro do sistema.

Dados da requisição

Você pode alterar todos os dados abaixo do registro ou apenas o campo que desejar.
Apenas os campos enviados serão validados.

Nome

Tipo

Obrigatório

Explicação

value

int 11 dígitos

Sim

Preço em centavos. Caso o método de pagamento seja boleto e o valor for alterado, os boletos registrados não serão alterados.

mainPaymentMethodId

string 30 caracteres

Sim

PaymentMethod.id
Id do pagamento principal. Ou seja, quando forem cadastradas novas transações, irá considerar esse pagamento.

Valor	Explicação
creditcard	Cartão de Crédito
boleto	Boleto Bancário
pix	Pix

PaymentMethodCreditCard

Sim para pagamento com cartão de crédito

Configurações do meio de pagamento de cartão.
Obrigatório se o mainPaymentMethodId for creditcard.
Caso queira utilizar o link para pagamento, não informe o nó Card
Clique para ver os campos.

Card

Não

Cartão.
Ao atualizar o cartão da assinatura, irá atualizar tanto as transações não pagas já geradas como o cartão padrão para próximas transações.
Clique para ver os campos.

myId

string 255 caracteres

Id referente no seu sistema, para salvar no cel_cash.
Para utilizar um existente preencha apenas este campo.

galaxPayId

int 255 dígitos

Id do cartão no cel_cash.
Para utilizar um existente preencha apenas este campo.

number

string 30 caracteres

Sim

Número do cartão.
Para APROVAR: 4111 1111 1111 1111
Para NEGAR: 4242 4242 4242 4242

holder

string 30 caracteres

Sim

Nome do portador. Não aceita caracteres especiais ou acentuação.

expiresAt

string 7 caracteres

Sim

Mês e ano da expiração do cartão.
String contendo ano e mês de expiração do cartão.
YYYY-MM

cvv

string 4 caracteres

Sim

Código de segurança.

useBackupCard

bool

Não

Informa se o cliente autorizou a utilização do cartão reserva, em caso de retentativa (disponível apenas para cobranças na subadquirente).

PaymentMethodBoleto

Não

Configurações do meio de pagamento de boleto.
Clique para ver os campos.

fine

int 11 dígitos

Não

Percentual de multa, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.

interest

int 11 dígitos

Não

Percentual de juros, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.

instructions

string 255 caracteres

Não

Instruções do boleto.
Irá ser acrescentado na área "Referente a" do boleto. Para quebrar linha utilize "\n", sendo que será exibido no máximo 3 linhas.
Caso não informado será utilizado o padrão definido no sistema.

deadlineDays

int 11 dígitos

Não

Quantidade de dias que o boleto pode ser pago após o vencimento.
Caso não informado será utilizado o padrão definido no sistema.
Valores válidos de 0 a 59.

documentNumber

string 10 caracteres

Não

Irá ser acrescentado na área "Nº Documento" do boleto. Caso não informado será utilizado o padrão definido no sistema.

Agreement

Não

Convênio próprio no banco emissor
Clique para ver os campos.

name

string 255 caracteres

Não

Nome do beneficiário final/sacador avalista

document

string 14 caracteres

Não

Documento do beneficiário final/sacador avalista

PaymentMethodPix

Não

Configurações do meio de pagamento de Pix.
Clique para ver os campos.

fine

int 11 dígitos

Não

Percentual de multa, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.

interest

int 11 dígitos

Não

Percentual de juros, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.

instructions

string 255 caracteres

Não

Instruções do QR Code Pix.
Informação exibida nos detalhes do QR Code.
Caso não informado será utilizado o padrão definido na plataforma.

Deadline

Não

Expiração do QR Code.
Caso não informado, será utilizado o padrão definido no sistema.
Clique para ver os campos.

type

string 255 caracteres

Não

Tipo da expiração do QR Code.

Valor	Explicação
days	Dias

value

int 11 dígitos

Não

Valor da expiração do QR Code (em dias ou minutos).

Parâmetros da URL:

{subscriptionId}: Id da assinatura.
{typeId}: Tipo do id. Opções:
- galaxPayId: Id no cel_cash
- myId: Id referente no seu sistema, para salvar no cel_cash.

URL da Requisição

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

URL da Requisição

https://api.sandbox.cel.cash/v2/subscriptions/1/myId

Body da requisição

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "type": true,
    "Subscription": {
        "galaxPayId": 1,
        "myId": "pay-6891b5edbf5445.85865950",
        "planMyId": "pay-6891b5edc9f282.59918938",
        "planGalaxPayId": 1,
        "value": 12999,
        "quantity": 12,
        "periodicity": "monthly",
        "firstPayDayDate": "2025-08-05",
        "mainPaymentMethodId": "creditcard",
        "paymentLink": "https://app.celcoin.com.br/link-payment",
        "additionalInfo": "Lorem ipsum dolor sit amet.",
        "Customer": {
            "galaxPayId": 1,
            "myId": "pay-6891b5ee3cbec9.53303924",
            "name": "Lorem ipsum dolor sit amet.",
            "document": "89100463922",
            "emails": [
                "[email protected]",
                "[email protected]"
            ],
            "phones": [
                3140201512,
                31983890110
            ],
            "createdAt": "2020-06-02 10:10:00",
            "updatedAt": "2020-06-02 10:10:00",
            "Address": {
                "zipCode": "30411330",
                "street": "Rua platina",
                "number": "1330",
                "complement": "2º andar",
                "neighborhood": "Prado",
                "city": "Belo Horizonte",
                "state": "MG"
            }
        },
        "Transactions": [
            {
                "galaxPayId": 1,
                "myId": "pay-6891b5eeef5bf1.67872247",
                "value": 12999,
                "payday": "2025-08-05",
                "payedOutsideGalaxPay": false,
                "additionalInfo": "Lorem ipsum dolor sit amet.",
                "installment": 3,
                "statusDate": "2025-08-05 04:42:39",
                "datetimeLastSentToOperator": "2025-08-05 04:42:39",
                "status": "captured",
                "fee": 300,
                "tid": "pay-6891b5ef675031.40362876",
                "authorizationCode": "pay-6891b5ef71df27.75375483",
                "reasonDenied": "Limite do cartão insuficiente.",
                "AbecsReasonDenied": {
                    "code": "51",
                    "message": "Saldo/limite insuficiente"
                },
                "Boleto": {
                    "pdf": "https://app.celcoin.com.br/link-pdf",
                    "bankLine": "23312323232323232323232323232",
                    "bankAgency": "0001",
                    "bankAccount": "12345"
                },
                "Pix": {
                    "qrCode": "ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123",
                    "reference": "E2025080504423933BF3F508E379BAEE35889868BA67E6F",
                    "image": "https://app.celcoin.com.br/link-image-qrcode",
                    "page": "https://app.celcoin.com.br/link-page-qrcode"
                },
                "CreditCard": {
                    "Card": {
                        "myId": "pay-6891b5eff36011.30717612",
                        "galaxPayId": 1,
                        "number": "5451*********1515",
                        "createdAt": "2020-06-02 10:10:00",
                        "updatedAt": "2020-06-02 10:10:00",
                        "Brand": {
                            "id": "mastercard",
                            "name": "MasterCard",
                            "maxInstallment": 12,
                            "operatorIds": "cielo,bin"
                        },
                        "expiresAt": "2025-08"
                    }
                }
            }
        ],
        "PaymentMethodCreditCard": {
            "Card": {
                "myId": "pay-6891b5f0662657.92246360",
                "galaxPayId": 1,
                "number": "5451*********1515",
                "createdAt": "2020-06-02 10:10:00",
                "updatedAt": "2020-06-02 10:10:00",
                "Brand": {
                    "id": "mastercard",
                    "name": "MasterCard",
                    "maxInstallment": 12,
                    "operatorIds": "cielo,getnet"
                },
                "expiresAt": "2025-08",
                "isBackup": false
            }
        },
        "PaymentMethodBoleto": {
            "fine": 100,
            "interest": 200,
            "instructions": "Lorem ipsum dolor sit amet.",
            "deadlineDays": 1
        },
        "PaymentMethodPix": {
            "fine": 100,
            "interest": 200,
            "instructions": "Lorem ipsum dolor sit amet.",
            "Deadline": {
                "type": "days",
                "value": 60
            }
        }
    }
}

Nome

Tipo

Explicação

type

bool

Sucesso ou não da ação.

Subscription

Assinatura.
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id no cel_cash

myId

string 255 caracteres

Id referente no seu sistema.

planMyId

string 255 caracteres

Plan.myId
ID do plano no seu sistema.

planGalaxPayId

int 11 dígitos

Plan.galaxPayId
ID do plano no cel_cash.

value

int 11 dígitos

Preço em centavos.

quantity

int 11 dígitos

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

periodicity

string 255 caracteres

Periodicidade dos pagamentos.

Valor

Explicação

weekly

Semanal

biweekly

Quinzenal

monthly

Mensal

bimonthly

Bimestral

quarterly

Trimestral

biannual

Semestral

yearly

Anual

firstPayDayDate

date

Data do primeiro pagamento.

mainPaymentMethodId

string 30 caracteres

PaymentMethod.id
Id do pagamento principal. Ou seja, quando forem cadastradas novas transações, irá considerar esse pagamento.

Valor

Explicação

creditcard

Cartão de Crédito

boleto

Boleto Bancário

pix

Pix

paymentLink

string 255 caracteres

Link para pagamento.

additionalInfo

text

Texto livre dedicado a informações adicionais internas.

Customer

Informações do cliente.
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 ou razão social do cliente.

document

string 14 caracteres

CPF OU CNPJ do cliente. Apenas números.

emails

array de string 255 caracteres

Emails do cliente.

phones

array de int 11 dígitos

Telefones do cliente.

createdAt

datetime

Data de criação.

updatedAt

datetime

Data de alteração.

Address

Endereço de cobrança do cliente.
Clique para ver os campos.

zipCode

string 8 caracteres

CEP

street

string 255 caracteres

Logradouro.

number

string 255 caracteres

Número.

complement

string 255 caracteres

Complemento.

neighborhood

string 255 caracteres

Bairro.

city

string 255 caracteres

Cidade.

state

string 2 caracteres

Estado.

Transactions

Transações da assinatura.
Ou seja, cada pagamento da assinatura.
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id no cel_cash

myId

string 255 caracteres

Id referente no seu sistema.

value

int 11 dígitos

Preço em centavos.

payday

date

Data de vencimento do pagamento.

payedOutsideGalaxPay

bool

Define se a transação foi paga fora do sistema do cel_cash. Exemplo: dinheiro, transferência.

additionalInfo

text

Texto para informações adicionais sobre a transação. Essa informação é exibida no boleto ao cliente.

installment

int 11 dígitos

Parcela.

statusDate

datetime

Data do status

datetimeLastSentToOperator

datetime

Data de último envio para a operadora

status

string 30 caracteres

Status da transaçao.

Valor

Explicação

Opções válidas para cartão de crédito:

notSend

Ainda não enviada para operadora de Cartão

authorized

Autorizado

captured

Capturada na Operadora de Cartão

denied

Negada na Operadora de Cartão

reversed

Estornada na Operadora de Cartão

chargeback

Estorno por chargeback

Opções válidas para boleto Bancário:

pendingBoleto

Boleto em aberto

payedBoleto

Boleto compensado

notCompensated

Boleto baixado por decurso de prazo

lessValueBoleto

Pago valor menor que o original

moreValueBoleto

Pago valor maior que o original

paidDuplicityBoleto

Pago em duplicidade

Opções válidas para Pix:

pendingPix

Pix em aberto

payedPix

Pix pago

unavailablePix

Pix indisponível para pagamento

Opções válidas para qualquer forma de pagamento:

cancel

Cancelada manualmente

payExternal

Paga fora do sistema

cancelByContract

Cancelada ao cancelar a cobrança

free

Isento

fee

int 30 dígitos

Taxa paga. Valor em centavos, sendo as duas últimas casas decimais. (Para transações de Boleto ou Pix pagas)

tid

string 255 caracteres

TID: Identificador da transação na operadora.

authorizationCode

string 255 caracteres

Código de autorização da transação na operadora.

reasonDenied

string 255 caracteres

Motivo de negação da transação (Quando houver).

AbecsReasonDenied

Motivo de negação da transação (Quando houver).
Clique para ver os campos.

code

string 4 caracteres

Código do motivo de negativa da ABECS

message

string 255 caracteres

Mensagem do motivo de negativa da ABECS

Boleto

Dados do boleto atrelado.
Clique para ver os campos.

pdf

string 255 caracteres

URL do PDF

bankLine

string 255 caracteres

Linha digitável do boleto.

bankAgency

string 255 caracteres

Agência do banco emissor do boleto

bankAccount

string 255 caracteres

Conta do banco emissor do boleto

Pix

Dados do Pix atrelado.
Clique para ver os campos.

qrCode

string 255 caracteres

Conteúdo do QR Code.

reference

string 255 caracteres

Identificador do QR Code que será exibido no app do banco ao realizar o pagamento.

image

string 255 caracteres

Link da imagem do QR Code.

page

string 255 caracteres

Link da página do QR Code.

CreditCard

Dados do cartão de crédito da transação.
Clique para ver os campos.

Card

Cartão.
Clique para ver os campos.

myId

string 255 caracteres

Id referente no seu sistema, para salvar no cel_cash.

galaxPayId

int 11 dígitos

Id no cel_cash

number

string 30 caracteres

Número truncado do cartão.

createdAt

datetime

Data de criação.

updatedAt

datetime

Data de alteração.

Brand

Bandeira do cartão da transação.
Clique para ver os campos.

string 255 caracteres

Id da bandeira de cartão.

name

string 255 caracteres

Nome da bandeira.

maxInstallment

int 11 dígitos

Máximo de vezes que pode ser parcelado.

operatorIds

text

Operadoras que aceitam a bandeira, separados por vírgula.
CardOperator.id

expiresAt

string 7 caracteres

Mês e ano da expiração do cartão.
String contendo ano e mês de expiração do cartão.
YYYY-MM

PaymentMethodCreditCard

Configurações do meio de pagamento de cartão.
Clique para ver os campos.

Card

Cartão
Clique para ver os campos.

myId

string 255 caracteres

Id referente no seu sistema.

galaxPayId

int 11 dígitos

Id no cel_cash

number

string 30 caracteres

Número do cartão truncado.

createdAt

datetime

Data de criação.

updatedAt

datetime

Data de alteração.

Brand

Bandeira do cartão da transação.
Clique para ver os campos.

string 255 caracteres

Id da bandeira de cartão.

name

string 255 caracteres

Nome da bandeira.

maxInstallment

int 11 dígitos

Máximo de vezes que pode ser parcelado.

operatorIds

text

Operadoras que aceitam a bandeira, separados por vírgula.
CardOperator.id

expiresAt

string 7 caracteres

Mês e ano da expiração do cartão.
String contendo ano e mês de expiração do cartão.
YYYY-MM

isBackup

bool

Cartão reserva.

PaymentMethodBoleto

Configurações do meio de pagamento de boleto.
Clique para ver os campos.

fine

int 11 dígitos

Percentual de multa, com dois decimais sem o separador.

interest

int 11 dígitos

Percentual de juros, com dois decimais sem o separador.

instructions

string 255 caracteres

Instruções.

deadlineDays

int 11 dígitos

Quantidade de dias que o boleto pode ser pago após o vencimento.

PaymentMethodPix

Configurações do meio de pagamento de Pix.
Clique para ver os campos.

fine

int 11 dígitos

Percentual de multa, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.

interest

int 11 dígitos

Percentual de juros, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.

instructions

string 255 caracteres

Instruções do QR Code Pix.
Informação exibida nos detalhes do QR Code.
Caso não informado será utilizado o padrão definido na plataforma.

Deadline

Expiração do QR Code.
Caso não informado, será utilizado o padrão definido no sistema.
Clique para ver os campos.

type

string 255 caracteres

Tipo da expiração do QR Code.

Valor

Explicação

days

Dias

value

int 11 dígitos

Valor da expiração do QR Code (em dias ou minutos).

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

Assinatura alterada com sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.

404

Assinatura não encontrada.