Skip to main content

Retrieve a checkout​

Retrieves an identified checkout resource. Use this request after processing a checkout to confirm its status and inform the end user respectively.

Responses

OK

Schema
  • checkout_reference string

    Possible values: <= 90 characters

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

  • amount float

    Amount of the payment.

  • currency string

    Possible values: [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_email email

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

  • merchant_code string

    Unique identifying code of the merchant profile.

  • description string

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

  • return_url uri

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

  • id string

    Unique ID of the checkout resource.

  • status string

    Possible values: [PENDING, FAILED, PAID]

    Current status of the checkout.

  • date date-time

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

  • valid_until date-time

    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.

  • customer_id string

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

  • mandate object

    Created mandate

  • type string

    Indicates the mandate type

  • status string

    Mandate status

  • merchant_code string

    Merchant code which has the mandate

  • transactions object[]

    List of transactions related to the payment.

  • id string

    Unique ID of the transaction.

  • transaction_code string

    Transaction code returned by the acquirer/processing entity after processing the transaction.

  • amount float

    Total amount of the transaction.

  • currency string

    Possible values: [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.

  • timestamp date-time

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

  • status string

    Possible values: [SUCCESSFUL, CANCELLED, FAILED, PENDING]

    Current status of the transaction.

  • payment_type string

    Possible values: [ECOM, RECURRING]

    Payment type used for the transaction.

  • installments_count integer

    Possible values: >= 1

    Current number of the installment for deferred payments.

  • merchant_code string

    Unique code of the registered merchant to whom the payment is made.

  • vat_amount float

    Amount of the applicable VAT (out of the total transaction amount).

  • tip_amount float

    Amount of the tip (out of the total transaction amount).

  • entry_mode string

    Possible values: [CUSTOMER_ENTRY]

    Entry mode of the payment details.

  • auth_code string

    Authorization code for the transaction sent by the payment card issuer or bank. Applicable only to card payments.

  • internal_id integer

    Internal unique ID of the transaction on the SumUp platform.

  • transaction_code string

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

  • transaction_id string

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

  • merchant_name string

    Name of the merchant

  • redirect_url string

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

  • payment_instrument object

    Object containing token information for the specified payment instrument

  • token string

    Token value