Refund a payment

curl --request POST \
  --url https://api.cope.com/v1/commerce/payments/{id}/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount_cents": 2
}
'

import requests

url = "https://api.cope.com/v1/commerce/payments/{id}/refunds"

payload = { "amount_cents": 2 }
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({amount_cents: 2})
};

fetch('https://api.cope.com/v1/commerce/payments/{id}/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.cope.com/v1/commerce/payments/{id}/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([
    'amount_cents' => 2
  ]),
  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.cope.com/v1/commerce/payments/{id}/refunds"

	payload := strings.NewReader("{\n  \"amount_cents\": 2\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.cope.com/v1/commerce/payments/{id}/refunds")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount_cents\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cope.com/v1/commerce/payments/{id}/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  \"amount_cents\": 2\n}"

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

{
  "data": {
    "amount_cents": 123,
    "cash_flow_at": "<string>",
    "created_at": "<string>",
    "currency": "<string>",
    "id": "py_A1b2C3d4E5f6",
    "order": {
      "id": "ord_A1b2C3d4E5f6"
    },
    "payment_method": "<string>",
    "payment_type": "<string>",
    "refunded_payment": {
      "id": "py_A1b2C3d4E5f6"
    },
    "status": "<string>"
  }
}

Refund a payment

Refunds a settled sale and returns the refund it created. Only a sale can be refunded — passing a refund’s own id answers 404, exactly as reading it through GET /v1/commerce/payments/{id} does.

amount_cents is the amount to return in minor units and must be a positive integer. Omit the field entirely to refund everything still refundable on the payment; an explicit null is refused, so there is exactly one way to ask for a full refund. It is also the only field the body accepts: any other key is refused with 422 rather than ignored, so a misspelled field name cannot quietly become a full refund.

The refund is refused with 422 when the payment cannot be refunded at all: it is already charged back, already fully refunded, past its refund window, or split across tenders.

Idempotency-Key is required. A retry carrying the same key and the same body returns the original refund; the same key with a different body is refused with 409. Two deliberate refunds of the same size need two different keys — that is the only thing distinguishing them from a retry.

POST

commerce

payments

{id}

refunds

Refund a payment

curl --request POST \
  --url https://api.cope.com/v1/commerce/payments/{id}/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount_cents": 2
}
'

import requests

url = "https://api.cope.com/v1/commerce/payments/{id}/refunds"

payload = { "amount_cents": 2 }
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({amount_cents: 2})
};

fetch('https://api.cope.com/v1/commerce/payments/{id}/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.cope.com/v1/commerce/payments/{id}/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([
    'amount_cents' => 2
  ]),
  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.cope.com/v1/commerce/payments/{id}/refunds"

	payload := strings.NewReader("{\n  \"amount_cents\": 2\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.cope.com/v1/commerce/payments/{id}/refunds")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount_cents\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cope.com/v1/commerce/payments/{id}/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  \"amount_cents\": 2\n}"

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

{
  "data": {
    "amount_cents": 123,
    "cash_flow_at": "<string>",
    "created_at": "<string>",
    "currency": "<string>",
    "id": "py_A1b2C3d4E5f6",
    "order": {
      "id": "ord_A1b2C3d4E5f6"
    },
    "payment_method": "<string>",
    "payment_type": "<string>",
    "refunded_payment": {
      "id": "py_A1b2C3d4E5f6"
    },
    "status": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer credential for the public API. Vendor integrations should send a live COPE API key (cope_sk_live_*). Clerk bearer tokens are also accepted when paired with X-Cope-Business-Id.

Headers

Idempotency-Key

string

required

Required. At most 255 characters of valid UTF-8 with no NUL byte. A retry that carries the same key and the same body returns the original response instead of performing the write a second time. The same key with a different body is refused with 409 idempotency_conflict. Keys are remembered for 24 hours.

Maximum string length: 255

Path Parameters

string

required

id public identifier.

Pattern: ^py_(?:[A-Za-z0-9]{12}|[0-9a-f]{24})$

Example:

"py_A1b2C3d4E5f6"

Body

application/json

amount_cents

integer

Amount to refund in minor units. Omit the field entirely to refund everything still refundable; an explicit null is refused.

Required range: x >= 1

Response

Successful response

data

object

required

Show child attributes