Initiate a Refund

curl --request POST \
  --url https://api.bluswap.co/api/v1/transactions/payin/initiate_refund_cust \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "original_ref_id": "<string>",
  "order_id": "<string>",
  "amount": 123,
  "refund_reason": "<string>",
  "description": "<string>",
  "refund_type": "<string>"
}
'

import requests

url = "https://api.bluswap.co/api/v1/transactions/payin/initiate_refund_cust"

payload = {
    "original_ref_id": "<string>",
    "order_id": "<string>",
    "amount": 123,
    "refund_reason": "<string>",
    "description": "<string>",
    "refund_type": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "<content-type>"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    original_ref_id: '<string>',
    order_id: '<string>',
    amount: 123,
    refund_reason: '<string>',
    description: '<string>',
    refund_type: '<string>'
  })
};

fetch('https://api.bluswap.co/api/v1/transactions/payin/initiate_refund_cust', 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://api.bluswap.co/api/v1/transactions/payin/initiate_refund_cust",
  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([
    'original_ref_id' => '<string>',
    'order_id' => '<string>',
    'amount' => 123,
    'refund_reason' => '<string>',
    'description' => '<string>',
    'refund_type' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: <content-type>",
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.bluswap.co/api/v1/transactions/payin/initiate_refund_cust"

	payload := strings.NewReader("{\n  \"original_ref_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"amount\": 123,\n  \"refund_reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"refund_type\": \"<string>\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "<content-type>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.bluswap.co/api/v1/transactions/payin/initiate_refund_cust")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "<content-type>")
  .body("{\n  \"original_ref_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"amount\": 123,\n  \"refund_reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"refund_type\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bluswap.co/api/v1/transactions/payin/initiate_refund_cust")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = '<content-type>'
request.body = "{\n  \"original_ref_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"amount\": 123,\n  \"refund_reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"refund_type\": \"<string>\"\n}"

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

{
  "ref_id": "<string>",
  "status": "<string>"
}

Use this endpoint to initiate a refund against a previously completed payin (collection) transaction. You can issue a full refund or a partial refund by specifying the appropriate refund_type and amount. Once submitted, bluSwap queues the refund for processing and returns a refund reference ID you can use to track its progress.

Headers

string

required

Your secret API key used to authenticate all requests.

string

required

Must be application/json.

Request Parameters

string

required

Reference ID of the original payin transaction you want to refund.

string

required

Unique order ID for this refund request.

number

required

Amount to be refunded. For a full refund this must match the original transaction amount.

string

required

Reason for initiating the refund. This is recorded against the refund record.

string

Additional description or notes for the refund. This field is optional.

string

required

Type of refund to perform. Pass FULL_REFUND to refund the entire original transaction amount.

Response

A successful request returns a 200 OK with a JSON body containing the refund reference ID. Save the ref_id value — you need it to track refund progress using the Check Refund Status endpoint.

string

Unique reference ID assigned to this refund. Use it to poll refund status.

string

Initial status of the refund (e.g. PENDING).

Save the ref_id returned in the response. You need it to track refund progress using the Check Refund Status endpoint.

Initiate a Refund

curl --request POST \
  --url https://api.bluswap.co/api/v1/transactions/payin/initiate_refund_cust \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "original_ref_id": "<string>",
  "order_id": "<string>",
  "amount": 123,
  "refund_reason": "<string>",
  "description": "<string>",
  "refund_type": "<string>"
}
'

import requests

url = "https://api.bluswap.co/api/v1/transactions/payin/initiate_refund_cust"

payload = {
    "original_ref_id": "<string>",
    "order_id": "<string>",
    "amount": 123,
    "refund_reason": "<string>",
    "description": "<string>",
    "refund_type": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "<content-type>"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    original_ref_id: '<string>',
    order_id: '<string>',
    amount: 123,
    refund_reason: '<string>',
    description: '<string>',
    refund_type: '<string>'
  })
};

fetch('https://api.bluswap.co/api/v1/transactions/payin/initiate_refund_cust', 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://api.bluswap.co/api/v1/transactions/payin/initiate_refund_cust",
  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([
    'original_ref_id' => '<string>',
    'order_id' => '<string>',
    'amount' => 123,
    'refund_reason' => '<string>',
    'description' => '<string>',
    'refund_type' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: <content-type>",
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.bluswap.co/api/v1/transactions/payin/initiate_refund_cust"

	payload := strings.NewReader("{\n  \"original_ref_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"amount\": 123,\n  \"refund_reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"refund_type\": \"<string>\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "<content-type>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.bluswap.co/api/v1/transactions/payin/initiate_refund_cust")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "<content-type>")
  .body("{\n  \"original_ref_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"amount\": 123,\n  \"refund_reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"refund_type\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bluswap.co/api/v1/transactions/payin/initiate_refund_cust")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = '<content-type>'
request.body = "{\n  \"original_ref_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"amount\": 123,\n  \"refund_reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"refund_type\": \"<string>\"\n}"

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

{
  "ref_id": "<string>",
  "status": "<string>"
}

Get Started

Collections

Payouts

Refunds

Initiate a Refund

Headers

Request Parameters

Response

​Headers

​Request Parameters

​Response

Headers

Request Parameters

Response