Create refund payment

curl --request POST \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/payments/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_cents": 2,
  "external_id": "<string>",
  "completed_at": "2023-11-07T05:31:56Z",
  "processor": "<string>",
  "memo": "<string>",
  "transaction_tags": [
    "<string>"
  ],
  "refund_processing_fee_cents": 0
}
'

import requests

url = "https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/payments/"

payload = {
    "amount_cents": 2,
    "external_id": "<string>",
    "completed_at": "2023-11-07T05:31:56Z",
    "processor": "<string>",
    "memo": "<string>",
    "transaction_tags": ["<string>"],
    "refund_processing_fee_cents": 0
}
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_cents: 2,
    external_id: '<string>',
    completed_at: '2023-11-07T05:31:56Z',
    processor: '<string>',
    memo: '<string>',
    transaction_tags: ['<string>'],
    refund_processing_fee_cents: 0
  })
};

fetch('https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/payments/', 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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/payments/",
  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,
    'external_id' => '<string>',
    'completed_at' => '2023-11-07T05:31:56Z',
    'processor' => '<string>',
    'memo' => '<string>',
    'transaction_tags' => [
        '<string>'
    ],
    'refund_processing_fee_cents' => 0
  ]),
  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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/payments/"

	payload := strings.NewReader("{\n  \"amount_cents\": 2,\n  \"external_id\": \"<string>\",\n  \"completed_at\": \"2023-11-07T05:31:56Z\",\n  \"processor\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"transaction_tags\": [\n    \"<string>\"\n  ],\n  \"refund_processing_fee_cents\": 0\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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/payments/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount_cents\": 2,\n  \"external_id\": \"<string>\",\n  \"completed_at\": \"2023-11-07T05:31:56Z\",\n  \"processor\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"transaction_tags\": [\n    \"<string>\"\n  ],\n  \"refund_processing_fee_cents\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/payments/")

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_cents\": 2,\n  \"external_id\": \"<string>\",\n  \"completed_at\": \"2023-11-07T05:31:56Z\",\n  \"processor\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"transaction_tags\": [\n    \"<string>\"\n  ],\n  \"refund_processing_fee_cents\": 0\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "refunded_amount": 123,
  "refund_processing_fee": 123,
  "reconciled_bank_transactions": [
    {
      "bank_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bank_transaction_date": "2023-11-07T05:31:56Z",
      "bank_transaction_amount_cents": 123,
      "bank_transaction_direction": "<string>",
      "reconciled_amount_cents": 123,
      "reconciliation_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reconciled_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "payment_type": "<string>",
      "bank_account_name": "<string>",
      "notes": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "completed_at": "2023-11-07T05:31:56Z",
  "method": "BANK_TRANSFER",
  "processor": "<string>",
  "transaction_tags": "<unknown>",
  "memo": "<string>",
  "metadata": "<unknown>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

POST

platform

businesses

{business_id}

invoices

refunds

{refund_id}

payments

Create refund payment

curl --request POST \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/payments/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_cents": 2,
  "external_id": "<string>",
  "completed_at": "2023-11-07T05:31:56Z",
  "processor": "<string>",
  "memo": "<string>",
  "transaction_tags": [
    "<string>"
  ],
  "refund_processing_fee_cents": 0
}
'

import requests

url = "https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/payments/"

payload = {
    "amount_cents": 2,
    "external_id": "<string>",
    "completed_at": "2023-11-07T05:31:56Z",
    "processor": "<string>",
    "memo": "<string>",
    "transaction_tags": ["<string>"],
    "refund_processing_fee_cents": 0
}
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_cents: 2,
    external_id: '<string>',
    completed_at: '2023-11-07T05:31:56Z',
    processor: '<string>',
    memo: '<string>',
    transaction_tags: ['<string>'],
    refund_processing_fee_cents: 0
  })
};

fetch('https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/payments/', 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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/payments/",
  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,
    'external_id' => '<string>',
    'completed_at' => '2023-11-07T05:31:56Z',
    'processor' => '<string>',
    'memo' => '<string>',
    'transaction_tags' => [
        '<string>'
    ],
    'refund_processing_fee_cents' => 0
  ]),
  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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/payments/"

	payload := strings.NewReader("{\n  \"amount_cents\": 2,\n  \"external_id\": \"<string>\",\n  \"completed_at\": \"2023-11-07T05:31:56Z\",\n  \"processor\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"transaction_tags\": [\n    \"<string>\"\n  ],\n  \"refund_processing_fee_cents\": 0\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://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/payments/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount_cents\": 2,\n  \"external_id\": \"<string>\",\n  \"completed_at\": \"2023-11-07T05:31:56Z\",\n  \"processor\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"transaction_tags\": [\n    \"<string>\"\n  ],\n  \"refund_processing_fee_cents\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/refunds/{refund_id}/payments/")

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_cents\": 2,\n  \"external_id\": \"<string>\",\n  \"completed_at\": \"2023-11-07T05:31:56Z\",\n  \"processor\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"transaction_tags\": [\n    \"<string>\"\n  ],\n  \"refund_processing_fee_cents\": 0\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "refunded_amount": 123,
  "refund_processing_fee": 123,
  "reconciled_bank_transactions": [
    {
      "bank_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bank_transaction_date": "2023-11-07T05:31:56Z",
      "bank_transaction_amount_cents": 123,
      "bank_transaction_direction": "<string>",
      "reconciled_amount_cents": 123,
      "reconciliation_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reconciled_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "payment_type": "<string>",
      "bank_account_name": "<string>",
      "notes": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "completed_at": "2023-11-07T05:31:56Z",
  "method": "BANK_TRANSFER",
  "processor": "<string>",
  "transaction_tags": "<unknown>",
  "memo": "<string>",
  "metadata": "<unknown>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

{
  "error_code": "<string>",
  "message": "<string>",
  "detail": {},
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id

string

required

Pattern: ^[0-9a-f-]+$

refund_id

string

required

Pattern: ^[0-9a-f-]+$

Body

Serializer for creating a refund payment (reusable for other endpoints). All amounts in cents.

amount_cents

integer

required

Amount to disburse for this refund in cents (e.g., 20000 for €200.00)

Required range: x >= 1

method

enum<string>

required

Payment method for the refund payment

CASH - Cash
CHECK - Check
CREDIT_CARD - Credit Card
DEBIT_CARD - Debit Card
ACH - ACH
BANK_TRANSFER - Bank Transfer
PAYPAL - PayPal
STRIPE - Stripe
OTHER - Other

Available options:

CASH,

CHECK,

CREDIT_CARD,

DEBIT_CARD,

ACH,

BANK_TRANSFER,

PAYPAL,

STRIPE,

OTHER

external_id

string

required

Required idempotency key per refund (unique within a refund)

Required string length: 1 - 255

completed_at

string<date-time>

When the refund payment was completed

processor

string

Payment processor

Maximum string length: 100

memo

string

Optional notes for the payment

transaction_tags

string[]

Optional list of string tags for reconciliation

Required string length: 1 - 100

refund_processing_fee_cents

integer

default:0

Processing fee for this refund payment in cents (e.g., 30 for €0.30)

Required range: x >= 0

Response

Serializer for refund payments. All amounts in cents.

string<uuid>

required

read-only

Unique refund payment identifier

refund_id

string<uuid>

required

read-only

ID of the refund this payment belongs to

refunded_amount

integer

required

read-only

Refunded amount in cents

refund_processing_fee

integer

required

read-only

Processing fee in cents

reconciled_bank_transactions

object[]

required

read-only

Bank transactions this refund payment is reconciled to

Show child attributes

created_at

string<date-time>

required

read-only

Timestamp when refund payment record was created

updated_at

string<date-time>

required

read-only

Timestamp when refund payment record was last updated

external_id

string

Your unique identifier for idempotency (unique within refund)

Maximum string length: 255

completed_at

string<date-time> | null

Date and time when refund payment was completed

method

enum<string>

Payment method used for refund (CASH, CHECK, CREDIT_CARD, BANK_TRANSFER, etc.)

BANK_TRANSFER - Bank Transfer
CREDIT_CARD - Credit Card
DEBIT_CARD - Debit Card
ACH - ACH/Direct Debit
CHECK - Check/Cheque
CASH - Cash
PAYPAL - PayPal
STRIPE - Stripe
OTHER - Other

Available options:

BANK_TRANSFER,

CREDIT_CARD,

DEBIT_CARD,

ACH,

CHECK,

CASH,

PAYPAL,

STRIPE,

OTHER

processor

string

Payment processor used (e.g., Stripe, PayPal, manual)

Maximum string length: 100

transaction_tags

any

List of tags for categorization and reconciliation tracking

memo

string

Optional description or notes for this refund payment

metadata

any

Custom key-value pairs for payment context

Managing Businesses

Importing Business Activity

Financial Reports

Create refund payment

Authorizations

Path Parameters

Body

Response