Skip to main content

15. Refund transaction​

Header Parameters
    Nonce string required

    random 16 bytes alphanumerics

    Credential string required

    Please follow the OpenAPI authentication section

    Example: d900da8b-6e16-4a85-8a66-05d29ac53f24/20240501120123/Wonder-RSA-SHA256
    Signature string required

    Please follow the OpenAPI authentication section

    Example: lM42cgyuLS98Dieydc8K2OD3KwYkOXibpV9pFvr/R0i/830M/FPKUKbav2UBBN3M3EdPk/PpvKQlvBNT+NbEg20CKuiDTZWDc3r7KiA1pdZsui/57XCVhC2s01W8jEM+G5lS362+p8+E0K6UKQDrJMyVpbDT31XSkSJIxae+uDi2nJr4DnIkemeU2LlNDRPPGe9NeX7z3B3N3LwIiQgKMyauPqAjro0UrZykQM9pv4UySRSU2cT8EcjQmyKxbzyuR2A47PyeodJvotlIthdfCHIxG52D06tpRJlRVbUdvxSg14bFiPbr3FwCvruZlbR15gOanJCqE4wp4fC8qEXXsg==
    Content-type string required
    Example: application/json
    x-request-id string
    Example: d900da8b-6e16-4a85-8a66-05d29ac53f24
    x-i18n-lang string

    from zh-HK, zh-CN, or en

Request Body
    order object required
    number Wonder order number
    reference_number Your order number
    transaction object required
    uuid string required
    refund object required
    amount string required
    note string required
Responses
Response Headers
    Schema
      error_code string required
      error_message string required
      data object required
      order object required
      source Transaction source required

      Transaction source

      type Order type required

      Order type

      number Wonder unique id required

      Wonder unique id

      reference_number Your Side unique id required

      your side unique id

      due_date due date required

      due date

      initial_total Order total required

      Order total

      initial_tips Order tips required

      Order tips

      subtotal number required
      paid_total Order Paid total required

      sum of successful transaction amount

      unpaid_total Order unpaid total required

      initial_total - paid_total

      state Order state required

      Order state

      correspondence_state Order payment state required

      Order payment state

      currency Currency required
      return_url frontend return url

      for payment link, when payment finished redirect to this url

      notify_url Webhook url

      if you fill it, wonder will callback your this url after state changed

      line_items object[]
    • Array [
      • uuid string
      purchasable_type PurchasableType required

      Possible values: [RearTips, Charge]

      purchase_id integer
      price integer required
      quantity integer required
      total integer required
      label string
    • ]
      • transactions object[]
    • Array [
      • type Transaction Type required

      Possible values: [Sales, Authorization, Refund, Capture]

      uuid Wonder transaction uuid required

      Wonder transaction uuid

      currency transaction currency required

      transaction currency

      amount transaction amount required

      transaction amount

      success success required

      if transaction successful

      is_pending boolean required

      for async payment,if transaction still pending

      captured boolean required

      for card pure-auth,if transaction captured

      allow_void boolean required

      if transaction allowed to void

      allow_refund boolean required

      if transaction allowed to refund

      void_is_pending boolean required

      if void still pending

      payment_method string required

      which payment method

      note string required

      transaction remark

      payment_data object required

      related to payment method

      acquirer_name string required
      acquirer_type string required
      auth_code string required
      brn string required
      card_id string required
      card_number_len integer required
      card_read_mode string required
      credit_card_type string required
      first_6_digits string required
      last_4_digits string required
      merchant_id string required
      new_gateway_txn_id string required
      payment_method string required
      receipt_id string required
      rrn string required
      transaction_state string required
      original_transaction_uuid original transacation uuid

      original transacation uuid

    • ]
      • payment_method_option object
      online object

      from value: cup unionpay_wallet fps amex visa mastercard maestro jcb discover diners wechat alipay alipay_hk payme octopus

    POST /svc/payment/api/v1/openapi/orders/refund

    Request

    Nonce — header required
    Credential — header required
    Signature — header required
    Content-type — header required
    x-request-id — header
    x-i18n-lang — header
    Body
    {

      "order": {

        "number": "string",

        "reference_number": "string"

      },

      "transaction": {

        "uuid": "string"

      },

      "refund": {

        "amount": "string",

        "note": "string"

      }

    }
    curl / cURL
    curl -L -X POST 'https://developer.wonder.today/svc/payment/api/v1/openapi/orders/refund' \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    --data-raw '{
      "order": {
        "number": "string",
        "reference_number": "string"
      },
      "transaction": {
        "uuid": "string"
      },
      "refund": {
        "amount": "string",
        "note": "string"
      }
    }'