Obtain a Refund Summary

Designing

GET

https://api.cobre.co/v1/v1/refund/summary/{id}

Retrieves the refund summary for an original payin by its rf_ ID — the running total of all refund attempts against that payin (original amount, amount already refunded, amount reserved by in-flight attempts, and amount still refundable), along with the list of individual attempts.

This is distinct from a single refund attempt (refund_entry, rfe_ prefix, Obtain one Refund): the summary is the per-payin accumulator, while an attempt is one refund request against that payin. If a payin has multiple refund attempts, this endpoint returns the aggregate view; retrieve an individual attempt by its own rfe_ ID.

Refunds is still under active development — some of the functionality described in this guide may not yet be available for your account. Contact your KAM (Key Account Manager) for the current rollout status.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200OK

application/json

The requested refund summary.

Bodyapplication/json

🟠404Not Found

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.cobre.co/v1/v1/refund/summary/rf_xOBCRu3PPAby6E' \
--header 'Authorization: Bearer <token>'

Response Example

200 - OK

{
    "id": "rf_xOBCRu3PPAby6E",
    "object": "refund_summary",
    "livemode": true,
    "request_id": "req_asdasdfa123",
    "original_payin_id": "mm_xOBCRu3PPAby6E",
    "currency": "COP",
    "original_amount": 300,
    "refunded_amount": 200,
    "reserved_amount": 0,
    "refundable_amount": 100,
    "status": "partially_refunded",
    "refunds": [
        { "id": "rfe_nQ8vLm2KxP4wYz", "amount": 100, "status": "completed", "created_at": "2026-08-05T14:02:11Z" },
        { "id": "rfe_nQ8vLm2KxP1234", "amount": 100, "status": "completed", "created_at": "2026-08-05T14:02:11Z" }
    ]
}

Modified at 2026-09-14 21:22:09

Obtain one Refund

Obtain all Refunds