Refunds
Refund payment
Refunds a customer’s unused bank-transfer credit from one of their bank deposits to their verified bank account. The amount is what is left of the deposit’s credit, at most what the customer can spend: credit their unpaid orders have claimed isn’t refunded. The credit is reserved while the refund is in progress, and the bank is asked to pay it at once. Returns the refund as a PaymentDetail, with its own payment_id. Fails with a 400 for an unknown deposit or bank account, or when none of the deposit’s credit is left; with a 409, refunding nothing, when the credit can’t be refunded at that moment.
POST
/
orders
/
payments
/
refund
Refund payment
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payments/refund \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customer_id": "<string>",
"payment_id": "<string>",
"bank_account_id": "<string>"
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payments/refund"
payload = {
"customer_id": "<string>",
"payment_id": "<string>",
"bank_account_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({customer_id: '<string>', payment_id: '<string>', bank_account_id: '<string>'})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payments/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://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payments/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([
'customer_id' => '<string>',
'payment_id' => '<string>',
'bank_account_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payments/refund"
payload := strings.NewReader("{\n \"customer_id\": \"<string>\",\n \"payment_id\": \"<string>\",\n \"bank_account_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}HttpResponse<String> response = Unirest.post("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payments/refund")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"<string>\",\n \"payment_id\": \"<string>\",\n \"bank_account_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payments/refund")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"<string>\",\n \"payment_id\": \"<string>\",\n \"bank_account_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Refund registered successfully.",
"success": true,
"content": {
"payment": {
"payment_id": "<string>",
"transaction_type": "payment",
"request_number": "<string>",
"transaction_date": "2023-11-07T05:31:56Z",
"transaction_amount": 123,
"settled_amount": 0,
"unsettled_amount": 0,
"payment_method": "<string>",
"payment_reference_number": "<string>",
"payment_mode": "bank-transfer",
"payment_gateway": "juspay",
"status": "pending",
"user_id": "<string>",
"customer_id": "<string>",
"customer_name": "<string>",
"icon_url": "<string>",
"card_number": "<string>",
"card_type": "<string>",
"bank_name": "<string>",
"wallet_name": "<string>",
"bank_account_number": "<string>",
"upi_id": "<string>",
"settlement": [
{
"settlement_option": "order",
"settlement_date": "2023-11-07T05:31:56Z",
"settled_amount": 123,
"payment_method": "<string>",
"card_number": "<string>",
"card_type": "<string>",
"upi_id": "<string>",
"bank_account_number": "<string>",
"bank_name": "<string>",
"icon_url": "<string>",
"order_number": "<string>",
"order_date": "2023-11-07T05:31:56Z",
"order_amount": 123,
"order_status": "draft",
"wallet_name": "<string>"
}
],
"allowed_actions": [
"refund"
]
}
}
}{
"message": "<string>",
"success": true,
"code": "<string>",
"errors": {},
"content": {},
"details": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>"
}{
"message": "A credit balance refund waits for the payment ledger update to finish; try again shortly",
"success": false
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>",
"error_id": "<string>"
}Authorizations
Body
application/json
Was this page helpful?
⌘I
Refund payment
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payments/refund \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customer_id": "<string>",
"payment_id": "<string>",
"bank_account_id": "<string>"
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payments/refund"
payload = {
"customer_id": "<string>",
"payment_id": "<string>",
"bank_account_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({customer_id: '<string>', payment_id: '<string>', bank_account_id: '<string>'})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payments/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://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payments/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([
'customer_id' => '<string>',
'payment_id' => '<string>',
'bank_account_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payments/refund"
payload := strings.NewReader("{\n \"customer_id\": \"<string>\",\n \"payment_id\": \"<string>\",\n \"bank_account_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}HttpResponse<String> response = Unirest.post("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payments/refund")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"<string>\",\n \"payment_id\": \"<string>\",\n \"bank_account_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payments/refund")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"<string>\",\n \"payment_id\": \"<string>\",\n \"bank_account_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Refund registered successfully.",
"success": true,
"content": {
"payment": {
"payment_id": "<string>",
"transaction_type": "payment",
"request_number": "<string>",
"transaction_date": "2023-11-07T05:31:56Z",
"transaction_amount": 123,
"settled_amount": 0,
"unsettled_amount": 0,
"payment_method": "<string>",
"payment_reference_number": "<string>",
"payment_mode": "bank-transfer",
"payment_gateway": "juspay",
"status": "pending",
"user_id": "<string>",
"customer_id": "<string>",
"customer_name": "<string>",
"icon_url": "<string>",
"card_number": "<string>",
"card_type": "<string>",
"bank_name": "<string>",
"wallet_name": "<string>",
"bank_account_number": "<string>",
"upi_id": "<string>",
"settlement": [
{
"settlement_option": "order",
"settlement_date": "2023-11-07T05:31:56Z",
"settled_amount": 123,
"payment_method": "<string>",
"card_number": "<string>",
"card_type": "<string>",
"upi_id": "<string>",
"bank_account_number": "<string>",
"bank_name": "<string>",
"icon_url": "<string>",
"order_number": "<string>",
"order_date": "2023-11-07T05:31:56Z",
"order_amount": 123,
"order_status": "draft",
"wallet_name": "<string>"
}
],
"allowed_actions": [
"refund"
]
}
}
}{
"message": "<string>",
"success": true,
"code": "<string>",
"errors": {},
"content": {},
"details": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>"
}{
"message": "A credit balance refund waits for the payment ledger update to finish; try again shortly",
"success": false
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>",
"error_id": "<string>"
}