Skip to content

Refunds

Retrieve a refund

Returns a refund of your store.

GET/v1/refunds/{refund_id}

Requires the payments:read scope.

A refund of another store, or of the other environment, answers 404.

curl https://api.rais.app/v1/refunds/0c8a1d52-6e7b-4f0a-9b3d-7d2e4a8c5f10 \
  -H "Authorization: Bearer rais_sk_test_..."
Response200
{
  "id": "0c8a1d52-6e7b-4f0a-9b3d-7d2e4a8c5f10",
  "object": "refund",
  "payment_id": "5b1c2f4e-9d3a-4c61-8a7e-0f2d6b9e1a33",
  "amount": 150000,
  "currency": "DZD",
  "status": "succeeded",
  "reason": "Customer returned one item",
  "failure": null,
  "fees": {
    "satim": 800,
    "rais": 200,
    "total": 1000
  },
  "livemode": false,
  "created": 1793000900
}

Request

Path parameters

refund_idstringrequired

The id of the refund.

Response

200The refund.

Returns the Refund object.

Errors

StatusCodeExample message
401invalid_api_keyInvalid API key provided.
403insufficient_scopeThis API key does not have the 'payments:write' permission.
403account_disabledThis store is suspended or disabled.
403live_mode_not_enabledComplete business verification to take live payments.
404refund_not_foundNo such refund.
429rate_limit_exceededToo many requests. Slow down and retry after the delay in the Retry-After header.
500internal_errorSomething went wrong on our side. Quote the request id to support.

Every error has the same envelope. See Errors.