Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| type | string | Yes | Transaction type: payment, refund, credit_note, adjustment |
| contact_id | string | Yes | Reference to the Contact |
| currency_id | string | Yes | ISO 4217 currency code |
| amount | number | Yes | Transaction amount (always positive) |
| invoice_id | string | No* | Reference to associated Invoice |
| order_id | string | No | Reference to associated Order |
| subscription_id | string | No | Reference to Subscription (for recurring payments) |
| payment_method_type | string | No | Payment method (for payments): card, bank_transfer, paypal, etc. |
| description | string | No | Human-readable description |
| original_transaction_id | string | No* | For refunds, the original payment transaction ID |
| reason | string | No | Reason code for refunds/credits |
| metadata | object | No | Additional platform-specific data |
*Required fields vary by transaction type:
- Payment:
invoice_idororder_idtypically required - Refund:
original_transaction_idrequired - Credit Note:
invoice_idorcontact_idrequired
Transaction Types
| Type | Description | Required Fields |
|---|---|---|
payment | Record a contact payment | contact_id, amount, invoice_id or order_id |
refund | Refund a previous payment | amount, original_transaction_id |
credit_note | Apply credit to contact account | contact_id, amount |
adjustment | Manual balance adjustment | contact_id, amount, description |