Refunds
Apply Transaction to a Refund
Manually apply an existing transaction as payment of a refund.
Scopes: invoice:create
POST
/
v0
/
business
/
{business_id}
/
refund-payment
Apply Transaction to a Refund
curl --request POST \
--url https://api.sandbox.getasset.com/v0/business/{business_id}/refund-payment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"refund_id": "<string>",
"transaction_id": "<string>",
"payment_amount": 1
}
'import requests
url = "https://api.sandbox.getasset.com/v0/business/{business_id}/refund-payment"
payload = {
"refund_id": "<string>",
"transaction_id": "<string>",
"payment_amount": 1
}
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({refund_id: '<string>', transaction_id: '<string>', payment_amount: 1})
};
fetch('https://api.sandbox.getasset.com/v0/business/{business_id}/refund-payment', 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.sandbox.getasset.com/v0/business/{business_id}/refund-payment",
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([
'refund_id' => '<string>',
'transaction_id' => '<string>',
'payment_amount' => 1
]),
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.sandbox.getasset.com/v0/business/{business_id}/refund-payment"
payload := strings.NewReader("{\n \"refund_id\": \"<string>\",\n \"transaction_id\": \"<string>\",\n \"payment_amount\": 1\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.sandbox.getasset.com/v0/business/{business_id}/refund-payment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"refund_id\": \"<string>\",\n \"transaction_id\": \"<string>\",\n \"payment_amount\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.getasset.com/v0/business/{business_id}/refund-payment")
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 \"refund_id\": \"<string>\",\n \"transaction_id\": \"<string>\",\n \"payment_amount\": 1\n}"
response = http.request(request)
puts response.read_body{
"data": {
"business_id": "<string>",
"external_id": "<string>",
"amount": 123,
"refunded_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"amount_paid": 0,
"memo": "<string>",
"processor": "<string>",
"is_return": false,
"status": "pending",
"payments": [
{
"amount": 123,
"id": "<string>",
"transaction_id": "<string>"
}
],
"refund_invoices": [
{
"amount": 123,
"id": "<string>",
"invoice_id": "<string>",
"invoice_line_id": "inl_WQMDNUHpBThYSNh4AprDBo",
"external_id": "<string>",
"memo": "<string>"
}
],
"tags": {
"Job": [
{
"amount": "60.00",
"value": "Maple Street Remodel"
},
{
"amount": "40.00",
"value": "Downtown Office Rewire"
}
]
}
}
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"message": "string",
"data": "string"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Optional external entity identifier that performed the action
Path Parameters
The id of the business
Example:
"biz_GA6EG2qFxA97NZHtxeLPUy"
Body
application/json
The ID of the refund to apply payment to
Example:
"rfu_Lq5AyApd4pdL1VvakpY5aJ"
The ID of the transaction to apply as payment
Example:
"txn_oiL7THC5RDi2PVUbVyyoJ"
The amount to apply as payment. Defaults to the transaction amount.
Required range:
x >= 0Response
Successful Response
Show child attributes
Show child attributes
⌘I
Apply Transaction to a Refund
curl --request POST \
--url https://api.sandbox.getasset.com/v0/business/{business_id}/refund-payment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"refund_id": "<string>",
"transaction_id": "<string>",
"payment_amount": 1
}
'import requests
url = "https://api.sandbox.getasset.com/v0/business/{business_id}/refund-payment"
payload = {
"refund_id": "<string>",
"transaction_id": "<string>",
"payment_amount": 1
}
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({refund_id: '<string>', transaction_id: '<string>', payment_amount: 1})
};
fetch('https://api.sandbox.getasset.com/v0/business/{business_id}/refund-payment', 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.sandbox.getasset.com/v0/business/{business_id}/refund-payment",
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([
'refund_id' => '<string>',
'transaction_id' => '<string>',
'payment_amount' => 1
]),
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.sandbox.getasset.com/v0/business/{business_id}/refund-payment"
payload := strings.NewReader("{\n \"refund_id\": \"<string>\",\n \"transaction_id\": \"<string>\",\n \"payment_amount\": 1\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.sandbox.getasset.com/v0/business/{business_id}/refund-payment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"refund_id\": \"<string>\",\n \"transaction_id\": \"<string>\",\n \"payment_amount\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.getasset.com/v0/business/{business_id}/refund-payment")
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 \"refund_id\": \"<string>\",\n \"transaction_id\": \"<string>\",\n \"payment_amount\": 1\n}"
response = http.request(request)
puts response.read_body{
"data": {
"business_id": "<string>",
"external_id": "<string>",
"amount": 123,
"refunded_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"amount_paid": 0,
"memo": "<string>",
"processor": "<string>",
"is_return": false,
"status": "pending",
"payments": [
{
"amount": 123,
"id": "<string>",
"transaction_id": "<string>"
}
],
"refund_invoices": [
{
"amount": 123,
"id": "<string>",
"invoice_id": "<string>",
"invoice_line_id": "inl_WQMDNUHpBThYSNh4AprDBo",
"external_id": "<string>",
"memo": "<string>"
}
],
"tags": {
"Job": [
{
"amount": "60.00",
"value": "Maple Street Remodel"
},
{
"amount": "40.00",
"value": "Downtown Office Rewire"
}
]
}
}
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"message": "string",
"data": "string"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}