SumUp REST API (1.0.0)

Download OpenAPI specification:Download

Authentication

accessToken

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://api.sumup.com/authorize
Token URL: https://api.sumup.com/token
Refresh URL: https://api.sumup.com/token
Scopes:
  • payments -

    Make payments by creating and processing checkouts.

  • transactions.history -

    View transactions and transaction history.

  • user.profile_readonly -

    View user profile details.

  • user.profile -

    View and manage your user profile.

  • user.app-settings -

    View and manage the SumUp mobile application settings.

  • payment_instruments -

    Manage customers and their payment instruments.

  • user.payout-settings -

    View and manage your payout settings.

  • user.subaccounts -

    View and manage the user profile details of your employees.

clientCredentials OAuth Flow
Token URL: https://api.sumup.com/token
Scopes:
  • payments -

    Make payments by creating and processing checkouts.

  • transactions.history -

    View transactions and transaction history.

  • user.profile_readonly -

    View user profile details.

  • user.profile -

    View and manage your user profile.

  • user.app-settings -

    View and manage the SumUp mobile application settings.

  • payment_instruments -

    Manage customers and their payment instruments.

  • user.payout-settings -

    View and manage your payout settings.

  • user.subaccounts -

    View and manage the user profile details of your employee.

Checkouts

View and manage payment checkouts.

Create a checkout

Creates a new payment checkout resource.

Authorizations:
accessToken (payments)
Request Body schema: application/json
One of
  • CheckoutCreateRequest
  • Checkout3DS
checkout_reference
string <= 90 characters

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

amount
number <float>

Amount of the payment.

currency
string (Currency)
Enum: "EUR" "BGN" "CHF" "CZK" "DKK" "GBP" "HUF" "NOK" "PLN" "SEK" "USD"

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

pay_to_email
string <email>

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

description
string

Short description of the payment.

return_url
string <uri>

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

Responses

201

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post /checkouts

Production server

https://api.sumup.com/v0.1/checkouts

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "checkout_reference": "string",
  • "amount": 0,
  • "currency": "EUR",
  • "pay_to_email": "user@example.com",
  • "description": "string",
  • "return_url": "http://example.com"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "checkout_reference": "string",
  • "amount": 0,
  • "currency": "EUR",
  • "pay_to_email": "user@example.com",
  • "merchant_code": "string",
  • "description": "string",
  • "return_url": "http://example.com",
  • "id": "string",
  • "status": "PENDING",
  • "date": "2020-02-29T10:56:56+00:00",
  • "valid_until": "2020-02-29T10:56:56+00:00",
  • "transactions":
    [
    ]
}

List checkouts

Lists checkout resources according to specified criteria.

Authorizations:
accessToken (payments)
query Parameters
checkout_reference
string

Filters the list of checkout resources by the unique ID of the checkout.

Responses

200

OK

401

Unauthorized

get /checkouts

Production server

https://api.sumup.com/v0.1/checkouts

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Retrieve a checkout

Retrieves an identified checkout resource.

Authorizations:
accessToken (payments)
path Parameters
id
required
string

Unique ID of the checkout resource.

Responses

200

OK

401

Unauthorized

404

Not Found

get /checkouts/{id}

Production server

https://api.sumup.com/v0.1/checkouts/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "checkout_reference": "string",
  • "amount": 0,
  • "currency": "EUR",
  • "pay_to_email": "user@example.com",
  • "merchant_code": "string",
  • "description": "string",
  • "return_url": "http://example.com",
  • "id": "string",
  • "status": "PENDING",
  • "date": "2020-02-29T10:56:56+00:00",
  • "valid_until": "2020-02-29T10:56:56+00:00",
  • "transactions":
    [
    ],
  • "transaction_code": "string",
  • "transaction_id": "string"
}

Process a checkout

Processes an identified checkout resource with the specified payment instrument and create a transaction.

Authorizations:
accessToken (payments)
path Parameters
id
required
string

Unique ID of the checkout resource.

Request Body schema: application/json

Details of the payment instrument for processing the checkout.

One of
  • CheckoutProcessCard
  • CheckoutProcessToken
payment_type
required
string
Value: "card"
installments
integer [ 1 .. 12 ]

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

card
required
object (Card)

Details of the payment card.

Responses

200

OK

202

Accepted

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

put /checkouts/{id}

Production server

https://api.sumup.com/v0.1/checkouts/{id}

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "payment_type": "card",
  • "installments": 1,
  • "card":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "checkout_reference": "string",
  • "amount": 0,
  • "currency": "EUR",
  • "pay_to_email": "user@example.com",
  • "merchant_code": "string",
  • "description": "string",
  • "return_url": "http://example.com",
  • "id": "string",
  • "status": "PENDING",
  • "date": "2020-02-29T10:56:56+00:00",
  • "valid_until": "2020-02-29T10:56:56+00:00",
  • "transactions":
    [
    ],
  • "transaction_code": "string",
  • "transaction_id": "string"
}

Deactivate a checkout

Deactivates an identified checkout resource.

Authorizations:
accessToken (payments)
path Parameters
id
required
string

Unique ID of the checkout resource.

Responses

200

OK

401

Unauthorized

404

Not Found

409

Conflict

delete /checkouts/{id}

Production server

https://api.sumup.com/v0.1/checkouts/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "checkout_reference": "string",
  • "amount": 0,
  • "currency": "EUR",
  • "pay_to_email": "user@example.com",
  • "merchant_code": "string",
  • "description": "string",
  • "return_url": "http://example.com",
  • "id": "string",
  • "status": "PENDING",
  • "date": "2020-02-29T10:56:56+00:00",
  • "valid_until": "2020-02-29T10:56:56+00:00",
  • "transactions":
    [
    ]
}

Customers

View and manage saved customers and their payment instruments.

Create a customer

Creates a new saved customer resource.

Authorizations:
accessToken (payment_instruments)
Request Body schema: application/json

Details of the customer.

customer_id
required
string (CustomerID)

Unique ID of the customer.

personal_details
object (PersonalDetails)

Personal details for the customer.

Responses

201

Created

401

Unauthorized

403

Forbidden

409

Conflict

post /customers

Production server

https://api.sumup.com/v0.1/customers

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "customer_id": "string",
  • "personal_details":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{