Questions? Feedback? powered by Olark live chat software

API Guide :: Listing Partner Transactions

Listing Partner Transactions

As a partner, you can list all of the transactions that you are involved in. Simply call the /2017-09-01/partner/transactions endpoint. By default, this will return a list of all your transactions.

However, if you want to be more specific with your query, you may add the following optional parameters for optimization:

Parameters

NameTypeDescription
limitintegerThe amount of transactions you want to fetch.
next_cursorintegerThe start point of the transactions to be fetched.
sort_directionstringSorting direction by transaction IDs.
Either ascor desc. Default: desc
statusstringFilters the transactions by status.
Either ongoingor completed.
idsarray of
integers		Filters transactions which has the given ids.
customer_idsarray of
integers		Filters transactions that involves the given customer ids.
min_amountfloatFilters transactions greater than or equal to the min_amount.
max_amountfloatFilters transactions less than or equal to the max_amount.
initiation_start_datedatetimeFilters transactions created since the given start_date (inclusive).
Follows the ISO 8601 format: YYYY-MM-DDThh:mm:ss.sTZD
initiation_end_datedatetimeFilters transactions created before the given initiation_end_date (inclusive).
Follows the ISO 8601 format: YYYY-MM-DDThh:mm:ss.sTZD
1
2
3
curl "https://api.escrow.com/2017-09-01/partner/transactions" \
    -X GET \
    -u "email-address:your-api-key"

Example Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
{
    "limit": null,
    "next_cursor": null,
    "sort_by": "id",
    "sort_direction": "desc",
    "transactions": [{
        "close_date": null,
        "creation_date": "2019-05-09T07:49:48.532617+00:00",
        "currency": "usd",
        "description": "The sale of johnwick.com",
        "id": 3300003,
        "items": [
            {
              "description": "johnwick.com",
              "extra_attributes": {
                  "concierge": false,
                  "with_content": false
              },
              "fees": [
                {
                  "amount": "16.25",
                  "amount_without_taxes": "16.25",
                  "payer_customer": "[email protected]",
                  "split": "0.5",
                  "type": "escrow"
                },
                {
                  "amount": "16.25",
                  "amount_without_taxes": "16.25",
                  "payer_customer": "[email protected]",
                  "split": "0.5",
                  "type": "escrow"
                }
              ],
              "id": 3870000,
              "inspection_period": 259200,
              "quantity": 1,
              "schedule": [
                {
                    "amount": "1000.00",
                    "beneficiary_customer": "[email protected]",
                    "payer_customer": "[email protected]",
                    "status": {
                        "disbursed_to_beneficiary": false,
                        "secured": false
                    }
                }
              ],
              "status": {
                  "accepted": false,
                  "accepted_returned": false,
                  "canceled": false,
                  "in_dispute": false,
                  "received": false,
                  "received_returned": false,
                  "rejected": false,
                  "rejected_returned": false,
                  "shipped": false,
                  "shipped_returned": false
              },
              "title": "johnwick.com",
              "type": "domain_name",
            }
        ],
        "parties": [
            {
                "agreed": true,
                "customer": "[email protected]",
                "role": "buyer",
                "id": 900000,
                "initiator": false,
                "role": "buyer"
            },
            {
                "agreed": true,
                "customer": "[email protected]",
                "disbursement_method_selected": false,
                "id": 900001,
                "initiator": true,
                "role": "seller"
            },
            {
                "agreed": true,
                "customer": "[email protected]",
                "id": 900002,
                "role": "partner"
            }
        ]
    }]
}