List Transactions

The “List Transactions” API allows to retrieve a paginated list of transactions. Customize your results by filtering transactions based on name, alt type, transaction status, payment mode, date range, type of source, contact, subscription id, entity id or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve transaction information.

GET https://services.leadconnectorhq.com/payments/transactions

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Query parameters

string

default:"3SwdhCu3svxI8AKsPJt6"

LocationId is the id of the account.

string

default:"3SwdhCu3svxI8AKsPJt6"

required

AltId is the unique identifier e.g: account id.

string

default:"account"

required

AltType is the type of identifier.

string

default:"live"

Mode of payment.

string

default:"2024-02-01"

Starting interval of transactions.

string

default:"2024-02-13"

Closing interval of transactions.

string

default:"funnel"

Source of the transactions.

string

default:"two_step_order_form"

Source sub-type of the transactions.

string

default:"Awesome transaction"

The name of the transaction for searching.

string

default:"sub_1KGcXDCScnf89tZoVkoEMCEL"

Subscription id for filtering of transactions.

string

default:"61dd0fe9c077f73e67f78803"

Entity id for filtering of transactions.

string

default:"XPLSw2SVagl12LMDeTmQ"

Contact id for filtering of transactions.

number

default:"20"

The maximum number of items to be included in a single page of results

number

default:"0"

The starting index of the page, indicating the position from which the results should be retrieved.

Respuestas

200 - Successful response

object[]

required

An array of transactions

Show cada item

string

default:"61dd0feac077f72010f78804"

required

The unique identifier for the transaction.

string

default:"3SwdhCu3svxI8AKsPJt6"

required

AltId is the unique identifier eg: account id.

string

default:"account"

required

AltType is the type of identifier.

string

default:"XPLSw2SVagl12LMDeTmQ"

Contact id corresponding to the transaction.

string

default:"XPLSw2SVagl12LMDeTmQ"

ID of the contact that was merged from.

string

default:"James Bond"

Contact name corresponding to the transaction.

string

default:"james.bond@leadwaycrm.com"

Contact email corresponding to the transaction.

string

default:"USD"

Currency in which transaction occurred.

number

default:"100"

Transaction value.

object

default:"succeeded"

required

The status of the transaction (e.g., succeeded).

boolean

default:"false"

Transaction is in live / test mode.

string

default:"order"

Entity type of transaction (eg: order).

string

default:"61dd0fe9c077f73e67f78803"

Entity id for the transaction. e.g: order id

string

default:"funnel"

required

Entity source type of transaction (eg: funnel).

string

default:"two_step_order_form"

Entity source sub-type of the transactions.

string

default:"new funnel"

Entity source name for the transaction.

string

default:"BDBMEghdIUaqMPEsK349"

Entity source id for the transaction.

object

Meta content for the entity source of transaction.

string

default:"sub_1KGcXDCScnf89tZoVkoEMCEL"

Subscription id for transaction.

string

default:"in_1KGcXDCScnf89tZohCsmImwE"

Charge id for transaction.

object

Charge snapshot of transaction.

string

default:"stripe"

Payment provider for transaction.

string

default:"612ca676b484b241fef9d962"

Payment provider account id for transaction.

string

default:"107.178.194.224"

Ip address from where transaction was initiated.

string

default:"2023-11-20T10:23:36.515Z"

required

The creation timestamp of the transaction.

string

default:"2023-11-20T10:23:36.515Z"

required

The update timestamp of the transaction.

number

default:"10"

Transaction amount refunded.

object

Transaction payment method details.

string

default:"2023-11-20T10:27:36.515Z"

required

The charged timestamp of the transaction.

string

default:"user123"

User ID who created the transaction.

number

required

total transactions count

{
  "data": [
    {
      "_id": "61dd0feac077f72010f78804",
      "altId": "3SwdhCu3svxI8AKsPJt6",
      "altType": "account",
      "contactId": "XPLSw2SVagl12LMDeTmQ",
      "mergedFromContactId": "XPLSw2SVagl12LMDeTmQ",
      "contactName": "James Bond",
      "contactEmail": "james.bond@leadwaycrm.com",
      "currency": "USD",
      "amount": "100",
      "status": "succeeded",
      "liveMode": "false",
      "entityType": "order",
      "entityId": "61dd0fe9c077f73e67f78803",
      "entitySourceType": "funnel",
      "entitySourceSubType": "two_step_order_form",
      "entitySourceName": "new funnel",
      "entitySourceId": "BDBMEghdIUaqMPEsK349",
      "entitySourceMeta": "{ domain: \"app.leadwaycrm.com\", pageId:  \"rBVhyYhMsbxbO8ZqOcei\", pageUrl:  \"/v2/preview/rBVhyYhMsbxbO8ZqOcei\", stepId:   \"5a772f62-3fbc-418b-af1b-be8929dd64c2\"}",
      "subscriptionId": "sub_1KGcXDCScnf89tZoVkoEMCEL",
      "chargeId": "in_1KGcXDCScnf89tZohCsmImwE",
      "chargeSnapshot": "{ id: \"in_1KGcXDCScnf89tZohCsmImwE\", object: \"invoice\", account_country: \"US\",  account_name:  \"GHL-Testing\" }",
      "paymentProviderType": "stripe",
      "paymentProviderConnectedAccount": "612ca676b484b241fef9d962",
      "ipAddress": "107.178.194.224",
      "createdAt": "2023-11-20T10:23:36.515Z",
      "updatedAt": "2023-11-20T10:23:36.515Z",
      "amountRefunded": "10",
      "paymentMethod": "{ card: { \"brand\": \"discover\", \"last4\": \"0012\" } }",
      "fulfilledAt": "2023-11-20T10:27:36.515Z",
      "createdBy": "user123"
    }
  ],
  "totalCount": 0
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/payments/transactions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

const response = await fetch('https://services.leadconnectorhq.com/payments/transactions', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
  },
});
const data = await response.json();

import os, requests
response = requests.request(
    'GET',
    'https://services.leadconnectorhq.com/payments/transactions',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/payments/transactions');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
    ],
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Autorización

Query parameters

Respuestas

Ejemplo

​Autorización

​Query parameters

​Respuestas

​Ejemplo

Autorización

Query parameters

Respuestas

Ejemplo