Skip to main content
GET
Get bill payment details

Authorizations

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

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

vendor_refund_allocations
object[]
required
read-only

Vendor refund allocations linked to this payment

reconciled_bank_transactions
object[]
required
read-only

Bank transactions this payment is reconciled to

created_at
string<date-time>
required
read-only

Payment creation timestamp

updated_at
string<date-time>
required
read-only

Last update timestamp