Get Transactions

To get your transactions, make a POST request to the following endpoint:

https://api.peach-in.com/v4/transactions/search

Request

Include your API key in the Authorization header of the request, as described in the Authorization section.

Response

A successful response to the get transactions endpoint will return the results in the JSON format. The response will include various details about the transactions and any associated details including pagination details.

POST https://api.peach-in.com/v4/transactions/search

Request Body

Name	Type	Description	Default
startDate	Date (Timestamp / ISO string )	Used to specify the start date for retrieving transactions	30 days ago
endDate	Date (Timestamp / ISO string )	Used to specify the end date for retrieving transactions	today
limit	number	The Maximum rows return is 1000	100
paginationKey	object	Used for pagination in scenarios where there are large sets of transaction data and the response needs to be split into multiple pages
campaignId	string	Used to filter out result by campaignId

Example Request Body

{
    "limit": 500,
    "startDate": 1704067200000,
    "endDate": 1715521698324
}

If the response includes a paginationKey, it indicates additional results are available. To retrieve the next set of results, include the paginationKey in your subsequent request.

Example Response

200: OK

{
    "results": [
    
        {
            "transactionId": "987726cb-dd6b-4bce-b6f0-4d47c3d7d452",
            "transactionDate": "2024-05-09T14:19:31.616Z",
            "receiptNumber": 105,
            "status": "processed",
            "paymentType": "cc",
            "amount": 66,
            "currency": "ILS",
            "firstName": "Edwin",
            "lastName": "Barrows",
            "displayName": "Edwin Barrows",
            "phoneNumber": "[phone]",
            "email": "[e-mail]",
            "category": "donation",
            "lastCC4Digits": "4242",
            "isCompleted": true,
            "isCancelled": false,
            "customProperties": {},
            "transactionType": "charge",
            "createdAt": "2024-05-09T14:19:47.643Z",
            "updatedAt": "2024-05-09T14:19:47.643Z",
            "internalComments": "",
            "receiptEmail": "[e-mail]",
            "sum": 66,
            "paymentMethod": "stripe",
            "receiptUrl": "https://resources.peach-in.com/orgs/23456/documents/קבלת תרומה..pdf",
            "receiptId": "94828b10-3a9a-48f7-9dd4-f697352f2030",
            "contactId": "e359e2e0-a00a-11ee-8abe-81159ab1da1f",
            "campaignId": "tTaB",
            "groupName": "the minionsns",
            "linkId": "yPLUJf8N2che",
            "agentId": "jDsg1Gen",
            "agentName": "Elon Musk"
        }
    ],
    "paginationKey": {
        "accountId": "SGrR",
        "transactionDate": 1715264371616,
        "transactionId": "987726cb-dd6b-4bce-b6f0-4d47c3d7d456"
    }
}