GetMethodOfPayments

The GetMethodOfPayments call retrieves the payment methods. A payment method contains both a list with the active countries of delivery and a list with the active multishops.

This call is available since SOAP version 100.
This call is limited to 30 requests per day and user.

GetMethodOfPayments Input

Field Type Occurrence Meaning Available since
ActivMethodOfPayments Boolean Optional Returns only the active payment mehtods 105

GetMethodOfPayments Input schema

The box below lists all fields that could be included in the call request (version 112). To learn more about an individual field or its type, click its name in the box.

<PlentySoapRequest_GetMethodOfPayments> </PlentySoapRequest_GetMethodOfPayments>

GetMethodOfPayments Output

Field Type Occurrence Meaning Available since
MethodOfPayment ObjectOptional List of the payment methods 105
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
ActiveCountriesOfDelivery
ObjectOptional List of the active countries of delivery 105
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
ActiveCountriesOfDelivery.
PlentySoapObject_Integer.
intValue
Integer Optional Integer Value 105
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
CostDomesticFlatRateInternal
Double Optional Costs domestic flat rate internal 112
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
CostDomesticFlatRateWebshop
Double Optional Costs domestic flat rate webshop 112
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
CostDomesticPercentageInternal
Double Optional Costs domestic percentage internal 112
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
CostDomesticPercentageWebshop
Double Optional Costs domestic percentage webshop 112
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
CostDomesticShipping
Double Optional Costs domestic shipping 105
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
CostForeignFlatRateInternal
Double Optional Costs foreign flat rate internal 112
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
CostForeignFlatRateWebshop
Double Optional Costs foreign flat rate webshop 112
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
CostForeignPercentageInternal
Double Optional Costs foreign percentage internal 112
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
CostForeignPercentageWebshop
Double Optional Costs foreign percentage webshop 112
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
CostForeignShipping
Double Optional Costs foreign shipping 105
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
CostValueInPercentage
Integer Optional Costs in percent 105
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
MethodOfPaymentID
Integer Optional Payment Method ID 105
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
Multishops
ObjectOptional List of the active multishops 105
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
Multishops.
PlentySoapObject_Integer.
intValue
Integer Optional Integer Value 105
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
Name
String Optional Name of the payment method 105
MethodOfPayment.
PlentySoapObject_GetMethodOfPayments.
Priority
Integer Optional Priority 105
ResponseMessages ObjectOptional Returns a list of error messages for the current call. 112
ResponseMessages.
PlentySoapResponseMessage.
Code
Integer Optional Code 105
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
IdentificationKey
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
IdentificationValue
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
Success Boolean Optional Has the value true or false, depending on whether a request worked. 112

GetMethodOfPayments Output schema

The box below lists all fields that could be included in the response call (version 112). To learn more about an individual field or its type, click its name in the box.

<PlentySoapResponse_GetMethodOfPayments>
<Success>Boolean</Success>
</PlentySoapResponse_GetMethodOfPayments>

Identification Keys

For this call no identification keys and values exist.

Identification Output schema

For this call no identification output schema exists.

Success messages

(The dynamicValue stands for any parameter values that could be outputted.)

Code Key Value Message Explanation
100 - - - Payment methods were successfully retrieved

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 Unable to load MethodOfPayments Payment methods could not be loaded
810 maximum GetMethodOfPayments calls reached The maximum limit of 30 calls per day and user was exceeded.

Error messages Output schema

The box below lists all error message fields that could be outputted in the call response (version 112). To learn more about an individual field or its type, click its name in the box.

Warnings

Code Key Value Message Explanation
110 No data No data were found for the given parameter.

Warnings Output schema

The box below lists all warning fields that could be outputted in the call response (version 112). To learn more about an individual field or its type, click its name in the box.

Nach oben