Refund API

Refund API ใช้เพื่อสร้างหรือเรียกข้อมูลรายการคืนเงิน โดยการทำการคืนเงินนั้นมีความเกี่ยวเนื่องกับรายการรับชำระเงิน ซึ่งจะสามารถทำได้เฉพาะรายการที่ตรงตามข้อกำหนดเท่านั้น

Attributes

Name Type Description
object string

The string refund.

id string

The refund identifier matching /rfnd(_test)?_[0-9a-z]+/.

livemode boolean

Whether this is a live (true) or test (false) refund.

location string

API path to retrieve the current refund object.

acquirer_reference_number string

Reference number for the refund initiated by the merchant. This information is sent as part of the settlement report to Visa and Master Card.

amount integer

Refund amount in smallest unit of charge currency.

charge object_id_expandable

Charge identifier associated with this refund.

created_at string

UTC datetime of refund creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

currency string

Currency for refund as three-letter ISO 4217 code.

funding_amount integer

For refunds of multi-currency charges, amount after exchange into account funding currency (funding_currency) specified in the smallest unit of funding_currency.

For refunds of non-multi-currency charges, amount specified in the smallest unit of currency.

funding_currency string

Currency for account as three-letter ISO 4217 code. This is the settlement currency for all charges.

merchant_name string

The name of the sub-merchant who initiated the refund.

Note: This field is applicable only if the merchant uses the Payfac solution. To enroll in Payfac, contact Opn Support.

merchant_uid string

The ID of the sub-merchant who initiated the refund.

Note: This field is applicable only if the merchant uses the Payfac solution. To enroll in Payfac, contact Opn Support.

metadata object

Custom metadata (e.g. {"answer": 42}) for refund.

status string

Status of the refund.

terminal string

Original charge point of sale within a branch.

transaction object_id_expandable

Transaction identifier associated with this refund.

voided boolean

Whether refunded charge was voided instead. Charges are voided if refund is processed before settlement time.

Example

  • JSON Response

Create a refund

- POST https://api.omise.co/charges/{id}/refunds

Creates and returns a new refund on charge matching :id.

Request Parameters

Name Type Description
amount integer

(required) Refund amount in smallest unit of charge currency.

metadata object

(optional) Custom metadata (e.g. {"answer": 42}) for refund.

void boolean

(optional, one of: true, false) Whether to only process refund as a void, if possible.

By default, if refund is requested before charge settlement, it is processed as a void, otherwise it is processed as a normal refund.

Example

  • Create a refund

  • Create a refund while adding metadata

List refunds for charge

- GET https://api.omise.co/charges/{id}/refunds

Returns a list of refunds belonging to charge matching :id.

Request Parameters

Name Type Description
from string

(optional, default: 1970-01-01T00:00:00Z) Earliest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

limit integer

(optional, default: 20) Number of records returned.

offset integer

(optional, default: 0) Offset of the first record returned (i.e. how many records to skip from the beginning).

order string

(optional, default: chronological, one of: chronological, reverse_chronological) Order of records returned.

to string

(optional) Latest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

Example

  • List all refunds for a charge

List refunds

- GET https://api.omise.co/refunds

Returns a list of refunds belonging to your account.

Request Parameters

Name Type Description
from string

(optional, default: 1970-01-01T00:00:00Z) Earliest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

limit integer

(optional, default: 20) Number of records returned.

offset integer

(optional, default: 0) Offset of the first record returned (i.e. how many records to skip from the beginning).

order string

(optional, default: chronological, one of: chronological, reverse_chronological) Order of records returned.

to string

(optional) Latest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

Example

  • List all refunds

Retrieve a refund

- GET https://api.omise.co/charges/{id}/refunds/{refund_id}

Returns the refund matching :refund_id belonging to charge matching :id.

Example

  • Retrieve a refund

เว็ปไซต์นี้มีการใช้คุกกี้เพื่อวิเคราะห์การใช้และปรับการใช้งานให้เหมาะกับท่าน เมื่อกดยอมรับหรือยังคงเข้าชมเว็บไซต์ต่อ เราถือว่าท่านยินยอมในการใช้งานคุกกี้ของเว็บไซต์ อ่านนโยบายความเป็นส่วนตัว