Payment callback for form based payments

PaymentFormCallback is called from applications using forms based checkouts with support for callbacks. Applications gets called when the end-user gets routed back to a 'Thanks for you order page' and the applications should make this call to the API before routing. See Checkout Form Payments for more information about the checkout process.

Request
query Parameters
basketId
required
integer <int32>

The internal id of the basket used in the checkout.

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: 'Mobile'='True' to enable javascript for mobile phones.

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: PaymentFailed. Gets raised when the payment fails.

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

500

Internal Server Error

post/ShoppingService.svc/rest/PaymentFormCallback
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
}