How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GetPaid Accounts API

Getpaid accounts created for sellers so they can start accepting payments and receiving payouts.

GetPaid Accounts API is one of 6 APIs that GetPaid publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 2 operations across 2 paths, and defines 31 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against 2 base URLs: https://api.getpaid.io, https://api.sandbox.getpaid.io.

2 operations 2 paths 31 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.getpaid.io
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

GetPaid Accounts API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth) using the clientCredentials flow, exposing 4 scopes.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Accounts 2

Getpaid accounts created for sellers so they can start accepting payments and receiving payouts.

POST
/v2/accounts/query
Query accounts
query_accounts 1 param body → 200400401422429500
GET
/v2/accounts/{account_id}/themes
Get account themes
get_account_themes 1 param → 200400401404429500

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are AccountTheme (6 properties), BaseQueryRequest (5 properties), AccountThemeSettings (5 properties), ThemeColorSettings (4 properties). Each schema is shown below with its type and property counts.

QueryAccountsRequest
PaginationData
array
The list of queried elements.
AccountId
AccountsFiltersRequest
object
Filtering accounts.
3 properties
MediumString
string
PaginationFirst
integer
Pagination. The number of elements that will be retrieved.
ThemeId
Country
string
The two-letter [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO3166-1alpha-2).
AccountLegalName
DateTime
string
UTC timestamp in ISO 8601 format with milliseconds ([RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)). Always includes the 'Z' UTC indicator.
AccountThemeSettings
object
5 properties 3 required
PaginatedResponse
object
2 properties 1 required
ThemeAsset
object
3 properties 3 required
BaseQueryRequest
object
5 properties
ThemeBusinessSettings
object
2 properties 1 required
CreatedAt
UpdatedAt
PaginationCursor
string
The cursor to the last item. If non-empty, can be used to fetch the next page. If not set, there is no more elements.
ThemeFontSettings
object
3 properties
PaginationAfter
string
Pagination. The cursor from next page will be retrieved.
AccountTheme
object
6 properties 6 required
ThemeColorSettings
object
4 properties 2 required
AccountsSortsRequest
array
Fields to sort the data by. If not set, the data will be sorted by the creation date descending.
Id
string
BaseSortItemRequest
object
Each field to sort by.
2 properties 2 required
GetThemesResponse
object
1 property 1 required
ProblemDetailsBase
object
The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)].
4 properties 3 required
Url
string
DocumentId
BaseSortsRequest
array
Fields to sort the data by. If not set, the data will be sorted by the creation date descending.
QueryAccountsResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

getpaid-accounts-api-openapi.yml Raw ↑

Other APIs GetPaid publishes across the network.

GetPaid Applications API
GetPaid Authentication API
GetPaid Checkouts API
GetPaid Payments API
GetPaid Queries API
Where this information came from

This is an independent, third-party profile of GetPaid Accounts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.