List all balance and net activity summary

List all balance and net activity summary for each currency within a given date range.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

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

Scopes

Accounting Balance Net Summaryhttps://uri.paypal.com/services/reporting/dataapiserv/balance-net-activity/read

Query Parameters

from_date*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])$

Length10 <= length <= 10

to_date*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])$

Length10 <= length <= 10

locale*string

To get the locale of the client.

Match^[a-zA-Z]{2}[-|_][a-zA-Z]{2}$

Length5 <= length <= 10

Response Body

`application/json`

curl -X GET "https://api-m.paypal.com/v1/reporting/v1/reporting/get-balance-net-summary?from_date=stringstri&to_date=stringstri&locale=string"

{
  "last_refresh_date": "stringstri",
  "reconciliation_passed": "true",
  "balance_summary": {
    "columns": [
      "string"
    ],
    "data": [
      [
        "string"
      ]
    ]
  },
  "net_activity": {
    "currencies": [
      "string"
    ],
    "columns": [
      "string"
    ],
    "activities": [
      {
        "net_activity_sum": "string",
        "fee_sum": "string",
        "activity_details": [
          [
            "string"
          ]
        ]
      }
    ]
  }
}

{
  "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": "UNPROCESSABLE_ENTITY",
  "message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
  "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

from_date*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])$

Length10 <= length <= 10

to_date*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])$

Length10 <= length <= 10

locale*string

To get the locale of the client.

Match^[a-zA-Z]{2}[-|_][a-zA-Z]{2}$

Length5 <= length <= 10

{ "last_refresh_date": "stringstri", "reconciliation_passed": "true", "balance_summary": { "columns": [ "string" ], "data": [ [ "string" ] ] }, "net_activity": { "currencies": [ "string" ], "columns": [ "string" ], "activities": [ { "net_activity_sum": "string", "fee_sum": "string", "activity_details": [ [ "string" ] ] } ] } }

{ "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": "UNPROCESSABLE_ENTITY", "message": "The requested action could not be performed, semantically incorrect, or failed business validation.", "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 balance and net activity summary

Authorization

Query Parameters

Response Body

200application/json

400application/json

403application/json

422application/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 balance and net activity summary

Authorization

Query Parameters

Response Body

200application/json

400application/json

403application/json

422application/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`

`application/json`

`application/json`