Buscar Cobrança

Uma vez que as cobranças tenham sido geradas, é possível consultá-las via API.

Ao obter os detalhes de uma cobrança, será possível obter não apenas informações sobre o status atual, método de pagamento utilizado pelo pagador para realizar o pagamento (caso tenha sido pago), mas também os detalhes das condições definidas pelo cobrador e que estavam disponíveis para o pagador, independente do seu uso.

Mesmo que uma cobrança tenha sido paga ou expirada, o link de cobrança gerado continua disponível e podendo ser acessado, tendo seu comportamento alterado dependendo do status.

Para buscar uma cobrança, é necessário ter um token válido e utilizar o endpoint.

Modelo de Requisição:

Request

curl --location 'https://sandbox.openfinance.celcoin.dev//baas/v1/payment-links/orders/status?orderId=6a173a993895abb40ce87724' \
--header 'Authorization: Bearer *****’

}

Query params:

Campo	Descrição	Tipo	Obrigatório
orderId	ID da cobrança. Ao menos um entre orderId e clientRequestId deve ser informado.	string	Condicional
clientRequestId	ID de referência do cliente. Ao menos um entre orderId e clientRequestId deve ser informado.	string	Condicional
account	ID da conta bancária vinculada à cobrança, só precisa ser preenchido se clientRequestId for informado	string	Condicional

Response

{
    "version": "1.0.0",
    "body":  {
        "id": "6a173a993895abb40ce87724",
        "clientRequestId": "ref-4975801-124",
        "account": "4975801",
        "amount": 5,
        "type": "SINGLE_PAYMENT",
        "status": "REGISTERED",
        "recurrency": "ONE_SHOT",
        "recurrencyInstruction": {
            "quantity": 0,
            "expirationDate": "2026-05-28"
        },
        "paymentMethods": {
            "pix": {
                "allowed": true,
                "pixKey": "15663289003"
            },
            "creditCard": {
                "allowed": true,
                "installments": 1
            },
            "openFinance": {
                "allowed": true
            }
        },
        "receiver": {
            "name": "Nome Sobrenome",
            "document": "12345678910",
            "socialName": "Nome",
            "accountType": "TRAN",
            "bank": {
                "account": "4975801",
                "branch": "0001",
                "ispb": "13935893"
            },
            "address": {
                "postalCode": "12211400",
                "street": "Av Paulista",
                "number": "313",
                "city": "São Paulo",
                "state": "SP"
            }
        },
        "description": {
            "title": "Mensalidade PayTrainer",
            "lines": [
                "Serviço com assinatura mensal",
                "Apenas pagamento de cartão"
            ]
        },
        "redirectAfterPaymentUrl": "https://www.celcoin.com.br",
        "paymentUrl": "https://payment-links/orders/6a173a993895abb40ce87724?token=bca017ae-ab53-4266-87ac-5b4e02daa52c",
        "createdAt": "2026-05-27T18:40:25.381Z",
        "updatedAt": "2026-05-27T18:40:25.381Z"
    },	
     "status": 200
}

Campos da resposta

Objeto	Campo	Descrição	Tipo
—	version	Versão do response	string
—	body	Dados da cobrança retornada	Order
—	status	Código de status da resposta	number
body	id	Identificador único da cobrança	string
body	clientRequestId	ID externo de referência da cobrança	string
body	account	ID da conta vinculada à cobrança	string
body	amount	Valor da cobrança em reais	number
body	type	Tipo da cobrança	OrderType (enum)
body	status	Status atual da cobrança	OrderStatus (enum)
body	recurrency	Recorrência da cobrança	OrderRecurrency (enum)
body	recurrencyInstruction	Instruções de recorrência da cobrança	OrderRecurrencyInstructionDto
body	paymentMethods	Métodos de pagamento disponíveis	OrderPaymentMethodsDto
body	receiver	Dados do recebedor	OrderReceiverDto
body	description	Descrição da cobrança	OrderDescriptionDto
body	redirectAfterPaymentUrl	URL de redirecionamento após o pagamento	string
body	paymentUrl	URL da página de pagamento	string
body	createdAt	Data de criação do registro	string (date-time)
body	updatedAt	Data da última atualização	string (date-time)
body.recurrencyInstruction	quantity	Quantidade de recorrência da cobrança	number
body.recurrencyInstruction	expirationDate	Data de expiração da cobrança	string (date)
body.paymentMethods	pix	Configuração de pagamento via Pix	OrderPixDto
body.paymentMethods	creditCard	Configuração de pagamento via cartão de crédito	OrderCreditCardDto
body.paymentMethods	openFinance	Configuração de pagamento via Open Finance	OrderPixOpenFinanceDto
body.paymentMethods.pix	allowed	Indica se o pagamento via Pix está habilitado	boolean
body.paymentMethods.pix	pixKey	Chave Pix utilizada para pagamento	string
body.paymentMethods.creditCard	allowed	Indica se o pagamento via cartão está habilitado	boolean
body.paymentMethods.creditCard	installments	Número máximo de parcelas	number
body.paymentMethods.openFinance	allowed	Indica se o pagamento via Open Finance está habilitado	boolean
body.receiver	name	Nome do recebedor	string
body.receiver	document	Documento do recebedor	string
body.receiver	socialName	Nome social/fantasia do recebedor	string
body.receiver	accountType	Tipo de conta do recebedor	AccountType (enum)
body.receiver	bank	Dados bancários do recebedor	PartyBankDto
body.receiver	address	Endereço do recebedor	PartyAddressDto
body.receiver.bank	account	Número da conta bancária	string
body.receiver.bank	branch	Agência bancária	string
body.receiver.bank	ispb	Código ISPB do banco	string
body.receiver.address	postalCode	Código postal (CEP)	string
body.receiver.address	street	Rua	string
body.receiver.address	number	Número do endereço	string
body.receiver.address	city	Cidade	string
body.receiver.address	state	Estado	string
body.description	title	Título da cobrança	string
body.description	lines	Linhas descritivas da cobrança	string

Updated about 4 hours ago