Payments
Payments
A Payment in Tabs represents the transfer of funds from a customer to settle one or more Invoices. Payments track details such as amount, payment method, external references (e.g., Stripe IDs), and the date the payment was received.
Payment Object
| Field | Type | Description | Required |
|---|---|---|---|
| id | string | Unique identifier for the payment (e.g., a UUID). | Yes |
| invoiceId | string | The ID of the invoice this payment is associated with. | Yes |
| total | number | Total amount of the payment (e.g., 99.99). | Yes |
| stripeId | string (optional) | Identifier if processed through Stripe (e.g., “pi_1234567890”). | No |
| receivedAt | Date | Date/time the payment was received. | Yes |
| status | PaymentStatus | Current status of the payment (e.g., PENDING, COMPLETED, FAILED). | Yes |
| type | PaymentType | Type of payment (e.g., MANUAL, AUTOMATED). | Yes |
| reference | string (optional) | Reference number for tracking the payment (e.g., check number). | No |
| method | PaymentMethodType | Method of payment (e.g., CREDIT_CARD, ACH, CHECK). | Yes |
| externalIds | IntegrationsExternalId[] | A list of external identifiers for the payment, useful for linking to third-party systems. | No |
Payment Status
COMPLETED: Payment fully received and applied.PENDING: Payment initiated but not yet confirmed.FAILED: Payment attempt failed or was rejected.- (Other statuses may be available depending on your Tabs account configuration.)
Payment Method
CREDIT_CARDACHCHECKWIRE- (and any other custom methods your organization supports)
Updated 8 months ago