Post v1adminpayments refunds

cURL

curl --request POST \
  --url https://api.example.com/v1/admin/payments/{paymentID}/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amountMinor": 1,
  "currency": "<string>",
  "reason": "<string>",
  "receiptMetadata": {}
}
'

import requests

url = "https://api.example.com/v1/admin/payments/{paymentID}/refunds"

payload = {
    "amountMinor": 1,
    "currency": "<string>",
    "reason": "<string>",
    "receiptMetadata": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({amountMinor: 1, currency: '<string>', reason: '<string>', receiptMetadata: {}})
};

fetch('https://api.example.com/v1/admin/payments/{paymentID}/refunds', 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.example.com/v1/admin/payments/{paymentID}/refunds",
  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([
    'amountMinor' => 1,
    'currency' => '<string>',
    'reason' => '<string>',
    'receiptMetadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-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.example.com/v1/admin/payments/{paymentID}/refunds"

	payload := strings.NewReader("{\n  \"amountMinor\": 1,\n  \"currency\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"receiptMetadata\": {}\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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://api.example.com/v1/admin/payments/{paymentID}/refunds")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amountMinor\": 1,\n  \"currency\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"receiptMetadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/admin/payments/{paymentID}/refunds")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amountMinor\": 1,\n  \"currency\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"receiptMetadata\": {}\n}"

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

{
  "amountMinor": 1,
  "currency": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "providerReference": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

POST

admin

payments

{paymentID}

refunds

cURL

curl --request POST \
  --url https://api.example.com/v1/admin/payments/{paymentID}/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amountMinor": 1,
  "currency": "<string>",
  "reason": "<string>",
  "receiptMetadata": {}
}
'

import requests

url = "https://api.example.com/v1/admin/payments/{paymentID}/refunds"

payload = {
    "amountMinor": 1,
    "currency": "<string>",
    "reason": "<string>",
    "receiptMetadata": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({amountMinor: 1, currency: '<string>', reason: '<string>', receiptMetadata: {}})
};

fetch('https://api.example.com/v1/admin/payments/{paymentID}/refunds', 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.example.com/v1/admin/payments/{paymentID}/refunds",
  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([
    'amountMinor' => 1,
    'currency' => '<string>',
    'reason' => '<string>',
    'receiptMetadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-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.example.com/v1/admin/payments/{paymentID}/refunds"

	payload := strings.NewReader("{\n  \"amountMinor\": 1,\n  \"currency\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"receiptMetadata\": {}\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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://api.example.com/v1/admin/payments/{paymentID}/refunds")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amountMinor\": 1,\n  \"currency\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"receiptMetadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/admin/payments/{paymentID}/refunds")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amountMinor\": 1,\n  \"currency\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"receiptMetadata\": {}\n}"

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

{
  "amountMinor": 1,
  "currency": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "providerReference": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

required

Required string length: 8 - 128

Path Parameters

paymentID

string<uuid>

required

Body

application/json

amountMinor

integer<int64>

required

Required range: x >= 0

currency

string

required

Pattern: ^[A-Z]{3}$

reason

string

required

receiptMetadata

object

Response

Refund recorded

amountMinor

integer<int64>

required

Required range: x >= 0

currency

string

required

Pattern: ^[A-Z]{3}$

string<uuid>

status

string

providerReference

string | null

Start

Architecture

For customers

Commerce

Integrations

API reference

Operator panel

AI and MCP

Running Omniflow

Contributing

Post v1adminpayments refunds

Authorizations

Headers

Path Parameters

Body

Response