Queries and mutations for managing Payment Methods in the platform.
Queries
Query Payment Methods
| Arguments | |
|---|---|
whereString | |
sortArray of String | |
limitInt | |
offsetInt | |
Get Payment Method
| Arguments | |
|---|---|
idString | Queries with specified ID |
keyString | Queries with specified key |
Mutations
Create Payment Method
Update Payment Method
| Arguments | |
|---|---|
versionLong | |
actionsArray of PaymentMethodUpdateAction | |
idString | Queries with specified ID |
keyString | Queries with specified key |
Delete Payment Method
| Arguments | |
|---|---|
versionLong | |
personalDataErasureBoolean | Default: false |
idString | Queries with specified ID |
keyString | Queries with specified key |
Output types
PaymentMethod
keyString | User-defined unique identifier of the PaymentMethod. |
nameString | Name of the PaymentMethod. |
nameAllLocalesArray of LocalizedString | Name of the PaymentMethod. |
customer | Reference to a Customer associated with the PaymentMethod. If businessUnit is set, the Customer is an Associate of the Business Unit. |
customerRef | Reference to a Customer associated with the PaymentMethod. If businessUnit is set, the Customer is an Associate of the Business Unit. |
businessUnit | Reference to a BusinessUnit associated with the PaymentMethod. Only available for B2B-enabled Projects. |
businessUnitRef | Reference to a BusinessUnit associated with the PaymentMethod. Only available for B2B-enabled Projects. |
token | Tokenized representation of the PaymentMethod used by the payment interface. |
methodString | Payment Method used for the Payment—for example, a credit card or direct debit. |
paymentInterfaceString | Payment service that processes the Payment—for example, a PSP. |
interfaceAccountString | Account or instance of the payment interface when multiple accounts are used (per interface). |
paymentMethodStatus | Status of the PaymentMethod. Can beActive, or Inactive |
defaultBoolean | Indicates if the PaymentMethod is the default. The default applies per Customer, Business Unit, or the combination of both (Associate). |
custom | Custom Fields of the PaymentMethod. |
idString | Unique identifier of the PaymentMethod. |
versionLong | Current version of the PaymentMethod. |
createdAt | Date and time (UTC) the PaymentMethod was initially created. |
lastModifiedAt | Date and time (UTC) the PaymentMethod was last updated. |
createdBy | IDs and references that created the PaymentMethod. |
lastModifiedBy | IDs and references that last modified the PaymentMethod. |
PaymentMethodToken
valueString | Tokenized representation of the Payment Method. It is displayed in the following instances:
It is masked in the following instances:
|
PaymentMethodStatus
ActiveInactive
Payment Method Query Result
offsetInt | |
countInt | |
totalLong | |
existsBoolean | |
resultsArray of PaymentMethod |
Input types
PaymentMethodDraft
keyString | User-defined unique identifier for the PaymentMethod. |
nameArray of LocalizedStringItemInputType | Name of the PaymentMethod. |
customer | Reference to a Customer the PaymentMethod should belong to. If businessUnit is set, the Customer must be an Associate of the Business Unit. |
businessUnit | Reference to a BusinessUnit the PaymentMethod should belong to. Only available for B2B-enabled Projects. |
token | Tokenized representation of the PaymentMethod used by the payment interface. |
methodString | Payment method to use for the Payment—for example, a credit card or direct debit. |
paymentInterfaceString | Payment service that processes the Payment—for example, a PSP. |
interfaceAccountString | Account or instance of the payment interface when multiple accounts are used (per interface). |
paymentMethodStatus | Status of the PaymentMethod. Can beActive, or Inactive |
defaultBoolean | Whether the PaymentMethod should be the default. The default applies per Customer, Business Unit, or the combination of both (Associate). |
custom | Custom Fields for the PaymentMethod. |
PaymentMethodTokenDraft
valueString |
PaymentMethodStatus
ActiveInactive
PaymentMethodUpdateAction
setCustomField | |
setCustomType | |
setDefault | |
setInterfaceAccount | |
setKey | |
setMethod | |
setName | |
setPaymentInterface | |
setPaymentMethodStatus |
Update actions
Set Key
keyString | Value to set. If omitted, any existing value is removed. |
Set Name
nameArray of LocalizedStringItemInputType | Value to set. If omitted, any existing value is removed. |
Set Method
methodString | New payment method—for example, a credit card or direct debit. If omitted, any existing value is removed. |
Set Default
defaultBoolean | Value to set. |
Set PaymentMethodStatus
paymentMethodStatus | Can be Active, or Inactive |
PaymentMethodStatus
ActiveInactive
Set PaymentInterface
paymentInterfaceString | New payment service that processes the Payment—for example, a PSP. If omitted, any existing value is removed. |
Set InterfaceAccount
interfaceAccountString | New account or instance of the payment interface. If omitted, any existing value is removed. |
Set Custom Type
fieldsArray of CustomFieldInput | |
type | |
typeKeyString | |
typeIdString |
Set CustomField
nameString | Name of the Custom Field to add, update, or remove. |
valueString | If value is absent or null, this field will be removed if it exists.
Trying to remove a field that does not exist will fail with an InvalidOperation error.
If value is provided, it is set for the field defined by name. |