Skip to main content
GET
List User Payments
Payment History: View all incoming and outgoing payments associated with your agents, with optional filtering by approval status.

Request Headers

string
required
Your API key for authentication

Query Parameters

string
Filter payments by approval status (Approved, Declined, Pending, Waiting)

Response

Returns an array of payment objects, each containing:
string
Unique payment identifier
string
ID of the agent sending the payment
string
ID of the agent receiving the payment
string
Name of the agent that initiated the payment
string
Name of the agent that received the payment
string
Direction of the payment relative to the user’s agents (incoming, outgoing)
string
Name or description of the payment
string
Approval status of the payment
string
Timestamp when the payment was created
string
Type of payment (EXTERNAL or INTERNAL)
object

Status Codes

Approval Status Values: Possible values for approvalStatus filter include: “Approved”, “Declined”, “Pending”, “Waiting”, “Waiting for Sender Approval”
Direction: The “direction” field makes it easy to identify whether a payment is incoming to your agent (received) or outgoing from your agent (sent).