Skip to main content

​
Estrutura

Uma cobrança via QRCode Pix é representada em nossa API pela seguinte estrutura:
json
{
    "error": null,
    "status": 200,
    "data": {
        "id": "ch_83940c67-4ee2-4087-b484-4e0f101754e2",
        "externalID": "pedido-123",
        "brCode": "00020101021226810014br.gov.bcb.pix255..",
        "brCodeImageUrl": "https://api.aobapay.com/v1/qrcode/ch_abb6bc4f-f55d-45ff-8be2-8fdbde0cb8b8",
        "amount": 200,
        "comment": "Pagamento abc",
        "expiration": 300,
        "fee": 78,
        "expiresAt": "2025-09-22 14:46:20",
        "status": "PENDING",
        "customer": {
            "id": "cus_3d4c48ff-291c-4266-a1ee-ba523479d886",
            "name": "Brendo",
            "document": "123.456.789-01",
            "email": "[email protected]",
            "phone": "15997886622"
        },
        "createdAt": "2025-09-22 14:41:20",
        "updatedAt": "2025-09-22 14:41:20"
    }
}

​
Atributos:

json
{
    "id": "ch_83940c67-4ee2-4087-b484-4e0f101754e2"
}
id : string.
Identificador único da cobrança.
json
{
    "externalID": "seu id interno" // OU NULL
}
id : string.
Identificador único da cobrança.
json
{
    "amount": 200
}
amount : number.
Valor da cobrança em centavos (ex: 200 = R$ 2,00)
json
{
    "status": "PAID"
}
status : string.
Status da cobrança. Pode ser PENDING, EXPIRED, FAILED, PAID, REFUNDED.
StatusDescrição
PENDINGA cobrança está com o pagamento pendente
EXPIREDO tempo limite de pagamento foi excedido
FAILEDA cobrança teve falha
PAIDA cobrança foi paga com sucesso pelo cliente
REFUNDEDO valor foi devolvido ao cliente
json
{
    "brCode": "..."
}
brCode : string.
Código PIX (copia-e-cola) para pagamento.
json
{
    "brCodeImageUrl": "https://api.aobapay.com/v1/qrcode/ch_abb6bc4f-f55d-45ff-8be2-8fdbde0cb8b8"
}
brCodeBase64 : string.
Código PIX no formato Base64 (útil para exibição em imagens).
json
{
    "fee": 78
}
platformFee : number.
Taxa da plataforma em centavos. Exemplo: 80 significa R$ 0,80.
json
{
    "comment": "Pagamento ABC"
}
description : string.
Comentario da cobrança.
json
{
    "createdAt": "2025-09-22 14:41:20"
}
createdAt : date-time.
Data e hora da criação da cobrança.
json
{
    "updatedAt": "2025-09-22 14:41:20"
}
updatedAt : date-time.
Última atualização da cobrança.
json
{
    "expiresAt": "2025-09-22 14:46:20"
}
expiresAt : date-time.
Data e hora de expiração do QRCode.