Explore
Payment Service Swagger
0.7.0
OAS3
DEITY Landscape: Payment Service.
v1 will be deprecated on June, 1, 2023
Authorize
Client
POST
/api
/payment-methods
POST
/api
/payment-methods
/{provider}
/{method}
POST
/api
/stored-payment-methods
/storable-methods
Retrieve payment methods that are storable
POST
/api
/stored-payment-methods
/{shopCustomerId}
Retrieve stored payment methods matching the provided parameters
POST
/api
/stored-payment-methods
/{shopCustomerId}
/{provider}
/{storedMethodId}
Retrieve a single stored payment method
DELETE
/api
/stored-payment-methods
/{shopCustomerId}
/{provider}
/{storedMethodId}
Remove a stored payment method
POST
/api
/stored-payment-methods
/{shopCustomerId}
/{provider}
/{method}
/setup
POST
/api
/stored-payment-methods
/{shopCustomerId}
/{provider}
/{method}
/save
POST
/api
/payment
Create a new payment
POST
/api
/payment
/{shopOrderId}
Providing missing info
GET
/api
/order
/{shopOrderId}
Webhook
POST
/api
/payment
/webhook
/{organization}
/{project}
/{environment}
/adyen
POST
/api
/payment
/webhook
/{organization}
/{project}
/{environment}
/stripe
POST
/api
/payment
/webhook
/{organization}
/{project}
/{environment}
/mollie
POST
/api
/payment
/webhook
/{organization}
/{project}
/{environment}
/humm
Public
GET
/countries
Get available countries enum
GET
/currencies
Get available currencies enum
GET
/providers
/{provider}
/methods
GET
/providers
/{provider}
/methods
/{method}
GET
/providers
GET
/providers
/{provider}
GET
/v2
/countries
Get available countries enum
Management
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/customers
GET
/organizations
/{organization}
/projects
/{project}
/environments
POST
/organizations
/{organization}
/projects
/{project}
/environments
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
DELETE
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
Get available payment methods for the required environment
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
Add a payment method
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
Get a specific payment method for the required environment
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
Update a payment method
DELETE
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
Delete a payment method
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
/currencies
Get available currencies for the required environment
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
/countries
Get available countries configuration for the required environment
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
DELETE
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/humm
Create humm payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/humm
Update humm payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/adyen
Create adyen payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/adyen
Update adyen payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/stripe
Create stripe payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/stripe
Update stripe payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/mollie
Create mollie payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/mollie
Update mollie payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/sandbox
Create sandbox payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/sandbox
Update sandbox payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/wpay
Create wpay payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/wpay
Update wpay payment provider config
GET
/organizations
POST
/organizations
GET
/organizations
/{organization}
PUT
/organizations
/{organization}
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/order
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/order
/{id}
GET
/organizations
/{organization}
/projects
POST
/organizations
/{organization}
/projects
GET
/organizations
/{organization}
/projects
/{project}
PUT
/organizations
/{organization}
/projects
/{project}
DELETE
/organizations
/{organization}
/projects
/{project}
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/order
/{orderId}
/shipments
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/order
/{orderId}
/shipments
/{id}
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/transactions
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/transactions
/{id}
Environment
GET
/organizations
/{organization}
/projects
/{project}
/environments
POST
/organizations
/{organization}
/projects
/{project}
/environments
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
DELETE
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
Get available payment methods for the required environment
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
Add a payment method
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
Get a specific payment method for the required environment
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
Update a payment method
DELETE
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
Delete a payment method
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
/currencies
Get available currencies for the required environment
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
/countries
Get available countries configuration for the required environment
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
DELETE
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/humm
Create humm payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/humm
Update humm payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/adyen
Create adyen payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/adyen
Update adyen payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/stripe
Create stripe payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/stripe
Update stripe payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/mollie
Create mollie payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/mollie
Update mollie payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/sandbox
Create sandbox payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/sandbox
Update sandbox payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/wpay
Create wpay payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/wpay
Update wpay payment provider config
Payment Method
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
Get available payment methods for the required environment
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
Add a payment method
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
Get a specific payment method for the required environment
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
Update a payment method
DELETE
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
Delete a payment method
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
/currencies
Get available currencies for the required environment
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
/methods
/{method}
/countries
Get available countries configuration for the required environment
Payment Provider
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
DELETE
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/{provider}
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/humm
Create humm payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/humm
Update humm payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/adyen
Create adyen payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/adyen
Update adyen payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/stripe
Create stripe payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/stripe
Update stripe payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/mollie
Create mollie payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/mollie
Update mollie payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/sandbox
Create sandbox payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/sandbox
Update sandbox payment provider config
POST
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/wpay
Create wpay payment provider config
PUT
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/providers
/wpay
Update wpay payment provider config
Organization
GET
/organizations
POST
/organizations
GET
/organizations
/{organization}
PUT
/organizations
/{organization}
Order
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/order
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/order
/{id}
Project
GET
/organizations
/{organization}
/projects
POST
/organizations
/{organization}
/projects
GET
/organizations
/{organization}
/projects
/{project}
PUT
/organizations
/{organization}
/projects
/{project}
DELETE
/organizations
/{organization}
/projects
/{project}
Shipment
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/order
/{orderId}
/shipments
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/order
/{orderId}
/shipments
/{id}
Transaction
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/transactions
GET
/organizations
/{organization}
/projects
/{project}
/environments
/{environment}
/transactions
/{id}
v2
GET
/v2
/countries
Get available countries enum
Schemas
Currency
Country
GetPaymentMethodsDTO
PaymentProviderType
SurchargeModel
PaymentMethodInstanceModel
ErrorResponse
GetPaymentMethodDTO
GetStorablePaymentMethodsDto
StorablePaymentMethodInstanceModel
GetStoredPaymentMethodsDTO
CreditCardPaymentDataResultModel
BankBasedPaymentDataResultModel
StoredPaymentMethodFpxDetailsModel
GiftCardPaymentDataResultModel
PayPalPaymentDataResultModel
StoredPaymentMethodInstanceModel
GetStoredPaymentMethodDTO
CreatePaymentAddress
PaymentMethodSetupModel
SaveStoredMethodWpayPayload
SaveStorePaymentMethodDTO
PaymentValidationResultType
CreatePaymentCompleteResultModel
CreatePaymentIncompleteResultModel
CreatePaymentFailedResultModel
CreatePaymentResultIntermediateStepFields
CreatePaymentResultIntermediateStep
CreatePaymentRedirectResultModel
StripeExtraPaymentData
MollieExtraPaymentData
AdyenExtraPaymentData
CreatePaymentDiscount
CreatePaymentTotals
CreatePaymentProduct
CreatePaymentDetails
CreatePaymentOptions
CreatePaymentInfo
CreatePaymentDTO
MollieWebhookBody
OrderItemModel
OrderModel
CustomerMappingDTO
AmqpEnvironmentCredentials
EnvironmentModel
CreateEnvironmentDTO
EnvironmentIdModel
UpdateEnvironmentDTO
EnvironmentPaymentMethodConfigSortOrder
EnvironmentPaymentMethodConfigSurchargeFixed
EnvironmentPaymentMethodConfigSurcharge
EnvironmentPaymentMethodConfigMinMaxAmount
CreateEnvironmentPaymentMethodConfig
EnvironmentPaymentMethodModel
UpdateEnvironmentPaymentMethodConfig
UpdateEnvironmentPaymentMethodDto
CreateEnvironmentPaymentMethodDto
EnvironmentPaymentProviderModel
CreateHummConfig
CreateHummConfigDTO
UpdateHummConfig
UpdateHummConfigDTO
CreateAdyenConfig
CreateAdyenConfigDTO
UpdateAdyenConfig
UpdateAdyenConfigDTO
CreateStripeConfig
CreateStripeConfigDTO
UpdateStripeConfig
UpdateStripeConfigDTO
CreateMollieConfig
CreateMollieConfigDTO
UpdateMollieConfig
UpdateMollieConfigDTO
CreateSandboxConfig
CreateSandboxConfigDTO
UpdateSandboxConfig
UpdateSandboxConfigDTO
CreateWpayConfig
CreateWpayConfigDTO
UpdateWpayConfig
UpdateWpayConfigDTO
OrganizationModel
CreateOrganizationDTO
OrganizationIdModel
UpdateOrganizationDTO
PaymentMethodConfigModel
PaymentMethodModel
PaymentProviderConfigModel
PaymentProviderModel
ProjectModel
CreateProjectDTO
ProjectIdModel
UpdateProjectDTO
ShipmentItemModel
ShipmentTrackingModel
ShipmentModel
