Questions? Feedback? powered by Olark live chat software

API Guide :: Retrieving transaction details

Retrieving transaction details

Retrieving information about a transaction is a simple get request, given that you have permission to view the transaction. You are only able to see the transaction if you are the buyer, seller, broker or the partner in the transaction.

Note

The information that is returned may be different depending on the user accessing the transaction. This can happen in multiple scenarios, such as the broker taking a broker commission that is not visible to the buyer or seller (or both). Another similar scenario is where the transaction has applicable partner fees.

Retrieve transaction by id

Use this approach to retrieve the details of a transaction by the Escrow.com transaction id.

1
2
3
4
curl "https://api.escrow.com/2017-09-01/transaction/29292" \
    -X GET \
    -u "email-address:your-api-key" \
    -H "Content-Type: application/json"

Retrieve transaction by reference

Use this approach to retrieve the details of a transaction by the key you use in your system to represent the given order, transaction, or relevant entity.

1
2
3
4
curl "https://api.escrow.com/2017-09-01/transaction/reference/xyz456" \
    -X GET \
    -u "email-address:your-api-key" \
    -H "Content-Type: application/json"

Example response

Whether you fetch a transaction by id or by reference, the same response will be returned.

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
{
  "id": 128900,
  "parties": [
      {
          "role": "buyer",
          "customer": "[email protected]",
          "agreed": true
      },
      {
          "role": "seller",
          "customer": "[email protected]",
          "agreed": false
      }
  ],
  "currency": "usd",
  "description": "The sale of martingroen.com",
  "items": [
      {
          "id": 2929101,
          "title": "martingroen.com",
          "description": "martingroen.com",
          "type": "domain name",
          "inspection_period": 259200,
          "quantity": 1,
          "schedule": [
              {
                  "amount": 1000.0,
                  "payer_customer": "[email protected]",
                  "beneficiary_customer": "[email protected]",
                  "status": {
                      "secured": false
                  }
              }
          ],
          "fees": [
              {
                  "type": "escrow",
                  "amount": "16.25",
                  "payer_customer": "[email protected]"
              },
              {
                  "type": "escrow",
                  "amount": "16.25",
                  "payer_customer": "[email protected]"
              }
          ],
          "status": {
              "received": false,
              "rejected_returned": false,
              "rejected": false,
              "received_returned": false,
              "shipped": false,
              "accepted": false,
              "shipped_returned": false,
              "accepted_returned": false,
              "canceled": false
          }
      }
  ]
}