Get an Account Statement

Download a monthly statement listing all transaction activity on the account for a given billing period.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Identifier type for the parent entity. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:
string
required

The customer's Passport-assigned ID or program manager-assigned external ID, based on the selected parentIdType.

string
enum
required

Identifier type for the entity. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:
string
required

The account's Passport-assigned ID or program manager-assigned external ID, based on the selected idType.

Body Params

Statement retrieval parameters including the billing period.

string
required

The month and year for which the account statement is to be downloaded. Format: mm/yyyy.

Headers
string
enum
required

Required. Set to NEVER for a synchronous response or ALWAYS for asynchronous processing.

Allowed:
Responses
202

The request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs. Expected for all requests with Promise Mode as ALWAYS.

204

The Passport server successfully processed the request and is not returning any content. This is expected for all updates, deletion requests on the resources.

299

The Passport server successfully processed the request i.e. the object has been created or modified as requested, however the action may have an impact on transacting which is notified in the warning.

400

The request could not be accepted by the Passport server due to a malformed syntax, which may be a missing required parameter or other syntactical error.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!
.readme-logo { display: none !important; }