Search a refund transaction

Request

Header Params

Content-Type

string

required

Example:

application/x-www-form-urlencoded

Body Params application/x-www-form-urlencoded

merchant_id

string

required

Merchant Code or Merchant ID or Merchant Number

<= 7 characters

Example:

701001

account_id

string

required

Subaccount ID or Gateway Number

<= 10 characters

Example:

701001010

refund_orders

string

optional

Merchat Order Number Order number defined by merchant Up to 100 orders can be queried in a single request, divided by “,” A request must contain either {refund_orders} or {refund_references}

<= 1000 characters

Example:

1726891254563

refund_references

string

optional

Unique reference A unique number defined by our gateway system associated with each refund request A request must contain either {refund_orders} or {refund_references}

<= 1000 characters

merchant_refunds

string

optional

Merchant refund reference Refund reference defined by merchant.

<= 1000 characters

encryption_data

string

required

Digital signature information:
encryption_data=sha256(merchant_id + account_id + sign_key);

All encryption parameters need to remove spaces before encryption.

<= 64 characters

Example:

3fc421f36e1d23db6982aa58779506a3ff17c7dcfa86421719aa69e5e0575168

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://test-api.star-saas.com/v1/retrievalRefund' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'merchant_id=701001' \
--data-urlencode 'account_id=701001010' \
--data-urlencode 'refund_orders=1726891254563' \
--data-urlencode 'refund_references=' \
--data-urlencode 'merchant_refunds=' \
--data-urlencode 'encryption_data=3fc421f36e1d23db6982aa58779506a3ff17c7dcfa86421719aa69e5e0575168'

Responses

🟢200Success

application/json

Body

account_id

string

required

refund_orders

array [object {12}]

required

transaction_id

string

optional

order_no

string

optional

amount

string

optional

refund_status

string

optional

payment_status

string

optional

refund_amount

string

optional

refund_reference

string

optional

currency

string

optional

refund_reason

string

optional

refund_reference_id

string

optional

refund_date

string

optional

refund_processing_date

string

optional

encryption_data

string

required

return_status

string

required

return_message

string

required

merchant_id

string

required

Example

{
  "account_id": "701001010",
  "refund_orders": [
    {
      "transaction_id": "1379868670095785984",
      "order_no": "1726891254563",
      "amount": "10.36",
      "refund_status": "1",
      "payment_status": "4100",
      "refund_amount": "10.36",
      "refund_reference": "",
      "currency": "USD",
      "refund_reason": "test",
      "refund_reference_id": "1379868670095785984-01",
      "refund_date": "20241113063528",
      "refund_processing_date": ""
    }
  ],
  "encryption_data": "3fc421f36e1d23db6982aa58779506a3ff17c7dcfa86421719aa69e5e0575168",
  "return_status": "1",
  "return_message": "OK",
  "merchant_id": "701001"
}