Creates an order redirect payment

Licenses Required

  • Vista.Ocapi
Request
path Parameters
orderId
required
string

The unique identifier of the in progress order base that the payment is for

header Parameters
Connect-Region-Code
string

Region Code

Request Body schema:
required

Values needed to start the redirect payment

webPaymentMethodId
required
integer <int32>

Gets the unique identifier of the web payment method

redirectReturnUrl
required
string <uri>

Gets the URL that the browser will be directed to after the after successful or cancelled payment

Responses
200

Success

400

Request property is invalid or missing, or payment method does not exist.

404

Order does not exist.

post/ocapi/v1/orders/{orderId}/payments/redirect
Request samples
{}
Response samples
application/json
{
  • "redirectPayment": {
    },
  • "redirectUrl": "http://example.com",
  • "updatedOrderExpiresAt": "2019-08-24T14:15:22Z"
}