Sign in
Checkouts

Process a checkout

Processing a checkout will attempt to charge the provided payment instrument for the amount of the specified checkout resource initiated in the Create a checkout endpoint.

Follow this request with Retrieve a checkout to confirm its status.

put/v0.1/checkouts/{id}

Request body

customer_idstring

Required when token is provided. Unique ID of the customer.

installmentsinteger

Number of installments for deferred payments. Available only to merchant users in Brazil.

payment_type'card' | 'boleto' | 'ideal' | 'blik' | 'bancontact' required
tokenstring

Required when using a tokenized card to process a checkout. Unique token identifying the saved payment card for a customer.

Example request

{
  "card": {
    "cvv": "123",
    "expiry_year": "2023",
    "last_4_digits": "3456",
    "name": "FIRSTNAME LASTNAME",
    "number": "1234567890123456",
    "zip_code": "12345"
  },
  "mandate": {
    "type": "recurrent",
    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.104 Safari/537.36",
    "user_ip": "172.217.169.174"
  }
}

Response

OK

amountnumber float

Amount of the payment.

checkout_referencestring

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

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.

customer_idstring

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

datestring date-time

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

descriptionstring

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

idstring

Unique ID of the checkout resource.

merchant_codestring

Unique identifying code of the merchant profile.

pay_to_emailstring email

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

return_urlstring uri

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

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

Current status of the checkout.

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

Name of the merchant

redirect_urlstring

Refers to a url where the end user is redirected once the payment processing completes.

transaction_codestring

Transaction code of the successful transaction with which the payment for the checkout is completed.

transaction_idstring

Transaction ID of the successful transaction with which the payment for the checkout is completed.

Example response

{
  "amount": 10.1,
  "currency": "EUR",
  "customer_id": "831ff8d4cd5958ab5670",
  "date": "2020-02-29T10:56:56+00:00",
  "id": "4e425463-3e1b-431d-83fa-1e51c2925e99",
  "mandate": {
    "merchant_code": "MDASYTPD",
    "status": "active",
    "type": "recurrent"
  },
  "transactions": [
    {
      "amount": 10.1,
      "currency": "EUR",
      "id": "6b425463-3e1b-431d-83fa-1e51c2925e99",
      "timestamp": "2020-02-29T10:56:56.876Z",
      "transaction_code": "TEENSK4W2K",
      "auth_code": "053201",
      "internal_id": 1763892018,
      "merchant_code": "MH4H92C7",
      "tip_amount": 3,
      "vat_amount": 6
    }
  ],
  "valid_until": "2020-02-29T10:56:56+00:00",
  "merchant_name": "Sample Merchant",
  "payment_instrument": {
    "token": "e76d7e5c-9375-4fac-a7e7-b19dc5302fbc"
  },
  "redirect_url": "https://mysite.com/completed_purchase",
  "transaction_code": "TEENSK4W2K",
  "transaction_id": "410fc44a-5956-44e1-b5cc-19c6f8d727a4"
}

Changes