Retrieve a refund by its refund ID. Only refunds of collections that you created through the API are returned. Required scope: refund:read.

GETapi-prod.blaaiz.com/api/external/refund/{id}

Authorization

oauth2ClientCredentials refund:read
AuthorizationBearer <token>

Use your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.

In: header

Scope: refund:read

Path Parameters

id*string

The refund ID.

Response Body

application/json

application/json

application/json

application/json

Get a refund
curl --request GET \  --url 'https://example.com/api/external/refund/string'
{  "message": "Refund retrieved successfully.",  "data": {    "id": "a1f7c9e2-4b3d-4c8a-9f2e-7d6b5a4c3e21",    "status": "SUCCESSFUL",    "type": "FULL",    "amount": 500,    "currency": "GBP",    "transaction_id": "9d4c4ec5-59ea-4130-bf8a-6a5edec401ee",    "reference": "refund-order-8842",    "business_customer_id": "6c258e65-de94-4d9d-87fb-117480a9d0e7",    "refund_reference": "cj-refund-3f9a12",    "failure_reason": null,    "created_at": "2026-08-03T10:15:00.000000Z",    "updated_at": "2026-08-03T10:22:40.000000Z"  }}