API referenceRefunds

Get a refund

GET
/api/b/v1/refunds/{refund_id}

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Path Parameters

refund_id*Refund Id
Formatuuid
admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/refunds/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "charge_id": "cf8b747b-a752-4d0a-9a4d-7d19fc1769f3",  "amount_minor": 0,  "currency": "string",  "status": "string",  "method": "string",  "rail": "string",  "provider_reference": "string",  "reason": "string",  "failure_reason": "string",  "created_at": "2019-08-24T14:15:22Z",  "completed_at": "2019-08-24T14:15:22Z"}

Refund a charge POST

Give money back — AC 1 and AC 2. 409 rather than 400 for an over-refund: the request is well formed and would have been accepted against a different state of the charge.

Disputes against your charges GET

Every dispute raised against this business, newest first. Each row carries the disputed charge's amount and reference, so a list does not need a call per row to say what is at stake. `open_count` is computed over all of this business's disputes rather than the page: the page is filtered and paged, and a count taken from it would say "3 open" when it meant "3 open on this screen".