Adicionar uma transação

POST /transactions/{subscriptionId}/{typeId}/add

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

Método utilizado para acrescentar uma transação manualmente dentro de uma assinatura/contrato dentro do sistema.

Dados da requisição

Nome

Tipo

Obrigatório

Explicação

myId

string 255 caracteres

Sim

Id referente no seu sistema, para salvar no cel_cash.

value

int 11 dígitos

Sim

Valor a ser cobrado.
Caso não for passado, será considerado a da assinatura.

payday

date

Sim

Data de vencimento do pagamento
Caso não for passado, será calculada automaticamente pela data da último pagamento e periodicidade da assinatura.
Se for a primeira transação da assinatura, irá pegar o valor definido em Subscription.firstPayDayDate.

payedOutsideGalaxPay

bool

Não

Define se a transação foi paga fora do sistema do cel_cash. Exemplo: dinheiro, transferência. Usar esse campo para que o cel_cash não cobre esse pagamento do seu cliente, já que este já foi pago de outra forma.

additionalInfo

text

Não

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

PaymentMethodCreditCard

Sim para pagamento com cartão de crédito

Configurações do meio de pagamento de cartão.
Será considerado apenas quando mainPaymentMethodId for creditcard.
Clique para ver os campos.

Card

Não

Cartão.
Caso queira gerar um link para pagamento, não informe o nó Card.
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.

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.

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/transactions/ / /

add

URL da Requisição

https://api.sandbox.cel.cash/v2/transactions/1/myId/add

Body da requisição

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "type": true,
    "Transaction": {
        "myId": "pay-664ac245760485.64691915",
        "galaxPayId": 1,
        "subscriptionMyId": "2A",
        "subscriptionGalaxPayId": 1,
        "value": 12999,
        "payday": "2024-05-20",
        "payedOutsideGalaxPay": false,
        "additionalInfo": "Lorem ipsum dolor sit amet.",
        "status": "captured",
        "statusDescription": "Capturada na Operadora",
        "tid": "pay-664ac24580f7e8.68585315",
        "authorizationCode": "pay-664ac245820708.08219892",
        "reasonDenied": "Limite do cartão insuficiente.",
        "Boleto": {
            "pdf": "https://app.celcoin.com.br/link-pdf",
            "bankLine": "23312323232323232323232323232",
            "bankAgency": "0001",
            "bankAccount": "12345"
        },
        "AbecsReasonDenied": {
            "code": "51",
            "message": "Saldo/limite insuficiente"
        },
        "Pix": {
            "qrCode": "ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123",
            "reference": "E20240520002349C55175D444C9FDAC93EB7D0EBB8AB736",
            "image": "https://app.celcoin.com.br/link-image-qrcode",
            "page": "https://app.celcoin.com.br/link-page-qrcode"
        },
        "CreditCard": {
            "Card": {
                "myId": "pay-664ac24590f910.40228493",
                "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,pagseguro"
                },
                "expiresAt": "2024-05"
            }
        }
    }
}

Nome

Tipo

Explicação

type

bool

Sucesso ou não da ação.

Transaction

Informação da transação.
Clique para ver os campos.

myId

string 255 caracteres

Id referente no seu sistema.

galaxPayId

int 11 dígitos

Id no cel_cash

subscriptionMyId

string 255 caracteres

Subscription.myId.
Id da assinatura referente no seu sistema.

subscriptionGalaxPayId

int 11 dígitos

Subscription.galaxPayId.
Id da assinatura no cel_cash.

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.

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

statusDescription

string 255 caracteres

Mais informações sobre o status da transação.

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).

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

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

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

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

Transação adicionada com sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.

404

Assinatura não encontrada.