Get bill payment details

Retrieve detailed information about a specific bill payment.

Returns:

• Complete payment information
• Associated vendor details
• Allocations (bills paid)
• Reconciliation status

Use Cases:

• View payment status and details
• Check allocation breakdown
• Audit trail
• Debugging and support

GET /v1/platform/businesses/{business_id}/bills/payments/{bill_payment_id}

Get bill payment details

cURL

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

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_name": "<string>",
  "payment_reference": "<string>",
  "external_id": "<string>",
  "processor_payment_id": "<string>",
  "check_number": "<string>",
  "amount_cents": 123,
  "currency": "<string>",
  "processing_fee_cents": 123,
  "net_amount_cents": 123,
  "allocated_amount_cents": 123,
  "unallocated_amount_cents": 123,
  "is_fully_allocated": true,
  "payment_method": "<string>",
  "status": "<string>",
  "payment_date": "2023-12-25",
  "value_date": "2023-12-25",
  "submitted_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "failed_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "memo": "<string>",
  "failure_reason": "<string>",
  "metadata": "<unknown>",
  "allocations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bill_number": "<string>",
      "vendor_bill_number": "<string>",
      "bill_status": "<string>",
      "amount_cents": 123,
      "allocation_date": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>"
    }
  ],
  "vendor_refund_allocations": [
    {
      "vendor_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>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

BusinessScopedJWTPartnerJWTBasicAuthBearerUnscopedBearerBusinessScoped

Authorization · string · header · required

Business-scoped JWT token. Token payload includes business_id to automatically scope requests. Format: Bearer <your-jwt-token>

Use this for: Business-specific operations where the business context is embedded in the token.

Path Parameters

bill_payment_id · string<uuid> · required

Bill Payment UUID

business_id · string<uuid> · required

Business UUID

Response

200

application/json

Detailed response serializer for bill payment with all related data.

Returns payment details along with vendor info and allocations. All amounts in cents.

id · string<uuid> · required · read-only

Unique bill payment identifier

business_id · string<uuid> · required · read-only

Business this payment belongs to

vendor_id · string<uuid> · required · read-only

Vendor receiving the payment

vendor_name · string · required · read-only

Vendor display name

payment_reference · string · required · read-only

Payment reference or transaction ID

external_id · string · required · read-only

Your external identifier for this payment

processor_payment_id · string · required · read-only

Payment processor transaction ID (e.g., Stripe ID)

check_number · string · required · read-only

Check number if payment method is check

amount_cents · integer · required · read-only

Payment amount in cents

currency · string · required · read-only

Payment currency (e.g., GBP, EUR, USD)

processing_fee_cents · integer · required · read-only

Processing fee in cents

net_amount_cents · integer · required · read-only

Net amount after fees in cents

allocated_amount_cents · integer · required · read-only

Allocated amount in cents

unallocated_amount_cents · integer · required · read-only

Unallocated amount in cents

is_fully_allocated · boolean · required · read-only

Whether payment is fully allocated to bills

payment_method · string · required · read-only

Payment method used (bank_transfer, check, wire, etc.)

status · string · required · read-only

Payment status (pending, processing, completed, failed, cancelled)

payment_date · string<date> · required · read-only

Date payment was made

value_date · string<date> · required · read-only

Value date for accounting purposes

submitted_at · string<date-time> · required · read-only

When payment was submitted for processing

completed_at · string<date-time> · required · read-only

When payment processing completed

failed_at · string<date-time> · required · read-only

When payment failed (if applicable)

description · string · required · read-only

Payment description

memo · string · required · read-only

Additional notes or memo

failure_reason · string · required · read-only

Reason for failure (if status=failed)

metadata · any · required · read-only

Custom key-value pairs

allocations · object[] · required · read-only

Bill allocations for this payment

Show child attributes

vendor_refund_allocations · object[] · required · read-only

Vendor 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

created_at · string<date-time> · required · read-only

Payment creation timestamp

updated_at · string<date-time> · required · read-only

Last update timestamp