Skip to main content
GET
/
transactions
/
{id}
Get a current-user billing transaction
curl --request GET \
  --url https://api.leadping.ai/transactions/{id}
{
  "accountId": "<string>",
  "accountName": "<string>",
  "businessId": "<string>",
  "businessName": "<string>",
  "leadId": "<string>",
  "leadName": "<string>",
  "amount": "<string>",
  "netAmount": "<string>",
  "gatewayFeeAmount": "<string>",
  "gatewayStatus": "<string>",
  "gatewayId": "<string>",
  "platformFeeAmount": "<string>",
  "notes": "<string>",
  "description": "<string>",
  "metadata": {},
  "paymentMethodDisplay": "<string>",
  "correlationId": "<string>",
  "createdBy": "<string>",
  "modifiedBy": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

id
string
required

The ID of the transaction to retrieve.

Response

Transaction was successfully retrieved.

API response containing transaction data returned to callers.

accountId
string

The account ID associated with this transaction.

accountName
string | null

The account name value for this transaction.

businessId
string | null

The business ID associated with this transaction.

businessName
string | null

The business name value for this transaction.

leadId
string

The lead ID associated with this transaction.

leadName
string | null

The lead name value for this transaction.

amount
string<double>

The monetary amount for this transaction.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
netAmount
string<double>

The monetary net amount for this transaction.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
gatewayFeeAmount
string<double> | null

The monetary gateway fee amount for this transaction.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
gatewayStatus
string | null

The current gateway status for this transaction.

gatewayId
string | null

The gateway ID associated with this transaction.

platformFeeAmount
string<double> | null

The monetary platform fee amount for this transaction.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
notes
string | null

The operator or customer notes recorded for this transaction.

description
string | null

The human-readable description of this transaction.

metadata
object

Provider and wallet audit metadata for this transaction.

paymentMethodDisplay
string | null

The payment method display value for this transaction.

transactionType
enum<string>

The transaction type classification for this transaction.

Available options:
Debit,
Adjustment,
Deposit
transactionStatus
enum<string>

The current transaction status for this transaction.

Available options:
Pending,
Confirmed,
Failed
correlationId
string | null

The correlation ID associated with this transaction.

createdBy
string

The date and time for the created by value on this transaction.

modifiedBy
string | null

The modified by value for this transaction.

id
string

The unique identifier for the entity.

createdAt
string<date-time>

The date and time when the entity was created.

modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.