CommonApiVersion 1.0.0
Apply for Refund
https://pay.globepay.co/api/v1.0/gateway/partners/{partner_code}/orders/{order_id}/refunds/{refund_id}One payment order can create more than one refund orders. Total amount of all refund orders must be less than or equal to the actual paid amount and the currency of refund order is the same as the payment order.
Header
| Field | Description |
|---|---|
Accept | application/json |
Content-Type | application/json |
Path Variable
| Field | Type | Description |
|---|---|---|
partner_code | String | Required, Partner code |
order_id | String | Required, Partner payment order id |
refund_id | String | Required, Partner refund order id |
JSON keys
| Field | Type | Description |
|---|---|---|
fee | int | Required, Refund amount. Use base unit of the currency. Total amount of all refund orders must be less than actual paid amount. |
Query Params
| Field | Type | Description |
|---|---|---|
time | Long | Required, UTC timestamp in milliseconds |
nonce_str | String | Required, Random string |
sign | String | Required, Sign |
Success 200
| Field | Type | Description |
|---|---|---|
return_code | String | Execution result |
result_code | String |
|
refund_id | String | GlobePay Refund id |
partner_refund_id | String | Partner refund id |
amount | int | Refund amount |
currency | String | Refund currency |
Error Code
| Name | Description |
|---|---|
ORDER_NOT_EXIST | Payment order does not exist |
ORDER_MISMATCH | Payment order is not belong to this partner |
ORDER_NOT_PAID | Payment order is not paid |
SYSTEMERROR | Exception inside system |
INVALID_SHORT_ID | Partner code is invalid or there is no partner associated with this code |
SIGN_TIMEOUT | Sign expired, the difference between time and the server time is more than 5 minutes |
INVALID_SIGN | Invalid sign |
PARAM_INVALID | Parameters are invalid. See return_msg for more details. |
NOT_PERMITTED | Gateway payment permission has not been enabled for this partner |
INVALID_CHANNEL | Channel name is not available, check the Capitalize |
ERROR
| Name | Description |
|---|---|
return_code | Error Code |
return_msg | Error Description |