Skip to main content
Deprecated in V4: Payments have been consolidated into the unified Transaction model. Use GET /v4/payments/transactions?type=PAYMENT to retrieve payments.
In V4, Payments are now represented as Transactions with type: "PAYMENT". This provides a unified way to manage all monetary movements including payments, refunds, and credits.

Migration Guide

Previous V3 Approach

GET /v3/payments/payments

New V4 Approach

GET /v4/payments/transactions?type=PAYMENT

Key Changes

V3 FieldV4 Transaction Field
payment_idplatform_id
amountamount
contact_idcontact_id
statusstatus
payment_methodpayment_method_type
-type (set to “PAYMENT”)
-gateway
-gateway_transaction_id
See the Transaction overview for the complete V4 schema.