POST checkout/{code}

Set up checkout for an order.

Request

URL parameters

These parameters are specified as part of the URL.

Property	Description	Type	Details
code	A unique checkout code. You don't need to construct this URL manually: the "POST /orders" and "GET /orders/{id}" responses contain a fully qualified URL to this endpoint.	string	Required

Body

Information for the Print API checkout service.

Property	Description	Type	Details
ReturnUrl	The URL to which the customer will be redirected after the payment process.	string	Length: 5-512, inclusive
Billing	The billing info of the order.	in:Billing	-

application/json, text/json
application/xml, text/xml

{
  "returnUrl": "http://www.your.site.here.com/callback?order_id=83432183",
  "billing": {
    "address": {
      "name": "Print API",
      "line1": "Osloweg 75",
      "postCode": "9700 GE",
      "city": "Groningen",
      "country": "NL"
    }
  }
}

<?xml version="1.0"?>
<Checkout xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ReturnUrl>http://www.your.site.here.com/callback?order_id=83432183</ReturnUrl>
  <Billing>
    <Address>
      <Name>Print API</Name>
      <Line1>Osloweg 75</Line1>
      <PostCode>9700 GE</PostCode>
      <City>Groningen</City>
      <Country>NL</Country>
    </Address>
  </Billing>
</Checkout>

Response

Body

The Print API checkout setup.

Property	Description	Type	Details
Amount	The total payment due in the payment screen.	decimal number	-
Status	The status of the payment.	PaymentStatus	-
PaymentUrl	The URL of the payment screen. Redirect the customer here.	string	-
ReturnUrl	The URL to which the customer will be redirected after the payment process.	string	-
Billing	The billing details of the payment.	out:Billing	-

application/json, text/json
application/xml, text/xml

{
  "amount": 100.0,
  "status": "Open",
  "paymentUrl": "https://test.printapi.nl/v2/payments/.../start",
  "returnUrl": "http://www.your.site.here.com/callback?order_id=83432183",
  "billing": {
    "address": {
      "name": "Print API",
      "line1": "Osloweg 75",
      "postCode": "9700 GE",
      "city": "Groningen",
      "country": "NL"
    }
  }
}

<?xml version="1.0"?>
<Checkout xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>100</Amount>
  <Status>Open</Status>
  <PaymentUrl>https://test.printapi.nl/v2/payments/.../start</PaymentUrl>
  <ReturnUrl>http://www.your.site.here.com/callback?order_id=83432183</ReturnUrl>
  <Billing>
    <Address>
      <Name>Print API</Name>
      <Line1>Osloweg 75</Line1>
      <PostCode>9700 GE</PostCode>
      <City>Groningen</City>
      <Country>NL</Country>
    </Address>
  </Billing>
  <Tax xsi:nil="true" />
</Checkout>