GetPaid Checkouts API is one of 6 APIs that GetPaid publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Checkouts. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
3 operations
across 3 paths,
and defines 103 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.
The identity and technical contract details declared by the specification.
CheckoutInitiatedStarted
object
17 properties
16 required
PaginationData
array
The list of queried elements.
Version
string
A resource version.
CheckoutDefaultPaymentMethodsRequest
object
2 properties
1 required
PaymentMethodDetails
The payment method used.
AmountMinor
integer
The payment amount in the minor currency unit (e.g. 100 cents for 1 EUR).
Country
string
The two-letter [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO3166-1alpha-2).
PaymentWebhooksRequest
object
Configuration for webhooks to receive payment status updates.
1 property
1 required
SplitBaseAmount
object
The amount in payment currency to be allocated to this account. The sum of all split amounts for all accounts must be exactly the total amount of the payment o…
1 property
1 required
PaginatedResponse
object
2 properties
1 required
SplitRemainingAmountRequest
SplitPercentageAmountRequest
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.
CheckoutPayments
array
The payments initiated as part of this checkout.
CheckoutPaymentMethodsRequest
Configure payment methods for the checkout. - explicit: use available to provide the methods to display. - default: all available payment methods are selected…
PaymentMethodDescriptor
A payment method.
SplitsCalculated
object
The list of payment splits for the accounts involved in the funds flow. The final split gross amounts have been calculated but processing fees are not included…
2 properties
2 required
BaseSortsRequest
array
Fields to sort the data by. If not set, the data will be sorted by the creation date descending.
CheckoutCompleted
object
16 properties
15 required
CardDynamicDescriptor
string
The card dynamic descriptor. It will be prefixed with GPD when displayed on the buyer statement. You don't need to include the GPD prefix in the value sent.
CheckoutExplicitPaymentMethodsRequest
object
3 properties
2 required
PaymentStatusPhase
string
The phase of the payment, based on its status. - inprogress: The payment is being processed. - completed: The payment attempt completed successfully. - failed:…
QueryPaymentMethodHint
object
The payment method used in a checkout.
2 properties
1 required
SplitsRequest
object
The list of payment splits for the accounts involved in the funds flow. See [how splits work](/monetize/splits) for more information.
2 properties
2 required
Currency
string
The processing currency code according to the [ISO-4217 standard](https://en.wikipedia.org/wiki/ISO4217)
StandingInstructionStatus
string
The status of the standing instruction. - new: requested to creation as part of an initial payment. - active: standing instruction is active and can be used fo…
ThemeRef
object
2 properties
2 required
PaymentMethodType
string
The type of payment method.
CheckoutBuyerRequest
object
Buyer details to pre-fill during checkout. Required if the country of the seller account is Canada (CA).
6 properties
SplitPercentageAmountCalculated
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.
CardPaymentMethodDescriptor
Email
string
An email address.
SplitRemainingAmountCalculated
BaseQueryRequest
object
5 properties
CheckoutExpired
object
16 properties
15 required
PaginationAfter
string
Pagination. The cursor from next page will be retrieved.
CardScheme
string
The card scheme.
CheckoutPaymentMethodsWithSelected
BaseSortItemRequest
object
Each field to sort by.
2 properties
2 required
CheckoutPaymentMethodsResponse
object
The payment methods of this checkout.
2 properties
2 required
CheckoutOrigin
The origin of the checkout initiation.
SplitsAccountType
string
The type of account. Exactly one account of type platform and one of type seller are required and allowed per payment.
PaymentMethodBase
object
1 property
1 required
PaginationFirst
integer
Pagination. The number of elements that will be retrieved.
CheckoutPaymentMethodsOptions
object
Configuration options for the payment methods available in the checkout.
2 properties
BaseStandingInstruction
object
2 properties
2 required
StandingInstructionTerms
object
Terms for standing instructions of recurring payments.
1 property
1 required
CheckoutStatus
string
The status of the checkout. See the [list, transitions, and description of each status](/payments/checkoutslifecycle) for more details.
CreateCheckoutRequest
object
11 properties
6 required
CheckoutIsExpired
boolean
Indicates whether the checkout has expired. A checkout is considered expired when the current time has passed the expiresat timestamp.
ProcessingFeeRequest
object
The processing fee covered by this account. If not specified, the account will not cover any processing fee. The sum of all processing fees covered by all acco…
1 property
1 required
AddressOptionalFields
object
6 properties
CheckoutFailed
object
16 properties
15 required
CheckoutCardPaymentMethodOptions
object
Configuration options for card payment methods in the checkout.
1 property
1 required
CheckoutSepaDirectDebitPaymentMethodOptions
object
Configuration options for SEPA Direct Debit payment methods in the checkout.
1 property
1 required
ProblemDetailsBase
object
The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)].
4 properties
3 required
SellerRef
object
A reference to the seller account.
2 properties
2 required
SddRemittanceInfo
string
The SEPA Direct Debit remittance information shown on the buyer statement.
CheckoutsFiltersRequest
object
Filtering checkouts.
4 properties
CheckoutFlow
object
The flow required for the checkout to complete.
1 property
1 required
CreateCheckoutResponse
object
9 properties
9 required
CheckoutsSortsRequest
array
Fields to sort the data by. If not set, the data will be sorted by the creation date descending.
ActiveStandingInstruction
SplitsAndFeesCalculated
object
The list of payment splits for the accounts involved in the funds flow. The final split amounts and processing fees have been calculated.
2 properties
2 required
SplitsType
string
The type of payment split.
CheckoutInProgress
object
17 properties
16 required
PartyRef
object
A reference to a party account involved in the transaction.
3 properties
3 required
Index
integer
The index of the element in the list.
CheckoutOriginBase
object
1 property
1 required
CheckoutPaymentMethodsAvailable
object
The payment methods of this checkout.
3 properties
2 required
InitialStandingInstructionRequest
object
Terms for a new standing instruction to gather the consent in the initial payment in a series of recurring payments.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs GetPaid publishes across the network.
