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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
GetPaid

GetPaid Applications API

Onboarding applications to collect the necessary information from sellers to create their Getpaid accounts and start accepting payments.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 5 operations across 5 paths, and defines 50 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.

5 operations 5 paths 50 schemas 1 GET4 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
Contact
support@getpaid.io
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 5

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

Applications 5

Onboarding applications to collect the necessary information from sellers to create their Getpaid accounts and start accepting payments.

POST
/v2/applications
Create an application
create_application 1 param body → 201400401422429500
GET
/v2/applications/{application_id}
Get an application
get_application 1 param → 200400401404429500
POST
/v2/applications/{application_id}/refresh
Refresh an application
refresh_application 2 params → 200400401404409422429500
POST
/v2/applications/{application_id}/cancel
Cancel an application
cancel_application 2 params → 200400401404409422429500
POST
/v2/applications/query
Query applications
query_applications 1 param body → 200400401422429500

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are GetApplicationResponse (10 properties), CreateApplicationResponse (8 properties), AddressOptionalFields (6 properties), BusinessResponse (5 properties). Each schema is shown below with its type and property counts.

Reference
ApplicantRequest
object
The details of the person representing the seller that is applying for the Getpaid account if known at the time of application creation.
3 properties 1 required
PaginationData
array
The list of queried elements.
AccountId
RefreshApplicationResponse
object
4 properties 4 required
MediumString
string
PaginationFirst
integer
Pagination. The number of elements that will be retrieved.
ChangeRequestApplicationRequest
ThemeId
Country
string
The two-letter [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO3166-1alpha-2).
ApplicationId
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.
PaginatedResponse
object
2 properties 1 required
QueryApplicationsRequest
Email
string
An email address.
ApplicationType
string
The type of application to create: - onboarding: to create a new account for the seller and start accepting payments. - changerequest: to update an existing se…
BaseRegistrationNumber
object
The company registration number.
2 properties 2 required
ApplicationsFiltersRequest
object
Filtering onboarding applications.
5 properties
BaseQueryRequest
object
5 properties
CreateApplicationRequest
Address
BusinessRequest
object
The seller business details if known at the time of application creation.
5 properties 2 required
ApplicantResponse
object
The details of the person representing the seller that applied for the Getpaid account if known at the time of application retrieval.
3 properties 1 required
UpdatedAt
CreatedAt
ApplicationStatus
string
The status of the onboarding application.
GermanRegistrationNumber
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.
OnboardingApplicationRequest
QueryApplicationsResponse
PaginationAfter
string
Pagination. The cursor from next page will be retrieved.
GetApplicationResponse
object
10 properties 6 required
RegistrationNumber
The business' registration number. The registration number is validated based on the country of the business.
AddressOptionalFields
object
6 properties
Id
string
BusinessResponse
object
The seller business details if known at the time of application retrieval.
5 properties 2 required
ApplicationExpiresAt
ApplicationWebhooksRequest
object
Configuration for webhooks to receive onboarding application status updates.
1 property 1 required
ShortString
string
BaseSortItemRequest
object
Each field to sort by.
2 properties 2 required
ApplicationFlow
object
The flow required for the onboarding application to complete.
1 property 1 required
ProblemDetailsBase
object
The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)].
4 properties 3 required
Url
string
BaseCreateApplicationRequest
object
2 properties 1 required
BusinessLegalStructure
string
The legal structure of the business. It is required to provide the legal structure of the business if the country of registration is Canada (CA).
BaseSortsRequest
array
Fields to sort the data by. If not set, the data will be sorted by the creation date descending.
ApplicationsSortsRequest
array
Fields to sort the data by. If not set, the data will be sorted by the creation date descending.
CreateApplicationResponse
object
8 properties 8 required
ApplicationFieldRequest
object
A field whose access for the seller is controlled by the change request application.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

getpaid-applications-api-openapi.yml Raw ↑

Other APIs GetPaid publishes across the network.

GetPaid Accounts API
AE Profile APIs.io
GetPaid Authentication API
AE Profile APIs.io
GetPaid Checkouts API
AE Profile APIs.io
GetPaid Payments API
AE Profile APIs.io
GetPaid Queries API
AE Profile APIs.io
#Application
← Back to G APIs
API Details
ID
getpaid:getpaid-applications-api
Base URL
https://api.getpaid.io
Docs
https://docs.getpaid.io/api
Provider
GetPaid
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=getpaid-applications-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/getpaid-applications-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of GetPaid Applications 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.