WePay logo
      Nothing Found

Get a collection of accounts

get/accounts

The GET /accounts call allows your platform to look up a collection of accounts. The accounts resource allows your platform to create a new merchant account for each distinct business purpose.

SecurityappIdAuth and appTokenAuth
Request
query Parameters
page
string

Return elements from this page.

page_size
integer [ 1 .. 50 ]
Default: 10

Return no more than this many elements per page. If not specified, page_size defaults to 10. Maximum value allowed is 50.

create_time_start
integer <int64> >= 0

The timestamp (in UNIX seconds) for the start of the search window.

create_time_end
integer <int64> >= 0

The timestamp (in UNIX seconds) for the end of the search window.

owner_id
string [ 1 .. 255 ] characters

The ID of the legal entity you want to lookup accounts for.

beneficiary_legal_entity_id
string [ 1 .. 255 ] characters

Filter search window by elements that match the account's beneficiary legal entity.

reference_id
string

Return elements having this reference_id.

header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
required
Array of objects unique

An array of account objects.

next
required
string or null

An opaque path for the next page of results. Perform an HTTP GET to obtain the next page.

previous
required
string or null

An opaque path for the previous page of results. Perform an HTTP GET to obtain the previous page.

api_version
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "next": "/accounts?page=AQQHAAEX8yf1HDkrXqO7R-wy2joNU6ooRNCyDb-sSbbvR-8J6jKeFgpqprcIsuEnBh4fqImpR2eYjKIgSCirw2mhEFR7m5AsSj1OkG9emNFWhXQvreOczuQU7UzZ",
  • "previous": null,
  • "api_version": "3.0",
  • "results": [
    • {
      • "balances": {
        • "currencies": {
          • "USD": {
            • "balance": 100000,
            • "incoming_pending": 5000,
            • "outgoing_pending": 21200,
            • "reserve": 10000
            }
          }
        },
      • "beneficiary": {
        • "id": "3cd20b3c-4008-400b-b708-2b844ce7be84",
        • "path": "/legal_entities/3cd20b3c-4008-400b-b708-2b844ce7be84",
        • "resource": "legal_entities"
        },
      • "create_time": 1480700534,
      • "api_version": "3.0",
      • "custom_data": null,
      • "description": "Foo Bar Shop on 5th ave.",
      • "enhanced_review": "not_requested",
      • "id": "d3f61e56-5d99-4895-af2d-a07ab48476e9",
      • "incoming_payments": {
        • "accepted_methods": [
          • "payment_bank",
          • "mastercard",
          • "visa",
          • "amex"
          ]
        },
      • "industry": {
        • "category_detail": "Website design",
        • "merchant_category_code": "7333"
        },
      • "name": "Foo Bar Shop",
      • "owner": {
        • "id": "3cd20b3c-4008-400b-b708-2b844ce7be84",
        • "path": "/legal_entities/3cd20b3c-4008-400b-b708-2b844ce7be84",
        • "resource": "legal_entities"
        },
      • "path": "/accounts/d3f61e56-5d99-4895-af2d-a07ab48476e9",
      • "payout": {
        • "currencies": {
          • "USD": {
            • "next_payout_time": 14987382982,
            • "payout_method_id": "0102b1c6-2bc7-448a-aa1d-076b1637547c",
            • "period": "daily"
            }
          },
        • "default_currency": "USD"
        },
      • "pricing": {
        • "currencies": {
          • "USD": {
            • "credit_card": null,
            • "payment_bank": null
            }
          }
        },
      • "reference_id": null,
      • "resource": "accounts",
      • "statement_description": "Foo Bar Shop",
      • "platform_onboarding_time": null,
      • "projected_monthly_transaction_volume": 500,
      • "documents": [
        • {
          • "id": "163ae7cc-8d8c-482c-9363-563ce98fc8cd",
          • "type": "fee_disclosure",
          • "create_time": 1582224007,
          • "resource": "documents",
          • "owner": {
            • "id": "d3f61e56-5d99-4895-af2d-a07ab48476e9",
            • "resource": "accounts",
            • "path": "/accounts/d3f61e56-5d99-4895-af2d-a07ab48476e9"
            },
          • "path": null,
          • "reject_reason": null,
          • "status": null
          }
        ]
      }
    ]
}