POST Finance/PaymentMeans

Get all the PaymentMeans

Request Information

URI Parameters

None.

Body Parameters

BaseRequest
NameDescriptionTypeAdditional information
Lang

string

None.

StoreID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Lang": "sample string 1",
  "StoreID": 2
}

application/xml, text/xml

Sample:
<BaseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">
  <Lang>sample string 1</Lang>
  <StoreID>2</StoreID>
</BaseRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of PaymentMeans
NameDescriptionTypeAdditional information
ID

integer

None.

Name

string

None.

Description

string

None.

Disabled

date

None.

CountryID

This paymentMeans applies only to this country

integer

None.

MinimumOrderAmount

From this order amount, this payment means can be used

decimal number

None.

TaxRateID

integer

None.

Price

ComplexTypePrice

None.

Percent

decimal number

Range: inclusive between 0 and 1

ShippingTriggerID

The order status that triggers shipping orders to be created

integer

None.

ShippingOrderStatusID

Initial ShippingOrderStatus for newly created shipping orders

integer

None.

OrderConfirmNotificationTriggerID

The order status that triggers a confirm notification email to be sent

integer

None.

AllowedPaymentDueMinutes

The number of minutes allowed for this payment to be received when an Order is confirmed Stock reservation is also tight to this number

integer

None.

CashOnDelivery

goods must be paid for at the time of delivery

boolean

None.

QuickPayment

This payment means allows for 1-click payment.

boolean

None.

PrePayment

boolean

None.

BankTransfer

This is a bank transfer

boolean

None.

Bizum

boolean

None.

ApplePayGooglePay

boolean

None.

BankAccounts

Collection of StoreBankAccount

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "Disabled": "2025-12-06T09:18:53.8493415+01:00",
    "CountryID": 1,
    "MinimumOrderAmount": 1.0,
    "TaxRateID": 4,
    "Price": {
      "TaxPercent": 1.0,
      "EquivalenceSurchargePercent": 2.0,
      "Base": 3.0,
      "Tax": 4.0,
      "EquivalenceSurcharge": 5.0,
      "Amount": 6.0
    },
    "Percent": 5.0,
    "ShippingTriggerID": 6,
    "ShippingOrderStatusID": 7,
    "OrderConfirmNotificationTriggerID": 8,
    "AllowedPaymentDueMinutes": 9,
    "CashOnDelivery": true,
    "QuickPayment": true,
    "PrePayment": true,
    "BankTransfer": true,
    "Bizum": true,
    "ApplePayGooglePay": true,
    "BankAccounts": [
      {
        "ID": 1,
        "StoreID": 2,
        "Name": "sample string 3",
        "IBAN": "sample string 4",
        "Verified": true
      },
      {
        "ID": 1,
        "StoreID": 2,
        "Name": "sample string 3",
        "IBAN": "sample string 4",
        "Verified": true
      }
    ]
  },
  {
    "ID": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "Disabled": "2025-12-06T09:18:53.8493415+01:00",
    "CountryID": 1,
    "MinimumOrderAmount": 1.0,
    "TaxRateID": 4,
    "Price": {
      "TaxPercent": 1.0,
      "EquivalenceSurchargePercent": 2.0,
      "Base": 3.0,
      "Tax": 4.0,
      "EquivalenceSurcharge": 5.0,
      "Amount": 6.0
    },
    "Percent": 5.0,
    "ShippingTriggerID": 6,
    "ShippingOrderStatusID": 7,
    "OrderConfirmNotificationTriggerID": 8,
    "AllowedPaymentDueMinutes": 9,
    "CashOnDelivery": true,
    "QuickPayment": true,
    "PrePayment": true,
    "BankTransfer": true,
    "Bizum": true,
    "ApplePayGooglePay": true,
    "BankAccounts": [
      {
        "ID": 1,
        "StoreID": 2,
        "Name": "sample string 3",
        "IBAN": "sample string 4",
        "Verified": true
      },
      {
        "ID": 1,
        "StoreID": 2,
        "Name": "sample string 3",
        "IBAN": "sample string 4",
        "Verified": true
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfPaymentMeans xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Finance">
  <PaymentMeans>
    <AllowedPaymentDueMinutes>9</AllowedPaymentDueMinutes>
    <ApplePayGooglePay>true</ApplePayGooglePay>
    <BankAccounts>
      <StoreBankAccount>
        <IBAN>sample string 4</IBAN>
        <Name>sample string 3</Name>
        <Verified>true</Verified>
        <ID>1</ID>
        <StoreID>2</StoreID>
      </StoreBankAccount>
      <StoreBankAccount>
        <IBAN>sample string 4</IBAN>
        <Name>sample string 3</Name>
        <Verified>true</Verified>
        <ID>1</ID>
        <StoreID>2</StoreID>
      </StoreBankAccount>
    </BankAccounts>
    <BankTransfer>true</BankTransfer>
    <Bizum>true</Bizum>
    <CashOnDelivery>true</CashOnDelivery>
    <CountryID>1</CountryID>
    <Description>sample string 3</Description>
    <Disabled>2025-12-06T09:18:53.8493415+01:00</Disabled>
    <ID>1</ID>
    <MinimumOrderAmount>1</MinimumOrderAmount>
    <Name>sample string 2</Name>
    <OrderConfirmNotificationTriggerID>8</OrderConfirmNotificationTriggerID>
    <Percent>5</Percent>
    <PrePayment>true</PrePayment>
    <Price xmlns:d3p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
      <d3p1:Amount>6</d3p1:Amount>
      <d3p1:Base>3</d3p1:Base>
      <d3p1:EquivalenceSurcharge>5</d3p1:EquivalenceSurcharge>
      <d3p1:EquivalenceSurchargePercent>2</d3p1:EquivalenceSurchargePercent>
      <d3p1:Tax>4</d3p1:Tax>
      <d3p1:TaxPercent>1</d3p1:TaxPercent>
    </Price>
    <QuickPayment>true</QuickPayment>
    <ShippingOrderStatusID>7</ShippingOrderStatusID>
    <ShippingTriggerID>6</ShippingTriggerID>
    <TaxRateID>4</TaxRateID>
  </PaymentMeans>
  <PaymentMeans>
    <AllowedPaymentDueMinutes>9</AllowedPaymentDueMinutes>
    <ApplePayGooglePay>true</ApplePayGooglePay>
    <BankAccounts>
      <StoreBankAccount>
        <IBAN>sample string 4</IBAN>
        <Name>sample string 3</Name>
        <Verified>true</Verified>
        <ID>1</ID>
        <StoreID>2</StoreID>
      </StoreBankAccount>
      <StoreBankAccount>
        <IBAN>sample string 4</IBAN>
        <Name>sample string 3</Name>
        <Verified>true</Verified>
        <ID>1</ID>
        <StoreID>2</StoreID>
      </StoreBankAccount>
    </BankAccounts>
    <BankTransfer>true</BankTransfer>
    <Bizum>true</Bizum>
    <CashOnDelivery>true</CashOnDelivery>
    <CountryID>1</CountryID>
    <Description>sample string 3</Description>
    <Disabled>2025-12-06T09:18:53.8493415+01:00</Disabled>
    <ID>1</ID>
    <MinimumOrderAmount>1</MinimumOrderAmount>
    <Name>sample string 2</Name>
    <OrderConfirmNotificationTriggerID>8</OrderConfirmNotificationTriggerID>
    <Percent>5</Percent>
    <PrePayment>true</PrePayment>
    <Price xmlns:d3p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
      <d3p1:Amount>6</d3p1:Amount>
      <d3p1:Base>3</d3p1:Base>
      <d3p1:EquivalenceSurcharge>5</d3p1:EquivalenceSurcharge>
      <d3p1:EquivalenceSurchargePercent>2</d3p1:EquivalenceSurchargePercent>
      <d3p1:Tax>4</d3p1:Tax>
      <d3p1:TaxPercent>1</d3p1:TaxPercent>
    </Price>
    <QuickPayment>true</QuickPayment>
    <ShippingOrderStatusID>7</ShippingOrderStatusID>
    <ShippingTriggerID>6</ShippingTriggerID>
    <TaxRateID>4</TaxRateID>
  </PaymentMeans>
</ArrayOfPaymentMeans>