Action: Retrieve payment transactions from lead

This will allow you to retrieve all payment transaction for a lead.

Type	Parameters	Values
POST	cmd*	retrieve_transactions_from_lead

* Required field
Here is an example:

'lead' => [
    'email' => 'example@email.com'
],
'actions' => [
    '0' => [
        'cmd' => 'retrieve_transactions_from_lead'
    ]
]

Here are the results returned by the request:

Parameters	Values
transaction_list	String (JSON encoded array containing the transactions for the lead, empty array if no transactions)

JSON parameters	Values
transaction_id	integer A unique numeric identifier for the transaction id.
lead_id	integer Id for the lead linked to the transaction.
lead_email	string Email of the lead at the moment of the transaction.
transaction_type	string The transaction type. Possible values: ‘sale’, ‘refund’, ‘failed’, ‘rebill’, ‘cancellation’, ‘chargeback’, ‘partial_refund’

Example of the returned JSON array:

{
    "retrieve_transactions_from_lead":{
        "transaction_list":[
            {
                "transaction_id":"48110",
                "lead_id":"4174086",
                "lead_email":"example@email.com",
                "transaction_type":"sale"
            },
            {
                "transaction_id":"48112",
                "lead_id":"4174086",
                "lead_email":"example@email.com",
                "transaction_type":"refund"
            },
        },
    }
}

Was this article helpful?

YesNo