Skip to main content
POST
/
companies
/
{company_id}
/
payments
/
transactions
/
{id}
/
refund
Refund a Payment Transaction
curl --request POST \
  --url https://api.getmeasure.com/api/v1/companies/{company_id}/payments/transactions/{id}/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "note": "<string>"
}
'
import requests

url = "https://api.getmeasure.com/api/v1/companies/{company_id}/payments/transactions/{id}/refund"

payload = {
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"note": "<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({amount: {currency: '<string>', value_in_cents: 123}, note: '<string>'})
};

fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/payments/transactions/{id}/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://api.getmeasure.com/api/v1/companies/{company_id}/payments/transactions/{id}/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([
'amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'note' => '<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://api.getmeasure.com/api/v1/companies/{company_id}/payments/transactions/{id}/refund"

payload := strings.NewReader("{\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"note\": \"<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://api.getmeasure.com/api/v1/companies/{company_id}/payments/transactions/{id}/refund")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"note\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/payments/transactions/{id}/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 \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"note\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "application_fee_amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "company_id": "<string>",
  "connected_account_transaction": true,
  "created_at": "2023-11-07T05:31:56Z",
  "customer": {
    "email": "<string>",
    "id": "<string>",
    "identifier": "<string>",
    "name": "<string>",
    "org_name": "<string>",
    "parent_customer": "<unknown>",
    "parent_customer_id": "<string>"
  },
  "customer_id": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "disallow_partial_refund": true,
  "id": "<string>",
  "initiated_by": "<string>",
  "initiated_by_type": "<string>",
  "invoice_number": "<string>",
  "invoice_uuid": "<string>",
  "is_refundable": true,
  "is_voidable": true,
  "net_amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "note": "<string>",
  "payment_method": {
    "brand": "<string>",
    "last_4": "<string>",
    "name": "<string>",
    "type": "<string>"
  },
  "proposal_id": "<string>",
  "provider_transaction_id": "<string>",
  "provider_type": "<string>",
  "refundable_amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "status": "<string>",
  "status_message": "<string>",
  "stripe_fee_amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "total_amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "total_amount_default_currency": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "total_fee_amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "transaction_type": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

company_id
string
required

The company ID with the prefix 'cmp_'.

id
string
required

The resource ID

Body

application/json
amount
object
note
null | string

An optional internal note for the refund transaction

reason
enum<string>
Available options:
duplicate,
fraudulent,
requested_by_customer,
expired_uncaptured_charge

Response

200 - application/json

OK

application_fee_amount
object

The amount which has value in cents and a currency

company_id
string
connected_account_transaction
boolean
created_at
string<date-time>
customer
object
customer_id
string
deleted_at
null | string<date-time>
disallow_partial_refund
null | boolean
id
string
initiated_by
null | string
initiated_by_type
null | string
invoice_number
string
invoice_uuid
string
is_refundable
boolean
is_voidable
boolean
net_amount
object

The amount which has value in cents and a currency

note
null | string
payment_method
object
proposal_id
null | string
provider_transaction_id
string
provider_type
string
refundable_amount
object

The amount which has value in cents and a currency

status
string
status_message
null | string
stripe_fee_amount
object

The amount which has value in cents and a currency

total_amount
object

The amount which has value in cents and a currency

total_amount_default_currency
object

The amount which has value in cents and a currency

total_fee_amount
object

The amount which has value in cents and a currency

transaction_type
string
updated_at
string<date-time>