Reserve amount on gift card

Reserve an amount on a gift card.

Request
query Parameters
cardNo
required
string

The card number to make reservation on.

cvc
required
string

The cvc of the card to make reservation on.

basketId
required
integer <int32>

Internal id of the basket to associate with this reservation.

ipAddress
required
string
userAgent
required
string
pricelistSeed
string

A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

cultureCode
string

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

Request Body schema:

General: 'extra parameters, reserveamount' for test or set the amount to be used with gift card.

Array
Name
string

The Name of the Entity. MaxLength: 50

Value
string

The Value of the Entity. MaxLength: max

Responses
200

Success

400

Bad Request

Key: BasketItemNotBuyable. Gets raised when the basket item is not buyable or when it is inactive.

Key: BasketItemQuantityLessThanZero. Gets raised when the basket item quantity is less than zero.

Key: DeliveryAddressMissing. Gets raised when the delivery address does not exist.

Key: InvalidCompanyOnBasket. Gets raised when the basket has an invalid company. The customer does not exist in this company.

Key: InvalidCurrencyOnCard. Gets raised when the gift card has another currency than the basket

Key: PaymentFailed. Gets raised when the payment fails.

Key: QuotationMissing. Gets raised when the basket is missing.

Key: BasketContainsSomeUnbuyableItems. Gets raised when the basket has some unbuyable items.

Key: BasketContainsNoBuyableItems. Gets raised when the basket does not have any buyable items.

500

Internal Server Error

post/ShoppingService.svc/rest/PaymentGiftCardReserve
Request samples
[
  • {
    }
]
Response samples
{
  • "Status": "string",
  • "StatusDescription": "string",
  • "BasketId": 0,
  • "OrderNo": "string",
  • "PaymentCode": "string",
  • "PaymentReference": "string",
  • "HostedPaymentPage": "string",
  • "RedirectUrl": "string",
  • "RedirectParameters": [
    ],
  • "IsSyncronous": true,
  • "PaymentServiceId": 0
}