Address Payment Direct Refund

Refund (Direct Payment)

curl --request POST \
  --url https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refund \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "refundRequestId": "483902480932841787",
  "prepayId": "1665553233227833",
  "refundAmount": "20",
  "receiverId": 598816
}
'

import requests

url = "https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refund"

payload = {
    "refundRequestId": "483902480932841787",
    "prepayId": "1665553233227833",
    "refundAmount": "20",
    "receiverId": 598816
}
headers = {
    "X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
    "X-GatePay-Signature": "<x-gatepay-signature>",
    "X-GatePay-Timestamp": "<x-gatepay-timestamp>",
    "X-GatePay-Nonce": "<x-gatepay-nonce>",
    "X-GatePay-On-Behalf-Of": "<x-gatepay-on-behalf-of>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
    'X-GatePay-Signature': '<x-gatepay-signature>',
    'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
    'X-GatePay-Nonce': '<x-gatepay-nonce>',
    'X-GatePay-On-Behalf-Of': '<x-gatepay-on-behalf-of>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    refundRequestId: '483902480932841787',
    prepayId: '1665553233227833',
    refundAmount: '20',
    receiverId: 598816
  })
};

fetch('https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refund', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refund",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'refundRequestId' => '483902480932841787',
    'prepayId' => '1665553233227833',
    'refundAmount' => '20',
    'receiverId' => 598816
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>",
    "X-GatePay-Signature: <x-gatepay-signature>",
    "X-GatePay-Timestamp: <x-gatepay-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refund")
  .header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
  .header("X-GatePay-Signature", "<x-gatepay-signature>")
  .header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
  .header("X-GatePay-Nonce", "<x-gatepay-nonce>")
  .header("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
  .header("Content-Type", "application/json")
  .body("{\n  \"refundRequestId\": \"483902480932841787\",\n  \"prepayId\": \"1665553233227833\",\n  \"refundAmount\": \"20\",\n  \"receiverId\": 598816\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refund"

	payload := strings.NewReader("{\n  \"refundRequestId\": \"483902480932841787\",\n  \"prepayId\": \"1665553233227833\",\n  \"refundAmount\": \"20\",\n  \"receiverId\": 598816\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
	req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
	req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
	req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
	req.Header.Add("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refund")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["X-GatePay-On-Behalf-Of"] = '<x-gatepay-on-behalf-of>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"refundRequestId\": \"483902480932841787\",\n  \"prepayId\": \"1665553233227833\",\n  \"refundAmount\": \"20\",\n  \"receiverId\": 598816\n}"

response = http.request(request)
puts response.read_body

{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "refundRequestId": "483902480932841787",
    "prepayId": "1665553233227833",
    "orderAmount": "14.9",
    "refundAmount": "4.9"
  }
}

POST

payment

open

institution

pay

address

refund

Refund (Direct Payment)

curl --request POST \
  --url https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refund \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "refundRequestId": "483902480932841787",
  "prepayId": "1665553233227833",
  "refundAmount": "20",
  "receiverId": 598816
}
'

import requests

url = "https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refund"

payload = {
    "refundRequestId": "483902480932841787",
    "prepayId": "1665553233227833",
    "refundAmount": "20",
    "receiverId": 598816
}
headers = {
    "X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
    "X-GatePay-Signature": "<x-gatepay-signature>",
    "X-GatePay-Timestamp": "<x-gatepay-timestamp>",
    "X-GatePay-Nonce": "<x-gatepay-nonce>",
    "X-GatePay-On-Behalf-Of": "<x-gatepay-on-behalf-of>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
    'X-GatePay-Signature': '<x-gatepay-signature>',
    'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
    'X-GatePay-Nonce': '<x-gatepay-nonce>',
    'X-GatePay-On-Behalf-Of': '<x-gatepay-on-behalf-of>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    refundRequestId: '483902480932841787',
    prepayId: '1665553233227833',
    refundAmount: '20',
    receiverId: 598816
  })
};

fetch('https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refund', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refund",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'refundRequestId' => '483902480932841787',
    'prepayId' => '1665553233227833',
    'refundAmount' => '20',
    'receiverId' => 598816
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>",
    "X-GatePay-Signature: <x-gatepay-signature>",
    "X-GatePay-Timestamp: <x-gatepay-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refund")
  .header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
  .header("X-GatePay-Signature", "<x-gatepay-signature>")
  .header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
  .header("X-GatePay-Nonce", "<x-gatepay-nonce>")
  .header("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
  .header("Content-Type", "application/json")
  .body("{\n  \"refundRequestId\": \"483902480932841787\",\n  \"prepayId\": \"1665553233227833\",\n  \"refundAmount\": \"20\",\n  \"receiverId\": 598816\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refund"

	payload := strings.NewReader("{\n  \"refundRequestId\": \"483902480932841787\",\n  \"prepayId\": \"1665553233227833\",\n  \"refundAmount\": \"20\",\n  \"receiverId\": 598816\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
	req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
	req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
	req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
	req.Header.Add("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refund")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["X-GatePay-On-Behalf-Of"] = '<x-gatepay-on-behalf-of>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"refundRequestId\": \"483902480932841787\",\n  \"prepayId\": \"1665553233227833\",\n  \"refundAmount\": \"20\",\n  \"receiverId\": 598816\n}"

response = http.request(request)
puts response.read_body

{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "refundRequestId": "483902480932841787",
    "prepayId": "1665553233227833",
    "orderAmount": "14.9",
    "refundAmount": "4.9"
  }
}

Overview

This page documents the POST /payment/open/institution/v1/pay/address/refund endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above. Initiate a refund for a direct (non-convert) address payment order.

Notes

Authentication uses the standard GatePay signed headers.
This page documents the institution-path variant of the same API.
Except for sub-account creation and sub-account query APIs, institution requests should include X-GatePay-On-Behalf-Of.
Use refundRequestId as the merchant refund request ID (do not use the deprecated refundGateId).
The response uses the standard status / code / errorMessage / data wrapper; business fields are under data.
For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

Headers

X-GatePay-Certificate-ClientId

string

required

Merchant client ID, obtained from GatePay platform

X-GatePay-Signature

string

required

HMAC-SHA256 signature for request validation

X-GatePay-Timestamp

string

required

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

X-GatePay-Nonce

string

required

Random nonce for replay attack prevention

X-GatePay-On-Behalf-Of

string

required

Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.

Body

application/json

prepayId

string

required

The ID of the corresponding payment order

refundAmount

string

required

The amount to be refunded

receiverId

integer<int64>

required

The Gate user ID of the recipient of the refund for address payment

refundRequestId

string

required

Merchant refund request ID

refundReason

string

The reason for the refund

Response

200 - application/json

SUCCESS

Standard response wrapper; business fields are under data

status

string

Status

Example:

"SUCCESS"

code

string

Business code

Example:

"000000"

errorMessage

string

Error message

data

object

Address refund business data

Show child attributes

⌘I

Common

Balance

Institution

Payment

OTC

Convert

Payout

Gift Card

Subscription

Reconciliation

Notifications

Address Payment Direct Refund

Overview

Notes

Headers

Body

Response

​Overview

​Notes

Headers

Body

Response

Overview

Notes