Skip to main content

Create a Refund

POST 
/refunds

Create a refund for a payment.

This is an asynchronous operation. The status of the Refund object in a successful response will be PENDING. Listen to the refunds.succeeded or refunds.failed webhook to be notified of the final outcome of the refund.

Request​

Header Parameters

    Idempotency-Key string

    A unique value, eg. a UUID.

Body

    transactionId stringrequired

    ID of transaction to refund.

    Use these transaction IDs in test mode to simulate various outcomes:

    • txn_SuccessfulRefund: Create a successful refund. The status will change from PENDING to SUCCEEDED after a short while.
    • txn_FailedRefund: Create a failed refund. The status will change from PENDING to FAILED after a short while.
    • txn_InvalidTransaction: Simulate attempting to refund a transaction that cannot be refunded.
    • txn_AlreadyRefunded: Simulate attempting to refund a transaction that has already been refunded.
    • txn_RejectOverRefund: Simulate attempting to refund an amount that is greater than the transaction's refundable amount.
    • txn_NoLongerRefundable: Simulate attempting to refund a transaction that is no longer refundable (e.g. exceeded refund window).
    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.

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

    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.

Loading...