Questions? Feedback? powered by Olark live chat software

API Guide :: Disburse a transaction

Disbursing a transaction

Once the buyer has accepted the merchandise, the funds are ready to be disbursed to the seller. If the disbursement method has already been set by a customer for the given transaction, this will be done automatically. There are a number of different ways that the seller can request as a disbursement method. Customers residing in the USA can select to be disbursed via Electronic Check (ACH), or Wire Transfer. For international customers (residing outside of the USA), International Wire Transfer is only available available option at this present time.

Retrieving available disbursement methods

This endpoint will give a list of available disbursement methods for the transaction, and a list of saved disbursement method profiles that can be used. This endpoint can be called by the Seller (and Broker when applicable).

The objects inavailable_disbursement_methods will give the type of disbursement method, and the total disbursement amount for that method. Not all disbursement methods are available to all customers for all transactions.

The endpoint will also return a list of saved disbursement method profiles for the customer that can be used for the transaction.

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

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
{
  "available_disbursement_methods": [
    {
      "type": "wire_transfer",
      "total": 190.0
    },
    {
      "type": "ach",
      "total": 200.0
    }
  ],
  "saved_disbursement_methods": [
    {
      "id": 55523,
      "customer": "johnsmith@example.com",
      "type": "ach",
      "currency": "usd",
      "account_name": "John Smith",
      "account_type": "savings",
      "bank_aba_routing_number": "12345678",
      "bank_address": {
          "city": "San Francisco",
          "state": "CA"
      },
      "bank_account_number": "1929231",
      "bank_name": "Amazing Savings Bank of California"
    },
    {
      "id": 59912,
      "customer": "johnsmith@example.com",
      "type": "wire",
      "currency": "usd",
      "account_name": "John Smith",
      "bank_aba_routing_number": "2923031",
      "bank_account_number": "2303120",
      "bank_branch_number": "9292932",
      "bank_iban": "2929292",
      "bank_swift_code": "29292902",
      "international_routing_code": "2901011",
      "bank_name": "Amazing Savings Bank of California",
      "bank_address": {
        "line1": "380 Montgomery St",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "post_code": "292910"
      },
      "intermediary_bank": {
        "bank_aba_routing_number": "290303030",
        "bank_name": "Not-so-amazing Bank",
        "bank_address": {
          "line1": "310 Montgomery St",
          "city": "San Francisco",
          "state": "CA",
          "post_code": "292910"
        },
        "bank_swift_code": "199292",
        "bank_account_number": "202001",
      },
      "beneficiary_address": {
        "line1": "1829 West Lane",
        "line2": "Apartment 301020",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "post_code": "10203"
      }
    }
  ],
}

Setting a disbursement method on a transaction

We provide an endpoint to set the disbursement method for a given transaction. You can choose to set the disbursement method either by providing the ID of a saved disbursement method profile, or including the full details of a new disbursement method profile. Note that if the funds have already been disbursed, this will return an error.

When setting the disbursement method using an ID of a saved disbursement method profile, the endpoint will return an error if the saved disbursement method profile is not available or not applicable for the current transaction.

When setting the disbursement method by providing a new profile, only disbursement method types that are specified in the above available_disbursement_methods list will be allowed. All disbursement methods added using this endpoint will be saved for future use, and will appear in the saved_disbursement_methods list.

Using a saved disbursement ID

1
2
3
4
5
6
7
8
curl "https://api.escrow.com/2017-09-01/transaction/2020/disbursement_methods" \
    -X POST \
    -u "email-address:your-api-key" \
    -H "Content-Type: application/json" \
    -d '
{
  "id": "55912",
}'

Specifying the disbursement details

Disbursing via ACH

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
curl "https://api.escrow.com/2017-09-01/transaction/2020/disbursement_methods" \
    -X POST \
    -u "email-address:your-api-key" \
    -H "Content-Type: application/json" \
    -d '
{
    "type": "ach",
    "currency": "usd",
    "account_name": "John Smith",
    "account_type": "savings",
    "bank_aba_routing_number": "123456789",
    "bank_address": {
        "city": "San Francisco",
        "state": "CA"
    },
    "bank_account_number": "56789123",
    "bank_name": "Bank of Wyong"
}

Disbursing via wire transfer

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
curl "https://api.escrow.com/2017-09-01/transaction/2020/disbursement_methods" \
    -X POST \
    -u "email-address:your-api-key" \
    -H "Content-Type: application/json" \
    -d '
{
    "type": "wire_transfer",
    "currency": "usd",
    "account_name": "John Smith",
    "bank_aba_routing_number": "123456789",
    "bank_account_number": "2303120",
    "bank_branch_number": "9292932",
    "bank_iban": "2929292",
    "bank_swift_code": "29292902",
    "international_routing_code": "2901011",
    "bank_name": "Amazing Savings Bank of California",
    "bank_address": {
        "line1": "380 Montgomery St",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "post_code": "292910"
    },
    "intermediary_bank": {
        "bank_aba_routing_number": "290303030",
        "bank_name": "Not-so-amazing Bank",
        "bank_address": {
            "line1": "310 Montgomery St",
            "city": "San Francisco",
            "state": "CA",
            "country": "US",
            "post_code": "292910"
        },
        "bank_swift_code": "199292",
        "bank_account_number": "202001"
    },
    "beneficiary_address": {
        "line1": "1829 West Lane",
        "line2": "Apartment 301020",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "post_code": "10203"
    }
}'