Get invoice payment

curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/payments/{payment_id}/ \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/payments/{payment_id}/', 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/payments/{payment_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/payments/{payment_id}/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "email": "jsmith@example.com",
    "company_name": "<string>"
  },
  "customer_name": "<string>",
  "customer_email": "<string>",
  "payment_method": "bank_transfer",
  "total_amount": 123,
  "allocated_amount": 123,
  "unallocated_amount": 123,
  "net_amount": 123,
  "processing_fee": 123,
  "processing_fee_cents": 123,
  "display_amount": "<string>",
  "is_fully_allocated": true,
  "is_completed": true,
  "processed_at": "2023-11-07T05:31:56Z",
  "failed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "allocations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_number": "<string>",
      "invoice_status": "<string>",
      "amount": 123,
      "allocated_at": "2023-11-07T05:31:56Z",
      "transaction_tags": "<unknown>",
      "notes": "<string>"
    }
  ],
  "refund_allocations": [
    {
      "refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount_cents": 123,
      "allocated_at": "2023-11-07T05:31:56Z",
      "reference_number": "<string>"
    }
  ],
  "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>"
    }
  ],
  "external_id": "<string>",
  "payment_reference": "<string>",
  "processor_reference": "<string>",
  "payment_date": "2023-11-07T05:31:56Z",
  "payment_processor": "<string>",
  "currency": "EUR",
  "status": "pending",
  "failure_reason": "<string>",
  "transaction_tags": "<unknown>",
  "metadata": "<unknown>",
  "notes": "<string>",
  "bank_reference": "<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>"
}

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

GET

platform

businesses

{business_id}

invoices

payments

{payment_id}

Get invoice payment

curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/payments/{payment_id}/ \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/payments/{payment_id}/', 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/payments/{payment_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/payments/{payment_id}/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "email": "jsmith@example.com",
    "company_name": "<string>"
  },
  "customer_name": "<string>",
  "customer_email": "<string>",
  "payment_method": "bank_transfer",
  "total_amount": 123,
  "allocated_amount": 123,
  "unallocated_amount": 123,
  "net_amount": 123,
  "processing_fee": 123,
  "processing_fee_cents": 123,
  "display_amount": "<string>",
  "is_fully_allocated": true,
  "is_completed": true,
  "processed_at": "2023-11-07T05:31:56Z",
  "failed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "allocations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_number": "<string>",
      "invoice_status": "<string>",
      "amount": 123,
      "allocated_at": "2023-11-07T05:31:56Z",
      "transaction_tags": "<unknown>",
      "notes": "<string>"
    }
  ],
  "refund_allocations": [
    {
      "refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount_cents": 123,
      "allocated_at": "2023-11-07T05:31:56Z",
      "reference_number": "<string>"
    }
  ],
  "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>"
    }
  ],
  "external_id": "<string>",
  "payment_reference": "<string>",
  "processor_reference": "<string>",
  "payment_date": "2023-11-07T05:31:56Z",
  "payment_processor": "<string>",
  "currency": "EUR",
  "status": "pending",
  "failure_reason": "<string>",
  "transaction_tags": "<unknown>",
  "metadata": "<unknown>",
  "notes": "<string>",
  "bank_reference": "<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>"
}

{
  "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<uuid>

required

Business UUID provided by Thred (unique identifier for the business)

payment_id

string<uuid>

required

A UUID string identifying this payment.

Response

Comprehensive serializer for invoice payments list endpoint. Extends PaymentSerializer with allocation details.

Inspired by external payment APIs but adapted for Friday's architecture.

string<uuid>

required

read-only

customer

object | null

required

Customer details embedded in payment and other response objects.

Show child attributes

customer_name

string

required

read-only

Customer display name

customer_email

string

required

read-only

Customer email address

payment_method

enum<string>

required

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

total_amount

integer

required

read-only

Total payment amount in cents

allocated_amount

integer

required

read-only

Amount allocated to invoices in cents

unallocated_amount

integer

required

read-only

Unallocated amount remaining in cents (customer credit if positive)

net_amount

integer

required

read-only

Net amount after deducting all fees in cents

processing_fee

integer

required

read-only

Platform processing fee charged in cents

processing_fee_cents

integer

required

read-only

Platform processing fee charged in cents (raw database field)

display_amount

string

required

read-only

Human-readable payment amount with currency symbol

is_fully_allocated

boolean

required

read-only

Whether payment is fully allocated to invoices (true if allocated_amount >= total_amount)

is_completed

boolean

required

read-only

Whether payment processing is completed (status='completed')

processed_at

string<date-time> | null

required

read-only

failed_at

string<date-time> | null

required

read-only

created_at

string<date-time>

required

read-only

updated_at

string<date-time>

required

read-only

allocations

object[]

required

read-only

Show child attributes

refund_allocations

object[]

required

read-only

Refund allocations linked to this payment

Show child attributes

reconciled_bank_transactions

object[]

required

read-only

Bank transactions this payment is reconciled to

Show child attributes

external_id

string

Maximum string length: 255

payment_reference

string

Maximum string length: 100

processor_reference

string

Maximum string length: 255

payment_date

string<date-time>

payment_processor

string

Maximum string length: 100

currency

enum<string>

EUR - Euro
GBP - British Pound
USD - US Dollar
SEK - Swedish Krona
NOK - Norwegian Krone
DKK - Danish Krone
ISK - Icelandic Króna
MYR - Malaysian Ringgit
SGD - Singapore Dollar

Available options:

EUR,

GBP,

USD,

SEK,

NOK,

DKK,

ISK,

MYR,

SGD

status

enum<string>

pending - Pending
processing - Processing
completed - Completed
failed - Failed
cancelled - Cancelled
refunded - Refunded

Available options:

pending,

processing,

completed,

failed,

cancelled,

refunded

failure_reason

string

transaction_tags

any

metadata

any

notes

string

bank_reference

string

Maximum string length: 100

Managing Businesses

Importing Business Activity

Financial Reports

Get invoice payment

Authorizations

Path Parameters

Response