Balance Accounts Integration Guide

The Balance Accounts API enables PayPal partners to list the total available and total reserved account balances for a PayPal account for a customer.

Overview

A balance account is a PayPal account balance, or holdings, for a customer. PayPal customers can hold multiple currencies at any given point in time.

If a bank partners with PayPal, the bank can use this API to list a PayPal balance account for a customer.

Other types of partners, such as service providers, can use this API to display PayPal account information for customers who might want to simultaneously access their service and PayPal accounts.

Integration steps

Set up your development environment

Before you can integrate Balance Accounts, you must set up your development environment. After you get a token that lets you access protected REST API resources, you create sandbox accounts to test your web and mobile apps. For details, see Get started.

Then, return to this page to integrate Balance Accounts.

List PayPal balance accounts

To list PayPal balance accounts for a customer, include a bearer token in the Authorization: Bearer request header. A bearer token is an access token that the PayPal authorization server issues to the API caller with the approval of the resource owner. You can use a bearer token to complete an action on behalf of the resource owner.

This sample request uses a bearer token to list balance accounts for a customer:

1curl -v -X GET https://api-m.sandbox.paypal.com/v2/wallet/balance-accounts \
2  -H "Content-Type: application/json" \
3  -H "Authorization: Bearer <Access-Token>"

The response lists the balance accounts:

1{
2  "total_available": {
3    "currency_code": "USD",
4    "value": "2800"
5  },
6  "total_reserved": {
7    "currency_code": "USD",
8    "value": "1920"
9  },
10  "balance_accounts": [{
11    "available": {
12      "currency_code": "USD",
13      "value": "1000.00"
14    },
15    "reserved": {
16      "currency_code": "USD",
17      "value": "00.00"
18    },
19    "links": []
20  }, {
21    "available": {
22      "currency_code": "AUD",
23      "value": "1000"
24    },
25    "reserved": {
26      "currency_code": "AUD",
27      "value": "00.00"
28    }
29  }, {
30    "available": {
31      "currency_code": "CAD",
32      "value": "1000"
33    },
34    "reserved": {
35      "currency_code": "CAD",
36      "value": "100"
37    },
38    "links": []
39  }, {
40    "available": {
41      "currency_code": "GBP",
42      "value": "1000"
43    },
44    "reserved": {
45      "currency_code": "GBP",
46      "value": "1000"
47    },
48    "links": []
49  }],
50  "links": [{
51    "rel": "self",
52    "href": "https://api-m.sandbox.paypal.com/v2/wallets/balance-accounts"
53  }]
54}

The response includes:

• Summary

  The total available and reserved holdings in the customer's primary currency. To calculate the totals in the summary, the API uses the PayPal exchange rate to convert any balances held in other currencies to the customer's primary currency.

• List of balance accounts

  Each balance account in the list shows available and reserved holdings in the holding currency for the account.

Additional information

• Balance Accounts API Reference