Checkouts

Create a checkout

Creates a new payment checkout resource. The unique checkout_reference created by this request, is used for further manipulation of the checkout.

For 3DS checkouts, add the redirect_url parameter to your request body schema.

Follow by processing a checkout to charge the provided payment instrument.

post/v0.1/checkouts

Request body

checkout_referencestring required

Unique ID of the payment checkout specified by the client application when creating the checkout resource.

amountnumber float required

Amount of the payment.

currency'BGN' | 'BRL' | 'CHF' | 'CLP' | 'CZK' | 'DKK' | 'EUR' | 'GBP' | 'HRK' | 'HUF' | 'NOK' | 'PLN' | 'RON' | 'SEK' | 'USD' required

Three-letter ISO4217 code of the currency for the amount. Currently supported currency values are enumerated above.

merchant_codestring required

Unique identifying code of the merchant profile.

descriptionstring

Short description of the checkout visible in the SumUp dashboard. The description can contribute to reporting, allowing easier identification of a checkout.

return_urlstring uri

URL to which the SumUp platform sends the processing status of the payment checkout.

customer_idstring

Unique identification of a customer. If specified, the checkout session and payment instrument are associated with the referenced customer.

purpose'CHECKOUT' | 'SETUP_RECURRING_PAYMENT'

Purpose of the checkout.

idstring

Unique ID of the checkout resource.

status'PENDING' | 'FAILED' | 'PAID'

Current status of the checkout.

datestring date-time

Date and time of the creation of the payment checkout. Response format expressed according to ISO8601 code.

valid_untilstring date-time nullable

Date and time of the checkout expiration before which the client application needs to send a processing request. If no value is present, the checkout does not have an expiration time.

redirect_urlstring

Required for APMs and recommended for card payments. Refers to a url where the end user is redirected once the payment processing completes. If not specified, the Payment Widget renders 3DS challenge within an iframe instead of performing a full-page redirect.

Example request

{
  "currency": "EUR",
  "merchant_code": "MH4H92C7",
  "date": "2020-02-29T10:56:56+00:00",
  "valid_until": "2020-02-29T10:56:56+00:00",
  "transactions": [
    {
      "id": "6b425463-3e1b-431d-83fa-1e51c2925e99",
      "transaction_code": "TEENSK4W2K",
      "amount": 10.1,
      "currency": "EUR",
      "timestamp": "2020-02-29T10:56:56.876Z",
      "merchant_code": "MH4H92C7",
      "vat_amount": 6,
      "tip_amount": 3,
      "auth_code": "053201",
      "internal_id": 1763892018
    }
  ],
  "redirect_url": "https://mysite.com/completed_purchase"
}

Response

Created

checkout_referencestring