Capturar cobrança no cartão

PUT /charges/{chargeId}/{typeId}/capture

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

Método utilizado para realizar a captura de uma cobrança avulsa autorizada.

Parâmetros da URL:

{chargeId}: Id da cobrança avulsa.
{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/charges/ / /

capture

URL da Requisição

https://api.sandbox.cel.cash/v2/charges/1/myId/capture

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "Charge": {
        "myId": "pay-69b38c2b3da9e1.66810205",
        "galaxPayId": 1,
        "planMyId": "pay-69b38c2b638b74.54384858",
        "planGalaxPayId": 1,
        "mainPaymentMethodId": "creditcard",
        "value": 12999,
        "additionalInfo": "Lorem ipsum dolor sit amet.",
        "payedOutsideGalaxPay": false,
        "status": "active",
        "Customer": {
            "galaxPayId": 1,
            "myId": "pay-69b38c2bb16b35.74219344",
            "name": "Lorem ipsum dolor sit amet.",
            "document": "74537006633",
            "emails": [
                "teste5015email9369@galaxpay.com.br",
                "teste9079email9309@galaxpay.com.br"
            ],
            "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-69b38c2c67a9d7.26869496",
                "value": 12999,
                "payday": "2026-03-13",
                "additionalInfo": "Lorem ipsum dolor sit amet.",
                "installment": 3,
                "status": "captured"
            }
        ],
        "PaymentMethodCreditCard": {
            "qtdInstallments": 12,
            "Card": {
                "myId": "pay-69b38c2caefc78.89992864",
                "galaxPayId": 1,
                "number": "5451*********1515",
                "Brand": {
                    "id": "mastercard",
                    "name": "MasterCard",
                    "maxInstallment": 12,
                    "operatorIds": "pagseguro,bin"
                }
            },
            "Link": {
                "minInstallment": 4,
                "maxInstallment": 12
            }
        }
    }
}

Nome

Tipo

Explicação

Charge

Cobrança avulsa.
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

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.

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.

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

value

int 11 dígitos

Preço em centavos.

additionalInfo

text

Texto livre dedicado a informações adicionais internas.

payedOutsideGalaxPay

bool

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

status

string 30 caracteres

Status da cobrança avulsa.

Valor

Explicação

active

Ativa

canceled

Cancelada

closed

Encerrada

waitingPayment

Aguardando pagamento

inactive

Inativa

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 cobrança avulsa.
Ou seja, cada parcela da cobrança.
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.

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.

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

PaymentMethodCreditCard

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

qtdInstallments

int 11 dígitos

Quantidade de parcelas.

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.

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

Link

Informações do link de pagamento.
Clique para ver os campos.

minInstallment

int 11 dígitos

Mínimo de vezes que pode ser parcelado.

maxInstallment

int 11 dígitos

Máximo de vezes que pode ser parcelado.

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

Cobrança avulsa não encontrado.