GetPaid Payments API is one of 6 APIs that GetPaid publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
4 operations
across 4 paths,
and defines 102 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.
SplitsCalculatedAndCalculatingFees
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
Version
string
A resource version.
DateTimeOffset
string
Date-time with time zone offset in ISO 8601 format without second fractions ([RFC 9557](https://www.rfc-editor.org/rfc/rfc9557.html)).
CreatePaymentRequest
object
7 properties
5 required
PaginationData
array
The list of queried elements.
PaymentMethodDetails
The payment method used.
PartialRefundPaymentResponse
AmountMinor
integer
The payment amount in the minor currency unit (e.g. 100 cents for 1 EUR).
CreatePaymentResponse
object
11 properties
8 required
PaymentWebhooksRequest
object
Configuration for webhooks to receive payment status updates.
1 property
1 required
PaymentCheckoutDescription
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.
PaymentMethodRequest
The payment method configuration for this payment.
BaseSortsRequest
array
Fields to sort the data by. If not set, the data will be sorted by the creation date descending.
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.
StatementDescriptorResponse
string
The final statement descriptor shown on the buyer statement. This value is calculated per payment method: - Cards: dynamicdescriptor with the GPD prefix. - SEP…
BaseRefundPaymentRequest
object
3 properties
2 required
Currency
string
The processing currency code according to the [ISO-4217 standard](https://en.wikipedia.org/wiki/ISO4217)
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
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…
PaymentMethodType
string
The type of payment method.
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.
PartialRefundPaymentRequest
ReasonBase
object
Reason of the status of the resource when it requires additional steps or is a failure state.
2 properties
2 required
SplitRemainingAmountCalculated
StandingInstructionDetails
object
The details of the standing instruction the payment is associated with.
4 properties
3 required
RefundOriginBase
object
1 property
1 required
BaseQueryRequest
object
5 properties
PaymentsSortsRequest
array
Fields to sort the data by. If not set, the data will be sorted by the creation date descending.
PaginationAfter
string
Pagination. The cursor from next page will be retrieved.
CardScheme
string
The card scheme.
BaseSortItemRequest
object
Each field to sort by.
2 properties
2 required
PaymentOrigin
The origin of the payment creation.
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
FullRefundPaymentResponse
PaginationFirst
integer
Pagination. The number of elements that will be retrieved.
StandingInstructionTerms
object
Terms for standing instructions of recurring payments.
1 property
1 required
BasePaymentMethodRequest
object
The payment method configuration for this payment.
1 property
1 required
PaymentOriginBase
object
1 property
1 required
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
RefundStatus
string
The status of the refund payment. See the [list, transitions, and description of each status](/payments/refunds/lifecycle) for more details.
GetPaymentResponse
object
18 properties
13 required
PaymentTotals
object
The payment totals summary to provide an overview of captured, refunded, refundable amounts and processing fees overall and per account associated with the pay…
6 properties
6 required
PaymentMethodHint
The payment method used.
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.
PaymentStatus
string
The status of the payment. See the [list, transitions, and description of each status](/payments/lifecycle) for more details.
PaymentRefunds
array
A list of refunds associated with the payment if any.
SubsequentStandingInstructionRequest
object
Standing instruction for recurring payments.
1 property
1 required
RefundType
string
The type of refund to be processed.
SplitsType
string
The type of payment split.
BaseRefundPaymentResponse
object
6 properties
6 required
PartyRef
object
A reference to a party account involved in the transaction.
3 properties
3 required
RefundSplitAccount
object
A refund split account.
2 properties
2 required
RefundOrigin
The origin of the refund creation.
PaymentAuthentication
object
Information about the authentication performed for the payment if any.
3 properties
2 required
PaymentsFiltersRequest
object
Filtering payments.
4 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs GetPaid publishes across the network.
