Skip to main content

List Refunds

GET 
/refunds

Retrieve refunds that you have created.

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​

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.

Schema

    data

    object[]

    required

  • Array [

    • id stringrequired

    Unique identifier for the object.

    transactionId stringrequired

    ID of transaction to refund.

    amount integerrequired

    A positive integer value in specified currency's smallest unit. e.g. for SGD, $10 would be represented as 1000 (cents).

    currency stringrequired

    Possible values: [SGD]

    Three-letter ISO 4217 currency code in full uppercase.

    status stringrequired

    Possible values: [PENDING, SUCCEEDED, FAILED]

    Status of the refund

    resultCode string

    Possible values: [TRANSACTION_NO_LONGER_REFUNDABLE, OTHERS]

    Additional information when status is FAILED, if available.

    createdAt stringrequired

    Time at which the object was created. In ISO 8601 format.

    updatedAt stringrequired

    Time at which the object was last updated. In ISO 8601 format.

  • ]

    • hasMore booleanrequired
Loading...