List Hosted Refunds

GET 
/hosted-refunds

Request

Query Parameters

after string

An object ID that is used as a cursor in pagination. For instance, if you make a list request and receive 100 objects, ending with obj_foo42, your subsequent call can include after=obj_foo42 in order to fetch the next page of the list.

limit integer

Possible values: >= 1 and <= 100

Default value: 10

A limit on the number of objects to be returned, between 1 and 100.

order string

Possible values: [ASC, DESC]

Default value: DESC

Sort list objects in either ascending or descending order.

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

data

object[]

required

Array [

id stringrequired

status stringrequired

Possible values: [PENDING, SUCCEEDED, FAILED]

Status of the refund

hostedPaymentId stringrequired

amount integerrequired

currency stringrequired

Possible values: [SGD]

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

]

hasMore booleanrequired

Example (from schema)

{
  "data": [
    {
      "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"
    }
  ],
  "hasMore": true
}

Loading...