Criar cobrança avulsa

Para criar uma cobrança única via cartão de crédito é necessário realizar uma chamada na api Criar Cobrança utilizando o método POST, onde precisa ser preenchido algumas informações relacionadas a cobrança que será realizada. Os dados necessários estão no quadro "Parâmetros do Body"

Modelo de requisição:

curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/charges' \
--header 'accept: application/json' \
--header 'Authorization: Bearer acess_token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "myId": "pay-67eec64d2d6f62.59466661",
    "value": 12999,
    "additionalInfo": "Lorem ipsum dolor sit amet.",
    "payday": "2025-04-03",
    "mainPaymentMethodId": "creditcard",
    "Customer": {
        
        "name": "Lorem ipsum dolor sit amet.",
        "document": "62846017352",
        "emails": [
            "[email protected]",
            "[email protected]"
        ],
        "phones": [
            3140201512,
            31983890110
        ],
        "Address": {
            "zipCode": "30411330",
            "street": "Rua platina",
            "number": "1330",
            "complement": "2º andar",
            "neighborhood": "Prado",
            "city": "Belo Horizonte",
            "state": "MG"
        }
    },
    "PaymentMethodCreditCard": {
       
        "Card": {
            "myId": "pay-67eec64d71cd63.91075655",
            "galaxPayId": 1,
            "number": "4111 1111 1111 1111",
            "holder": "JOAO J J DA SILVA",
            "expiresAt": "2025-04",
            "cvv": "363"
        },
        
        "qtdInstallments": 12
        
}
'

Parâmetros do Body:

Campo	Descrição	Tipo
myId	Identificador do Cliente	String (255)
value	Valor da cobrança em centavos	Int (11)
additionalInfo	Informações adicionais	text
payday	Data de Vencimento	String (date-time)
mainPaymentMethodId	Método de Pagamento	String (30)
customer.name	Nome do Cliente	String (255)
customer.document	CPF OU CNPJ do cliente. Apenas números	String (14)
customer.emails	Emails do cliente. Separe cada email por vírgula.	Array String (255)
customer.phones	Telefones do cliente. Separe cada telefone por vírgula.	Array Int (11)
customer.address.zipCode	CEP	String (255)
customer.address.street	Logradouro	String (255)
customer.address.number	Número	String (255)
customer.address.neighborhood	Bairro	String (255)
customer.address.city	Código de Município	String (255)
customer.address.state	Sigla de Estado	String (255)
customer.address.complement	Complemento	String (255)
PaymentMethodCreditCard.number	Número do cartão.	String (30)
PaymentMethodCreditCard.holder	Nome do portador. Não aceita caracteres especiais ou acentuação.	String (30)
PaymentMethodCreditCard.expiresAt	Mês e ano da expiração do cartão. String contendo ano e mês de expiração do cartão.	String (7)
PaymentMethodCreditCard.cvv	Código de segurança.	String (4)
PaymentMethodCreditCard.qtdInstallments	Quantidade de parcelas.	Int (11)

Modelo de retorno:

{
    "type": true,
    "Charge": {
        "galaxPayId": 1,
        "myId": "pay-67f9567aa9d8d9.87867238",
        "mainPaymentMethodId": "creditcard",
        "paymentLink": "https://app.celcoin.com.br/link-payment",
        "value": 12999,
        "additionalInfo": "Lorem ipsum dolor sit amet.",
        "status": "active",
        
        "Customer": {
            "galaxPayId": 1,
            "myId": "pay-67f9567abc9e85.72127015",
            "name": "Lorem ipsum dolor sit amet.",
            "document": "70427051223",
            "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,
                "value": 12999,
                "payday": "2025-04-11",
                "installment": 3,
                "statusDate": "2025-04-11 14:50:50",
                "status": "captured",
                "datetimeLastSentToOperator": "2025-04-11 14:50:50",
                "statusDescription": "Capturada na Operadora",
                "reasonDenied": "Limite do cartão insuficiente.",
                "authorizationCode": "pay-67f9567af20bd9.36701250",
                "tid": "pay-67f9567af35231.16239082",
                "AbecsReasonDenied": {
                    "code": "51",
                    "message": "Saldo/limite insuficiente"
                },
              "PaymentMethodCreditCard": {
                "qtdInstallments": 12,
                "CreditCard": {
                    "Card": {
                        "myId": "pay-67f9567b12e670.91943253",
                        "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": "bin,pagseguro"
                        },
                        "expiresAt": "2025-04"
                    }
                },
                
            }
        ],
        
        }
    }
}

Note que essa api é síncrona, sendo assim, a Celcoin irá retornar para você o resultado final da solicitação de cadastro da empresa.

Tabela descritiva dos campos retornados

Campo	Descrição	Tipo
type	Tipo do identificador. Valores possíveis para informar no campo: 1. true - Quando a cobrança for cancelada com sucesso 2. false-** Quando ocorrer erro ao solicitar o cancelamento da cobrança	bool
charge.galaxPayId	Identificador da transação na Celcoin	Int (11)
charge.myId	Identificador do Cliente	String (255)
charge.mainPaymentMethodId	Método de Pagamento. Valor possível: creditcard	Strint (30)
charge.paymentLink	Link para pagamento	Strint (255)
charge.value	Valor da cobrança em centavos	Int (11)
charge.additionalInfo	Informações adicionais	text
charge.status	Status da cobrança avulsa. Valores possíveis: active: Ativa canceled: Cancelada closed: Encerrada waitingPayment: Aguardando Pagamento inactive: Inativa	String (30)
customer.name	Nome do Cliente	String (255)
customer.document	CPF OU CNPJ do cliente. Apenas números	String (14)
customer.emails	Emails do cliente. Separe cada email por vírgula.	Array Int (255)
customer.phones	Telefones do cliente. Separe cada telefone por vírgula.	Array Int (11)
customer.address.zipCode	CEP	String (255)
customer.address.street	Logradouro	String (255)
customer.address.number	Número	String (255)
customer.address.neighborhood	Bairro	String (255)
customer.address.city	Código de Município	String (255)
customer.address.state	Sigla de Estado	String (255)
customer.address.complement	Complemento	String (255)
transactions.galaxPayId	Identificador da Transação	Int (11)
transactions.value	Valor da transação em centavos	Int (11)
transactions.payday	Data do vencimento	Date
transactions.installment	Parcelas	Int (1)
transactions.statusDate	Data do Status	dateTime
transactions.status	Status da Transação. Valores Possíveis: 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	String (30)
transactions.datetimeLastSentToOperator	Data de último envio para a operadora	dateTime
transactions.statusDescription	Mais informações sobre o status da transação.	String (255)
transactions.reasonDenied	Motivo de negação da transação (Quando houver).	String (255)
transactions.authorizationCode	Código de autorização da transação na operadora.	String (255)
transactions.tid	TID: Identificador da transação na operadora.	String (255)
AbecsReasonDenied.code	Motivo de negação da transação (Quando houver): Código do motivo de negativa da ABECS	String (4)
AbecsReasonDenied.message	Motivo de negação da transação (Quando houver): Mensagem do motivo de negativa da ABECS	String (255)
PaymentMethodCreditCard.qtdInstallments	Quantidade de parcelas.	(String 11)
PaymentMethodCreditCard.card.number	Número truncado do cartão.	String (30)
PaymentMethodCreditCard.card.createdAt	Data de criação.	dateTime
PaymentMethodCreditCard.card.updatedAt	Data de alteração.	dateTime
PaymentMethodCreditCard.card.brand.id	Id da bandeira de cartão.	String (255)
PaymentMethodCreditCard.card.brand.name	Nome da bandeira.	String (255)
PaymentMethodCreditCard.card.brand.maxInstallment	Máximo de vezes que pode ser parcelado.	int (11)
PaymentMethodCreditCard.card.brand.operatorIds	Operadoras que aceitam a bandeira, separados por vírgula. CardOperator.id	text
PaymentMethodCreditCard.card.expiresAt	Mês e ano da expiração do cartão. String contendo ano e mês de expiração do cartão. YYYY-MM	String (7)

Updated about 2 hours ago