THthredfi
Invoice Payments

Create invoice payment

Record a payment for one or more customer invoices. The payment is recorded and invoices are updated, ready to be matched during reconciliation later. Supports idempotency via Idempotency-Key header.

post/v1/platform/businesses/{business_id}/invoices/payments/

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

business_idstring uuid required

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

Request body

customer_idstring uuid required

UUID of the customer making the payment (must exist in business)

total_amount_centsinteger required

Total payment amount in cents (e.g., 450000 for £4,500.00)

payment_datestring date

Date when payment was received (ISO date format: YYYY-MM-DD)

currencystring

Payment currency (must match business base currency, e.g., GBP, EUR)

payment_method'bank_transfer' | 'credit_card' | 'debit_card' | 'ach' | 'check' | 'cash' | 'paypal' | 'stripe' | 'other'

Method of payment (e.g., bank_transfer, card, cash, cheque, direct_debit)

  • bank_transfer - bank_transfer
  • credit_card - credit_card
  • debit_card - debit_card
  • ach - ach
  • check - check
  • cash - cash
  • paypal - paypal
  • stripe - stripe
  • other - other
payment_referencestring

Your internal payment reference or receipt number

external_idstring

Your unique identifier for this payment (used for idempotency)

notestring

Internal note or description for the payment

notesstring

Legacy field for notes (use 'note' instead)

metadataobject

Custom key-value pairs for additional payment context

referencesobject

Payment references (bank_reference, end_to_end_id, payment_reference)

processing_fee_centsinteger

Processing fee charged by payment processor (Stripe, PayPal, etc.) in cents

payment_processorstring

Payment processor name (e.g., Stripe, PayPal)

Response

Changes

No recorded changes to this operation across all 1 revision of this API.