Get a Hosted Refund

GET 
/hosted-refunds/:id

Get a Hosted Refund

Request

Path Parameters

id stringrequired

Responses

200

OK

Response Headers

• Acme-Mode

  string

  Has the value LIVE if the data exists in live production mode or the value TEST if the data exists in test sandbox mode.

application/json

Schema

Schema

id stringrequired
status stringrequired

Possible values: [PENDING, SUCCEEDED, FAILED]

Status of the refund

hostedPaymentId stringrequired
amount integerrequired
currency stringrequired

Possible values: [SGD]

Three-letter ISO 4217 currency code in full uppercase.

referenceId string

A string to reference (e.g. your refund ID, etc.) which can be used to reconcile the hosted refund with your own systems. This cannot exceed 255 characters.

createdAt stringrequired
updatedAt stringrequired

Example (from schema)

{
  "id": "string",
  "status": "PENDING",
  "hostedPaymentId": "string",
  "amount": 4242,
  "currency": "SGD",
  "referenceId": "REF-1234567",
  "createdAt": "2023-04-24T00:00:00.000000Z",
  "updatedAt": "2023-04-24T00:00:00.000000Z"
}

Loading...