POST Finance/AddPaymentMean

Adds a PaymentMeans.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Name		string	Required
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		boolean	None.
PrePayment		boolean	None.
BankTransfer	This is a bank transfer	boolean	None.
Bizum		boolean	None.
ApplePayGooglePay		boolean	None.
Lang		string	None.
StoreID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Disabled": "2025-12-06T05:41:54.7143607+01:00",
  "CountryID": 1,
  "MinimumOrderAmount": 1.0,
  "TaxRateID": 3,
  "Price": {
    "TaxPercent": 1.0,
    "EquivalenceSurchargePercent": 2.0,
    "Base": 3.0,
    "Tax": 4.0,
    "EquivalenceSurcharge": 5.0,
    "Amount": 6.0
  },
  "Percent": 4.0,
  "ShippingTriggerID": 5,
  "ShippingOrderStatusID": 6,
  "OrderConfirmNotificationTriggerID": 7,
  "AllowedPaymentDueMinutes": 8,
  "CashOnDelivery": true,
  "QuickPayment": true,
  "PrePayment": true,
  "BankTransfer": true,
  "Bizum": true,
  "ApplePayGooglePay": true,
  "Lang": "sample string 15",
  "StoreID": 16
}

application/xml, text/xml

Sample:

<AddPaymentMeansBinding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Finance">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 15</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">16</StoreID>
  <AllowedPaymentDueMinutes>8</AllowedPaymentDueMinutes>
  <ApplePayGooglePay>true</ApplePayGooglePay>
  <BankTransfer>true</BankTransfer>
  <Bizum>true</Bizum>
  <CashOnDelivery>true</CashOnDelivery>
  <CountryID>1</CountryID>
  <Description>sample string 2</Description>
  <Disabled>2025-12-06T05:41:54.7143607+01:00</Disabled>
  <MinimumOrderAmount>1</MinimumOrderAmount>
  <Name>sample string 1</Name>
  <OrderConfirmNotificationTriggerID>7</OrderConfirmNotificationTriggerID>
  <Percent>4</Percent>
  <PrePayment>true</PrePayment>
  <Price xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
    <d2p1:Amount>6</d2p1:Amount>
    <d2p1:Base>3</d2p1:Base>
    <d2p1:EquivalenceSurcharge>5</d2p1:EquivalenceSurcharge>
    <d2p1:EquivalenceSurchargePercent>2</d2p1:EquivalenceSurchargePercent>
    <d2p1:Tax>4</d2p1:Tax>
    <d2p1:TaxPercent>1</d2p1:TaxPercent>
  </Price>
  <QuickPayment>true</QuickPayment>
  <ShippingOrderStatusID>6</ShippingOrderStatusID>
  <ShippingTriggerID>5</ShippingTriggerID>
  <TaxRateID>3</TaxRateID>
</AddPaymentMeansBinding>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:

application/xml, text/xml

Sample:

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>