Skip to main content

PaymentMethod

Representation of a paymentmethod

type PaymentMethod {
id: Int!
name: [LocalizedString!]!
description: PaymentMethodDescription
provider: String
media: Media
active: Boolean!
price: MonetaryValue!
erpReference: String
integrated: Boolean!
}

Fields​

id ● Int!​

Internal id of the payment method

name ● [LocalizedString!]!​

The names in display languages

description ● PaymentMethodDescription​

Text blocks regarding the payment method

provider ● String​

The payment service provider connected to the payment method

media ● Media​

Payment method media

active ● Boolean!​

Indicates if the payment method is active or not

price ● MonetaryValue!​

Price of the payment method

erpReference ● String​

Reference number used by ERP

integrated ● Boolean!​

Indicates if the payment method is rendered as a iframe or not

Example​

{
"name": [
{
"language": "EN",
"value": "String"
}
],
"description": {},
"media": {
"link": [
{
"alternateUrls": [
{}
],
"redirect": {}
}
],
"modifiedAt": "2024-05-03T11:52:33Z"
},
"price": {
"currency": {
"code": "USD",
"rate": 11.355,
"prefix": "$"
},
"tax": {}
}
}