Skip to main content
GET
Get Payment
Payment Details: Retrieves detailed information about a specific payment based on its ID. Converts short ID format to UUID format internally before querying the database.

Path Parameters

string
required
Payment ID (can be a short ID like payee_xxx)

Request Headers

string
required
Your API key for authentication

Response

string
Unique payment identifier
string
Name or description of the payment
string
Type of payment (EXTERNAL or INTERNAL)
string
ID of the agent sending the payment
string
ID of the agent receiving the payment
string
Current status of the payment
string
Approval status of the payment
boolean
Whether this payment requires approval
object
object
array
Tags or categories for the payment
string
Timestamp when the payment was created
string
Timestamp when the payment was approved

Status Codes

Payment Types: Use “EXTERNAL” for payments to recipients outside your agent network and “INTERNAL” for payments between your own agents.
Approval Flow: The approvedat field will be null if the payment has not yet been approved or declined.