Skip to main content

Create a Hosted Refund

POST 
/hosted-refunds

Request​

Header Parameters

    Idempotency-Key string

    A unique value, eg. a UUID.

Body

    amount integerrequired

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

    currency stringrequired

    Possible values: [SGD]

    Three-letter ISO 4217 currency code in full uppercase. Must be a supported currency.

    hostedPaymentId stringrequired
    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.

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

    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
Loading...