Sign in
Checkouts

Deactivate a checkout

Deactivates an identified checkout resource. If the checkout has already been processed it can not be deactivated.

delete/v0.1/checkouts/{id}

Response

OK

checkout_referencestring

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

idstring

Unique ID of the checkout resource.

amountnumber float

Amount of the payment.

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

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

pay_to_emailstring email

Email address of the registered user (merchant) to whom the payment is made.

merchant_codestring

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.

purpose'SETUP_RECURRING_PAYMENT' | 'CHECKOUT'

Purpose of the checkout creation initially

status'EXPIRED'

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.

merchant_namestring

Merchant name

merchant_countrystring

The merchant's country

Example response

{
  "currency": "EUR",
  "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
    }
  ]
}

Changes