List all balances

List all balances. Specify date time to list balances for that time that appear in the response.

Notes:
It takes a maximum of three hours for balances to appear in the list balances call.
This call lists balances upto the previous three years.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

FlowClient CredentialsToken URLhttps://api-m.paypal.com/v1/oauth2/tokenInheader

Scopes

List Balanceshttps://uri.paypal.com/services/reporting/balances/read

Query Parameters

as_of_time?string

List balances in the response at the date time provided, will return the last refreshed balance in the system when not provided.

Match

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Length20 <= length <= 64

currency_code?string

Filters the transactions in the response by a three-character ISO-4217 currency code for the PayPal transaction currency.

Length3 <= length <= 3

To switch between the new (ISO standard) and old date time format and the platform changes, include PayPal-Enforce-ISO8601-Format in the header. When this value is set to true, the APIs will support the new date time format and platform changes.Note: You can use the same header in the sandbox as well.

Default"false"

Response Body

`application/json`

curl -X GET "https://api-m.paypal.com/v1/reporting/v1/reporting/balances"

{
  "balances": [
    {
      "currency": "str",
      "primary": true,
      "total_balance": {
        "currency_code": "str",
        "value": "string"
      },
      "available_balance": {
        "currency_code": "str",
        "value": "string"
      },
      "withheld_balance": {
        "currency_code": "str",
        "value": "string"
      }
    }
  ],
  "account_id": "stringstrings",
  "as_of_time": "stringstringstringst",
  "last_refresh_time": "stringstringstringst"
}

{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "debug_id": "string",
  "links": []
}

{
  "name": "NOT_AUTHORIZED",
  "message": "Authorization failed due to insufficient permissions.",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "debug_id": "string",
  "links": []
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred.",
  "debug_id": "90957fca61718",
  "links": [
    {
      "href": "https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR",
      "rel": "information_link"
    }
  ]
}

{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "debug_id": "string",
  "links": []
}

Query Parameters

as_of_time?string

List balances in the response at the date time provided, will return the last refreshed balance in the system when not provided.

Match

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Length20 <= length <= 64

currency_code?string

Filters the transactions in the response by a three-character ISO-4217 currency code for the PayPal transaction currency.

Length3 <= length <= 3

Header Parameters

PayPal-Enforce-ISO8601-Format?boolean

Default"false"

{ "balances": [ { "currency": "str", "primary": true, "total_balance": { "currency_code": "str", "value": "string" }, "available_balance": { "currency_code": "str", "value": "string" }, "withheld_balance": { "currency_code": "str", "value": "string" } } ], "account_id": "stringstrings", "as_of_time": "stringstringstringst", "last_refresh_time": "stringstringstringst" }

{ "name": "INVALID_REQUEST", "message": "Request is not well-formed, syntactically incorrect, or violates schema.", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string" } ], "debug_id": "string", "links": [] }

{ "name": "NOT_AUTHORIZED", "message": "Authorization failed due to insufficient permissions.", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string" } ], "debug_id": "string", "links": [] }

{ "name": "INTERNAL_SERVER_ERROR", "message": "An internal server error occurred.", "debug_id": "90957fca61718", "links": [ { "href": "https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR", "rel": "information_link" } ] }

List all balances

200application/json

400application/json

403application/json

500application/json

defaultapplication/json

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

List all balances

200application/json

400application/json

403application/json

500application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`