Back to top

 

Merchant account

Get account

Get account
GET/v0.1/me

Returns user account information

Required scope(s): user.profile, user.profile_readonly

Resource URL

GET https://api.sumup.com/v0.1/me
Parameters
HideShow
include[]
array (optional) 

A list of additional information you want to receive for the user. By default only personal and merchant profile information will be returned. Possible values: operators, settings, doing_business_as, bank_accounts, app_settings, vat_rates, signup_flows, shelves, country_details, timeoffset_details, permissions

Response  200
HideShow
Body
{
  "account": {
    "username": "...",
    "type": "normal|operator"
  },
  "personal_profile": {
    "first_name": "...",
    "last_name": "...",
    "date_of_birth": "...",
    "mobile_phone": "...",
    "national_id": "...",
    "address": {
      "address_line1": "...",
      "address_line2": "...",
      "city": "...",
      "country": "...",
      "region_id": 1,
      "region_name": "...",
      "region_code": "...",
      "post_code": "...",
      "landline": "...",
      "first_name": "...",
      "last_name": "...",
      "company": "...",
      "country_details": {
        "currency": "...",
        "iso_code": "...",
        "en_name": "...",
        "native_name": "..."
      },
      "timeoffset_details": {
        "post_code": "...",
        "offset": 1,
        "dst": true
      },
      "state_id": "..."
    }
  },
  "merchant_profile": {
    "merchant_code": "...",
    "company_name": "...",
    "website": "...",
    "legal_type": {
      "id": 1,
      "description": "...",
      "sole_trader": true
    },
    "merchant_category_code": "...",
    "mobile_phone": "...",
    "company_registration_number": "...",
    "vat_id": "...",
    "permanent_certificate_access_code": "...",
    "nature_and_purpose": "...",
    "address": {
      "address_line1": "...",
      "address_line2": "...",
      "city": "...",
      "country": "...",
      "region_id": 1,
      "region_name": "...",
      "region_code": "...",
      "post_code": "...",
      "landline": "...",
      "first_name": "...",
      "last_name": "...",
      "company": "...",
      "country_details": {
        "currency": "...",
        "iso_code": "...",
        "en_name": "...",
        "native_name": "..."
      },
      "timeoffset_details": {
        "post_code": "...",
        "offset": 1,
        "dst": true
      },
      "state_id": "..."
    },
    "business_owners": [
      {
        "first_name": "...",
        "last_name": "...",
        "date_of_birth": "...",
        "mobile_phone": "...",
        "landline": "...",
        "ownership": 1
      }
    ],
    "doing_business_as": {
      "business_name": "...",
      "company_registration_number": "...",
      "vat_id": "...",
      "website": "...",
      "email": "...",
      "address": {
        "address_line1": "...",
        "address_line2": "...",
        "city": "...",
        "country": "...",
        "region_id": 1,
        "region_name": "...",
        "region_code": "...",
        "post_code": "...",
        "landline": "...",
        "first_name": "...",
        "last_name": "...",
        "company": "...",
        "country_details": {
          "currency": "...",
          "iso_code": "...",
          "en_name": "...",
          "native_name": "..."
        },
        "timeoffset_details": {
          "post_code": "...",
          "offset": 1,
          "dst": true
        },
        "state_id": "..."
      }
    },
    "settings": {
      "tax_enabled": true,
      "payout_type": "...",
      "payout_period": "...",
      "payout_on_demand_available": true,
      "payout_on_demand": true,
      "printers_enabled": true,
      "payout_instrument": "...",
      "moto_payment": true,
      "adyen_merchant_code": "...",
      "adyen_user": "...",
      "adyen_password": "...",
      "adyen_company": "..."
    },
    "vat_rates": {
      "id": 1,
      "description": "...",
      "rate": 1,
      "ordering": 1,
      "country": "..."
    },
    "shelves": [
      {
        "id": 1,
        "name": "...",
        "order": 1,
        "products": [
          {
            "id": 1,
            "shelf_id": 1,
            "availability": 1,
            "image_url": "...",
            "stock": 1,
            "subtitle": "...",
            "title": "...",
            "prices": [
              {
                "id": 1,
                "product_id": 1,
                "description": "...",
                "net": 1
              }
            ],
            "vat_rate_id": 1,
            "color_id": 1
          }
        ]
      }
    ],
    "bank_accounts": [
      {
        "bank_code": "...",
        "branch_code": "...",
        "swift": "...",
        "account_number": "...",
        "iban": "...",
        "account_type": "...",
        "account_holder_name": "...",
        "status": "...",
        "primary": true,
        "created_at": "...",
        "bank_name": "..."
      }
    ],
    "extdev": true,
    "payout_zone_migrated": true
  },
  "operators": [
    {
      "username": "..."
    }
  ],
  "app_settings": {
    "checkout_preference": "...",
    "sound_enabled": true,
    "tips_enabled": true,
    "font_name": "...",
    "include_vat": true,
    "max_amount_no_signature": "...",
    "manual_entry_tutorial": true,
    "mobile_payment_tutorial": true,
    "tax_enabled": true,
    "mobile_payment": "...",
    "reader_payment": "...",
    "cash_payment": "...",
    "advanced_mode": "...",
    "expected_max_transaction_amount": 1,
    "bitcoin_payment": "...",
    "manual_entry": "...",
    "terminal_mode_tutorial": true,
    "tipping": "...",
    "tip_rates": []
  },
  "signup_flows": [
    {
      "name": "...",
      "state": "...",
      "id": "..."
    }
  ],
  "shelves": [
    {
      "id": 1,
      "name": "...",
      "order": 1,
      "products": [
        {
          "id": 1,
          "shelf_id": 1,
          "availability": 1,
          "image_url": "...",
          "stock": 1,
          "subtitle": "...",
          "title": "...",
          "prices": [
            {
              "id": 1,
              "product_id": 1,
              "description": "...",
              "net": 1
            }
          ],
          "vat_rate_id": 1,
          "color_id": 1
        }
      ]
    }
  ],
  "permissions": {
    "create_moto_payments": true,
    "refund_transactions": true
  }
}
Schema
{
  "type": "object",
  "properties": {
    "account": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string",
          "description": "Username of the account"
        },
        "type": {
          "type": "string",
          "description": "Type of the account - Possible values normal,operator"
        }
      },
      "description": "Account information"
    },
    "personal_profile": {
      "type": "object",
      "properties": {
        "first_name": {
          "type": "string",
          "description": "First name of the user"
        },
        "last_name": {
          "type": "string",
          "description": "Last name of the user"
        },
        "date_of_birth": {
          "type": "string",
          "description": "Date of birth"
        },
        "mobile_phone": {
          "type": "string",
          "description": "Mobile phone number"
        },
        "national_id": {
          "type": "string",
          "description": "National identification id. Country specific. Ex CPF (Brazil), DNI (Spain), PESEL (Poland)"
        },
        "address": {
          "type": "object",
          "properties": {
            "address_line1": {
              "type": "string",
              "description": "Address line 1"
            },
            "address_line2": {
              "type": "string",
              "description": "Address line 2"
            },
            "city": {
              "type": "string",
              "description": "City"
            },
            "country": {
              "type": "string",
              "description": "Country ISO 3166-1 code"
            },
            "region_id": {
              "type": "number",
              "description": "Country region id"
            },
            "region_name": {
              "type": "string",
              "description": "Region name"
            },
            "region_code": {
              "type": "string",
              "description": "Region code"
            },
            "post_code": {
              "type": "string",
              "description": "Postal code"
            },
            "landline": {
              "type": "string",
              "description": "Landline number"
            },
            "first_name": {
              "type": "string",
              "description": "undefined"
            },
            "last_name": {
              "type": "string",
              "description": "undefined"
            },
            "company": {
              "type": "string",
              "description": "undefined"
            },
            "country_details": {
              "type": "object",
              "properties": {
                "currency": {
                  "type": "string",
                  "description": "Currency ISO 4217 code"
                },
                "iso_code": {
                  "type": "string",
                  "description": "Country ISO code"
                },
                "en_name": {
                  "type": "string",
                  "description": "Country EN name"
                },
                "native_name": {
                  "type": "string",
                  "description": "Country native name"
                }
              },
              "description": "Country Details"
            },
            "timeoffset_details": {
              "type": "object",
              "properties": {
                "post_code": {
                  "type": "string",
                  "description": "Postal code"
                },
                "offset": {
                  "type": "number",
                  "description": "UTC offset"
                },
                "dst": {
                  "type": "boolean",
                  "description": "Daylight Saving Time"
                }
              },
              "description": "TimeOffset Details"
            },
            "state_id": {
              "type": "string",
              "description": "undefined"
            }
          },
          "description": "Account's personal address information"
        }
      },
      "description": "Account's personal profile"
    },
    "merchant_profile": {
      "type": "object",
      "properties": {
        "merchant_code": {
          "type": "string",
          "description": "Unique identifying code of the merchant profile"
        },
        "company_name": {
          "type": "string",
          "description": "Company name"
        },
        "website": {
          "type": "string",
          "description": "Website"
        },
        "legal_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "Unique id"
            },
            "description": {
              "type": "string",
              "description": "Legal type"
            },
            "sole_trader": {
              "type": "boolean",
              "description": "Sole trader legal type if true"
            }
          },
          "description": "Id of the legal type of the merchant profile"
        },
        "merchant_category_code": {
          "type": "string",
          "description": "Merchant category code"
        },
        "mobile_phone": {
          "type": "string",
          "description": "Mobile phone number"
        },
        "company_registration_number": {
          "type": "string",
          "description": "Company registration number"
        },
        "vat_id": {
          "type": "string",
          "description": "Vat ID"
        },
        "permanent_certificate_access_code": {
          "type": "string",
          "description": "Permanent certificate access code (Portugal)"
        },
        "nature_and_purpose": {
          "type": "string",
          "description": "Nature and purpose of the business"
        },
        "address": {
          "type": "object",
          "properties": {
            "address_line1": {
              "type": "string",
              "description": "Address line 1"
            },
            "address_line2": {
              "type": "string",
              "description": "Address line 2"
            },
            "city": {
              "type": "string",
              "description": "City"
            },
            "country": {
              "type": "string",
              "description": "Country ISO 3166-1 code"
            },
            "region_id": {
              "type": "number",
              "description": "Country region id"
            },
            "region_name": {
              "type": "string",
              "description": "Region name"
            },
            "region_code": {
              "type": "string",
              "description": "Region code"
            },
            "post_code": {
              "type": "string",
              "description": "Postal code"
            },
            "landline": {
              "type": "string",
              "description": "Landline number"
            },
            "first_name": {
              "type": "string",
              "description": "undefined"
            },
            "last_name": {
              "type": "string",
              "description": "undefined"
            },
            "company": {
              "type": "string",
              "description": "undefined"
            },
            "country_details": {
              "type": "object",
              "properties": {
                "currency": {
                  "type": "string",
                  "description": "Currency ISO 4217 code"
                },
                "iso_code": {
                  "type": "string",
                  "description": "Country ISO code"
                },
                "en_name": {
                  "type": "string",
                  "description": "Country EN name"
                },
                "native_name": {
                  "type": "string",
                  "description": "Country native name"
                }
              },
              "description": "Country Details"
            },
            "timeoffset_details": {
              "type": "object",
              "properties": {
                "post_code": {
                  "type": "string",
                  "description": "Postal code"
                },
                "offset": {
                  "type": "number",
                  "description": "UTC offset"
                },
                "dst": {
                  "type": "boolean",
                  "description": "Daylight Saving Time"
                }
              },
              "description": "TimeOffset Details"
            },
            "state_id": {
              "type": "string",
              "description": "undefined"
            }
          },
          "description": "Account's business address information"
        },
        "business_owners": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "first_name": {
                "type": "string",
                "description": "BO's first name"
              },
              "last_name": {
                "type": "string",
                "description": "BO's last name of the user"
              },
              "date_of_birth": {
                "type": "string",
                "description": "\"Date of birth\""
              },
              "mobile_phone": {
                "type": "string",
                "description": "Mobile phone number"
              },
              "landline": {
                "type": "string",
                "description": "BO's Landline"
              },
              "ownership": {
                "type": "number",
                "description": "Ownership percentage"
              }
            }
          },
          "description": "Account's business address information"
        },
        "doing_business_as": {
          "type": "object",
          "properties": {
            "business_name": {
              "type": "string",
              "description": "Doing business as name"
            },
            "company_registration_number": {
              "type": "string",
              "description": "Doing business as company registration number"
            },
            "vat_id": {
              "type": "string",
              "description": "Doing business as vat id"
            },
            "website": {
              "type": "string",
              "description": "Doing business as website"
            },
            "email": {
              "type": "string",
              "description": "Doing business as email"
            },
            "address": {
              "type": "object",
              "properties": {
                "address_line1": {
                  "type": "string",
                  "description": "Address line 1"
                },
                "address_line2": {
                  "type": "string",
                  "description": "Address line 2"
                },
                "city": {
                  "type": "string",
                  "description": "City"
                },
                "country": {
                  "type": "string",
                  "description": "Country ISO 3166-1 code"
                },
                "region_id": {
                  "type": "number",
                  "description": "Country region id"
                },
                "region_name": {
                  "type": "string",
                  "description": "Region name"
                },
                "region_code": {
                  "type": "string",
                  "description": "Region code"
                },
                "post_code": {
                  "type": "string",
                  "description": "Postal code"
                },
                "landline": {
                  "type": "string",
                  "description": "Landline number"
                },
                "first_name": {
                  "type": "string",
                  "description": "undefined"
                },
                "last_name": {
                  "type": "string",
                  "description": "undefined"
                },
                "company": {
                  "type": "string",
                  "description": "undefined"
                },
                "country_details": {
                  "type": "object",
                  "properties": {
                    "currency": {
                      "type": "string",
                      "description": "Currency ISO 4217 code"
                    },
                    "iso_code": {
                      "type": "string",
                      "description": "Country ISO code"
                    },
                    "en_name": {
                      "type": "string",
                      "description": "Country EN name"
                    },
                    "native_name": {
                      "type": "string",
                      "description": "Country native name"
                    }
                  },
                  "description": "Country Details"
                },
                "timeoffset_details": {
                  "type": "object",
                  "properties": {
                    "post_code": {
                      "type": "string",
                      "description": "Postal code"
                    },
                    "offset": {
                      "type": "number",
                      "description": "UTC offset"
                    },
                    "dst": {
                      "type": "boolean",
                      "description": "Daylight Saving Time"
                    }
                  },
                  "description": "TimeOffset Details"
                },
                "state_id": {
                  "type": "string",
                  "description": "undefined"
                }
              },
              "description": "Doing business as address"
            }
          },
          "description": "Doing Business As information"
        },
        "settings": {
          "type": "object",
          "properties": {
            "tax_enabled": {
              "type": "boolean",
              "description": "Whether to show tax in receipts (saved per transaction)"
            },
            "payout_type": {
              "type": "string",
              "description": "Payout type"
            },
            "payout_period": {
              "type": "string",
              "description": "Payout frequency"
            },
            "payout_on_demand_available": {
              "type": "boolean",
              "description": "Whether merchant can edit payouts on demand"
            },
            "payout_on_demand": {
              "type": "boolean",
              "description": "Whether merchant will receive payouts on demand"
            },
            "printers_enabled": {
              "type": "boolean",
              "description": "Whether to show printers in mobile app"
            },
            "payout_instrument": {
              "type": "string",
              "description": "Payout Instrument"
            },
            "moto_payment": {
              "type": "boolean",
              "description": "Whether merchant can make MOTO payments"
            },
            "adyen_merchant_code": {
              "type": "string",
              "description": "Adyen merchant code"
            },
            "adyen_user": {
              "type": "string",
              "description": "Adyen username"
            },
            "adyen_password": {
              "type": "string",
              "description": "Adyen password"
            },
            "adyen_company": {
              "type": "string",
              "description": "Adyen company"
            }
          },
          "description": "Merchant settings (like \"payout_type\", \"payout_period\")"
        },
        "vat_rates": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "Internal ID"
            },
            "description": {
              "type": "string",
              "description": "Description"
            },
            "rate": {
              "type": "number",
              "description": "Rate"
            },
            "ordering": {
              "type": "number",
              "description": "Ordering"
            },
            "country": {
              "type": "string",
              "description": "Country ISO code"
            }
          },
          "description": "Merchant VAT rates"
        },
        "shelves": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "Internal ID"
              },
              "name": {
                "type": "string",
                "description": "Name"
              },
              "order": {
                "type": "number",
                "description": "Order"
              },
              "products": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number",
                      "description": "Internal ID"
                    },
                    "shelf_id": {
                      "type": "number",
                      "description": "Shelf ID"
                    },
                    "availability": {
                      "type": "number",
                      "description": "availability"
                    },
                    "image_url": {
                      "type": "string",
                      "description": "Image URL"
                    },
                    "stock": {
                      "type": "number",
                      "description": "Stock"
                    },
                    "subtitle": {
                      "type": "string",
                      "description": "Subtitle"
                    },
                    "title": {
                      "type": "string",
                      "description": "Title"
                    },
                    "prices": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number",
                            "description": "ID"
                          },
                          "product_id": {
                            "type": "number",
                            "description": "Product ID"
                          },
                          "description": {
                            "type": "string",
                            "description": "Description"
                          },
                          "net": {
                            "type": "number",
                            "description": "Net"
                          }
                        }
                      },
                      "description": "prices"
                    },
                    "vat_rate_id": {
                      "type": "number",
                      "description": "VAT rate ID"
                    },
                    "color_id": {
                      "type": "number",
                      "description": "Color ID"
                    }
                  }
                },
                "description": "products"
              }
            }
          },
          "description": "Merchant Shelves"
        },
        "bank_accounts": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "bank_code": {
                "type": "string",
                "description": "Bank code"
              },
              "branch_code": {
                "type": "string",
                "description": "Branch code"
              },
              "swift": {
                "type": "string",
                "description": "SWIFT code"
              },
              "account_number": {
                "type": "string",
                "description": "Account number"
              },
              "iban": {
                "type": "string",
                "description": "IBAN"
              },
              "account_type": {
                "type": "string",
                "description": "Type of the account"
              },
              "account_holder_name": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "description": "Status in the verification process"
              },
              "primary": {
                "type": "boolean",
                "description": "The primary bank account is the one used for settlemnts"
              },
              "created_at": {
                "type": "string",
                "description": "Creation date of the bank account"
              },
              "bank_name": {
                "type": "string",
                "description": "Bank name"
              }
            }
          },
          "description": "A list of bank accounts"
        },
        "extdev": {
          "type": "boolean",
          "description": "True if the merchant is extdev"
        },
        "payout_zone_migrated": {
          "type": "boolean",
          "description": "True if the payout zone of this merchant is migrated"
        }
      },
      "description": "Account's merchant profile"
    },
    "operators": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string",
            "description": "Username of the operator"
          }
        }
      },
      "description": "A list of operators"
    },
    "app_settings": {
      "type": "object",
      "properties": {
        "checkout_preference": {
          "type": "string",
          "description": "undefined"
        },
        "sound_enabled": {
          "type": "boolean",
          "description": "undefined"
        },
        "tips_enabled": {
          "type": "boolean",
          "description": "undefined"
        },
        "font_name": {
          "type": "string",
          "description": "undefined"
        },
        "include_vat": {
          "type": "boolean",
          "description": "undefined"
        },
        "max_amount_no_signature": {
          "type": "string",
          "description": "undefined"
        },
        "manual_entry_tutorial": {
          "type": "boolean",
          "description": "undefined"
        },
        "mobile_payment_tutorial": {
          "type": "boolean",
          "description": "undefined"
        },
        "tax_enabled": {
          "type": "boolean",
          "description": "undefined"
        },
        "mobile_payment": {
          "type": "string",
          "description": "undefined"
        },
        "reader_payment": {
          "type": "string",
          "description": "undefined"
        },
        "cash_payment": {
          "type": "string",
          "description": "undefined"
        },
        "advanced_mode": {
          "type": "string",
          "description": "undefined"
        },
        "expected_max_transaction_amount": {
          "type": "number",
          "description": "undefined"
        },
        "bitcoin_payment": {
          "type": "string",
          "description": "undefined"
        },
        "manual_entry": {
          "type": "string",
          "description": "undefined"
        },
        "terminal_mode_tutorial": {
          "type": "boolean",
          "description": "undefined"
        },
        "tipping": {
          "type": "string",
          "description": "undefined"
        },
        "tip_rates": {
          "type": "array",
          "description": "undefined"
        }
      },
      "description": "Mobile app settings"
    },
    "signup_flows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Flow Name"
          },
          "state": {
            "type": "string",
            "description": "Flow State"
          },
          "id": {
            "type": "string",
            "description": "Flow session ID"
          }
        }
      },
      "description": "Legacy signup flows"
    },
    "shelves": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Internal ID"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "order": {
            "type": "number",
            "description": "Order"
          },
          "products": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "Internal ID"
                },
                "shelf_id": {
                  "type": "number",
                  "description": "Shelf ID"
                },
                "availability": {
                  "type": "number",
                  "description": "availability"
                },
                "image_url": {
                  "type": "string",
                  "description": "Image URL"
                },
                "stock": {
                  "type": "number",
                  "description": "Stock"
                },
                "subtitle": {
                  "type": "string",
                  "description": "Subtitle"
                },
                "title": {
                  "type": "string",
                  "description": "Title"
                },
                "prices": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number",
                        "description": "ID"
                      },
                      "product_id": {
                        "type": "number",
                        "description": "Product ID"
                      },
                      "description": {
                        "type": "string",
                        "description": "Description"
                      },
                      "net": {
                        "type": "number",
                        "description": "Net"
                      }
                    }
                  },
                  "description": "prices"
                },
                "vat_rate_id": {
                  "type": "number",
                  "description": "VAT rate ID"
                },
                "color_id": {
                  "type": "number",
                  "description": "Color ID"
                }
              }
            },
            "description": "products"
          }
        }
      },
      "description": "Merchant's shelves"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create_moto_payments": {
          "type": "boolean",
          "description": "Create MOTO payments"
        },
        "refund_transactions": {
          "type": "boolean",
          "description": "Refund transactions"
        }
      },
      "description": "User permissions"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Personal profile

Get personal profile
GET/v0.1/me/personal-profile

Get personal profile data

Required scope(s): user.profile, user.profile_readonly

Resource URL

GET https://api.sumup.com/v0.1/me/personal-profile
Response  200
HideShow
Body
{
  "first_name": "...",
  "last_name": "...",
  "date_of_birth": "...",
  "mobile_phone": "...",
  "national_id": "...",
  "address": {
    "address_line1": "...",
    "address_line2": "...",
    "city": "...",
    "country": "...",
    "region_id": 1,
    "region_name": "...",
    "region_code": "...",
    "post_code": "...",
    "landline": "...",
    "first_name": "...",
    "last_name": "...",
    "company": "...",
    "country_details": {
      "currency": "...",
      "iso_code": "...",
      "en_name": "...",
      "native_name": "..."
    },
    "timeoffset_details": {
      "post_code": "...",
      "offset": 1,
      "dst": true
    },
    "state_id": "..."
  }
}
Schema
{
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string",
      "description": "First name of the user"
    },
    "last_name": {
      "type": "string",
      "description": "Last name of the user"
    },
    "date_of_birth": {
      "type": "string",
      "description": "Date of birth"
    },
    "mobile_phone": {
      "type": "string",
      "description": "Mobile phone number"
    },
    "national_id": {
      "type": "string",
      "description": "National identification id. Country specific. Ex CPF (Brazil), DNI (Spain), PESEL (Poland)"
    },
    "address": {
      "type": "object",
      "properties": {
        "address_line1": {
          "type": "string",
          "description": "Address line 1"
        },
        "address_line2": {
          "type": "string",
          "description": "Address line 2"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "Country ISO 3166-1 code"
        },
        "region_id": {
          "type": "number",
          "description": "Country region id"
        },
        "region_name": {
          "type": "string",
          "description": "Region name"
        },
        "region_code": {
          "type": "string",
          "description": "Region code"
        },
        "post_code": {
          "type": "string",
          "description": "Postal code"
        },
        "landline": {
          "type": "string",
          "description": "Landline number"
        },
        "first_name": {
          "type": "string",
          "description": "undefined"
        },
        "last_name": {
          "type": "string",
          "description": "undefined"
        },
        "company": {
          "type": "string",
          "description": "undefined"
        },
        "country_details": {
          "type": "object",
          "properties": {
            "currency": {
              "type": "string",
              "description": "Currency ISO 4217 code"
            },
            "iso_code": {
              "type": "string",
              "description": "Country ISO code"
            },
            "en_name": {
              "type": "string",
              "description": "Country EN name"
            },
            "native_name": {
              "type": "string",
              "description": "Country native name"
            }
          },
          "description": "Country Details"
        },
        "timeoffset_details": {
          "type": "object",
          "properties": {
            "post_code": {
              "type": "string",
              "description": "Postal code"
            },
            "offset": {
              "type": "number",
              "description": "UTC offset"
            },
            "dst": {
              "type": "boolean",
              "description": "Daylight Saving Time"
            }
          },
          "description": "TimeOffset Details"
        },
        "state_id": {
          "type": "string",
          "description": "undefined"
        }
      },
      "description": "Account's personal address information"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Create personal profile
PUT/v0.1/me/personal-profile

Add personal profile data for an user

Required scope(s): user.profile

Resource URL

PUT https://api.sumup.com/v0.1/me/personal-profile
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "first_name": "...",
  "last_name": "...",
  "date_of_birth": "...",
  "mobile_phone": "...",
  "national_id": "...",
  "address": {
    "address_line1": "...",
    "address_line2": "...",
    "city": "...",
    "country": "...",
    "region_id": 1,
    "region_name": "...",
    "post_code": "...",
    "landline": "...",
    "first_name": "...",
    "last_name": "...",
    "company": "..."
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string",
      "description": "First name of the user"
    },
    "last_name": {
      "type": "string",
      "description": "Last name of the user"
    },
    "date_of_birth": {
      "type": "string",
      "description": "Date of birth"
    },
    "mobile_phone": {
      "type": "string",
      "description": "Mobile phone number"
    },
    "national_id": {
      "type": "string",
      "description": "National identification id. Country specific. Ex CPF (Brazil), DNI (Spain), PESEL (Poland)"
    },
    "address": {
      "type": "object",
      "properties": {
        "address_line1": {
          "type": "string",
          "description": "Address line 1"
        },
        "address_line2": {
          "type": "string",
          "description": "Address line 2"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "Country ISO 3166-1 code"
        },
        "region_id": {
          "type": "number",
          "description": "Country region id"
        },
        "region_name": {
          "type": "string",
          "description": "Country region name"
        },
        "post_code": {
          "type": "string",
          "description": "Postal code"
        },
        "landline": {
          "type": "string",
          "description": "Landline number"
        },
        "first_name": {
          "type": "string",
          "description": "First name"
        },
        "last_name": {
          "type": "string",
          "description": "Last name"
        },
        "company": {
          "type": "string",
          "description": "Company name"
        }
      },
      "required": [
        "address_line1",
        "city",
        "country",
        "post_code"
      ],
      "description": "Account's personal address"
    }
  },
  "required": [
    "first_name",
    "last_name",
    "date_of_birth",
    "address"
  ]
}
Response  200
HideShow
Body
{
  "first_name": "...",
  "last_name": "...",
  "date_of_birth": "...",
  "mobile_phone": "...",
  "national_id": "...",
  "address": {
    "address_line1": "...",
    "address_line2": "...",
    "city": "...",
    "country": "...",
    "region_id": 1,
    "region_name": "...",
    "region_code": "...",
    "post_code": "...",
    "landline": "...",
    "first_name": "...",
    "last_name": "...",
    "company": "...",
    "country_details": {
      "currency": "...",
      "iso_code": "...",
      "en_name": "...",
      "native_name": "..."
    },
    "timeoffset_details": {
      "post_code": "...",
      "offset": 1,
      "dst": true
    },
    "state_id": "..."
  }
}
Schema
{
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string",
      "description": "First name of the user"
    },
    "last_name": {
      "type": "string",
      "description": "Last name of the user"
    },
    "date_of_birth": {
      "type": "string",
      "description": "Date of birth"
    },
    "mobile_phone": {
      "type": "string",
      "description": "Mobile phone number"
    },
    "national_id": {
      "type": "string",
      "description": "National identification id. Country specific. Ex CPF (Brazil), DNI (Spain), PESEL (Poland)"
    },
    "address": {
      "type": "object",
      "properties": {
        "address_line1": {
          "type": "string",
          "description": "Address line 1"
        },
        "address_line2": {
          "type": "string",
          "description": "Address line 2"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "Country ISO 3166-1 code"
        },
        "region_id": {
          "type": "number",
          "description": "Country region id"
        },
        "region_name": {
          "type": "string",
          "description": "Region name"
        },
        "region_code": {
          "type": "string",
          "description": "Region code"
        },
        "post_code": {
          "type": "string",
          "description": "Postal code"
        },
        "landline": {
          "type": "string",
          "description": "Landline number"
        },
        "first_name": {
          "type": "string",
          "description": "undefined"
        },
        "last_name": {
          "type": "string",
          "description": "undefined"
        },
        "company": {
          "type": "string",
          "description": "undefined"
        },
        "country_details": {
          "type": "object",
          "properties": {
            "currency": {
              "type": "string",
              "description": "Currency ISO 4217 code"
            },
            "iso_code": {
              "type": "string",
              "description": "Country ISO code"
            },
            "en_name": {
              "type": "string",
              "description": "Country EN name"
            },
            "native_name": {
              "type": "string",
              "description": "Country native name"
            }
          },
          "description": "Country Details"
        },
        "timeoffset_details": {
          "type": "object",
          "properties": {
            "post_code": {
              "type": "string",
              "description": "Postal code"
            },
            "offset": {
              "type": "number",
              "description": "UTC offset"
            },
            "dst": {
              "type": "boolean",
              "description": "Daylight Saving Time"
            }
          },
          "description": "TimeOffset Details"
        },
        "state_id": {
          "type": "string",
          "description": "undefined"
        }
      },
      "description": "Account's personal address information"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow
Body
{
  "error_code": "ALREADY_EXISTS",
  "message": "Resource already exists"
}

Merchant profile

Get merchant profile
GET/v0.1/me/merchant-profile

Get merchant profile data

Required scope(s): user.profile, user.profile_readonly

Resource URL

GET https://api.sumup.com/v0.1/me/merchant-profile
Response  200
HideShow
Body
{
  "merchant_code": "...",
  "company_name": "...",
  "website": "...",
  "legal_type": {
    "id": 1,
    "description": "...",
    "sole_trader": true
  },
  "merchant_category_code": "...",
  "mobile_phone": "...",
  "company_registration_number": "...",
  "vat_id": "...",
  "permanent_certificate_access_code": "...",
  "nature_and_purpose": "...",
  "address": {
    "address_line1": "...",
    "address_line2": "...",
    "city": "...",
    "country": "...",
    "region_id": 1,
    "region_name": "...",
    "region_code": "...",
    "post_code": "...",
    "landline": "...",
    "first_name": "...",
    "last_name": "...",
    "company": "...",
    "country_details": {
      "currency": "...",
      "iso_code": "...",
      "en_name": "...",
      "native_name": "..."
    },
    "timeoffset_details": {
      "post_code": "...",
      "offset": 1,
      "dst": true
    },
    "state_id": "..."
  },
  "business_owners": [
    {
      "first_name": "...",
      "last_name": "...",
      "date_of_birth": "...",
      "mobile_phone": "...",
      "landline": "...",
      "ownership": 1
    }
  ],
  "doing_business_as": {
    "business_name": "...",
    "company_registration_number": "...",
    "vat_id": "...",
    "website": "...",
    "email": "...",
    "address": {
      "address_line1": "...",
      "address_line2": "...",
      "city": "...",
      "country": "...",
      "region_id": 1,
      "region_name": "...",
      "region_code": "...",
      "post_code": "...",
      "landline": "...",
      "first_name": "...",
      "last_name": "...",
      "company": "...",
      "country_details": {
        "currency": "...",
        "iso_code": "...",
        "en_name": "...",
        "native_name": "..."
      },
      "timeoffset_details": {
        "post_code": "...",
        "offset": 1,
        "dst": true
      },
      "state_id": "..."
    }
  },
  "settings": {
    "tax_enabled": true,
    "payout_type": "...",
    "payout_period": "...",
    "payout_on_demand_available": true,
    "payout_on_demand": true,
    "printers_enabled": true,
    "payout_instrument": "...",
    "moto_payment": true,
    "adyen_merchant_code": "...",
    "adyen_user": "...",
    "adyen_password": "...",
    "adyen_company": "..."
  },
  "vat_rates": {
    "id": 1,
    "description": "...",
    "rate": 1,
    "ordering": 1,
    "country": "..."
  },
  "shelves": [
    {
      "id": 1,
      "name": "...",
      "order": 1,
      "products": [
        {
          "id": 1,
          "shelf_id": 1,
          "availability": 1,
          "image_url": "...",
          "stock": 1,
          "subtitle": "...",
          "title": "...",
          "prices": [
            {
              "id": 1,
              "product_id": 1,
              "description": "...",
              "net": 1
            }
          ],
          "vat_rate_id": 1,
          "color_id": 1
        }
      ]
    }
  ],
  "bank_accounts": [
    {
      "bank_code": "...",
      "branch_code": "...",
      "swift": "...",
      "account_number": "...",
      "iban": "...",
      "account_type": "...",
      "account_holder_name": "...",
      "status": "...",
      "primary": true,
      "created_at": "...",
      "bank_name": "..."
    }
  ],
  "extdev": true,
  "payout_zone_migrated": true
}
Schema
{
  "type": "object",
  "properties": {
    "merchant_code": {
      "type": "string",
      "description": "Unique identifying code of the merchant profile"
    },
    "company_name": {
      "type": "string",
      "description": "Company name"
    },
    "website": {
      "type": "string",
      "description": "Website"
    },
    "legal_type": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Unique id"
        },
        "description": {
          "type": "string",
          "description": "Legal type"
        },
        "sole_trader": {
          "type": "boolean",
          "description": "Sole trader legal type if true"
        }
      },
      "description": "Id of the legal type of the merchant profile"
    },
    "merchant_category_code": {
      "type": "string",
      "description": "Merchant category code"
    },
    "mobile_phone": {
      "type": "string",
      "description": "Mobile phone number"
    },
    "company_registration_number": {
      "type": "string",
      "description": "Company registration number"
    },
    "vat_id": {
      "type": "string",
      "description": "Vat ID"
    },
    "permanent_certificate_access_code": {
      "type": "string",
      "description": "Permanent certificate access code (Portugal)"
    },
    "nature_and_purpose": {
      "type": "string",
      "description": "Nature and purpose of the business"
    },
    "address": {
      "type": "object",
      "properties": {
        "address_line1": {
          "type": "string",
          "description": "Address line 1"
        },
        "address_line2": {
          "type": "string",
          "description": "Address line 2"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "Country ISO 3166-1 code"
        },
        "region_id": {
          "type": "number",
          "description": "Country region id"
        },
        "region_name": {
          "type": "string",
          "description": "Region name"
        },
        "region_code": {
          "type": "string",
          "description": "Region code"
        },
        "post_code": {
          "type": "string",
          "description": "Postal code"
        },
        "landline": {
          "type": "string",
          "description": "Landline number"
        },
        "first_name": {
          "type": "string",
          "description": "undefined"
        },
        "last_name": {
          "type": "string",
          "description": "undefined"
        },
        "company": {
          "type": "string",
          "description": "undefined"
        },
        "country_details": {
          "type": "object",
          "properties": {
            "currency": {
              "type": "string",
              "description": "Currency ISO 4217 code"
            },
            "iso_code": {
              "type": "string",
              "description": "Country ISO code"
            },
            "en_name": {
              "type": "string",
              "description": "Country EN name"
            },
            "native_name": {
              "type": "string",
              "description": "Country native name"
            }
          },
          "description": "Country Details"
        },
        "timeoffset_details": {
          "type": "object",
          "properties": {
            "post_code": {
              "type": "string",
              "description": "Postal code"
            },
            "offset": {
              "type": "number",
              "description": "UTC offset"
            },
            "dst": {
              "type": "boolean",
              "description": "Daylight Saving Time"
            }
          },
          "description": "TimeOffset Details"
        },
        "state_id": {
          "type": "string",
          "description": "undefined"
        }
      },
      "description": "Account's business address information"
    },
    "business_owners": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "first_name": {
            "type": "string",
            "description": "BO's first name"
          },
          "last_name": {
            "type": "string",
            "description": "BO's last name of the user"
          },
          "date_of_birth": {
            "type": "string",
            "description": "\"Date of birth\""
          },
          "mobile_phone": {
            "type": "string",
            "description": "Mobile phone number"
          },
          "landline": {
            "type": "string",
            "description": "BO's Landline"
          },
          "ownership": {
            "type": "number",
            "description": "Ownership percentage"
          }
        }
      },
      "description": "Account's business address information"
    },
    "doing_business_as": {
      "type": "object",
      "properties": {
        "business_name": {
          "type": "string",
          "description": "Doing business as name"
        },
        "company_registration_number": {
          "type": "string",
          "description": "Doing business as company registration number"
        },
        "vat_id": {
          "type": "string",
          "description": "Doing business as vat id"
        },
        "website": {
          "type": "string",
          "description": "Doing business as website"
        },
        "email": {
          "type": "string",
          "description": "Doing business as email"
        },
        "address": {
          "type": "object",
          "properties": {
            "address_line1": {
              "type": "string",
              "description": "Address line 1"
            },
            "address_line2": {
              "type": "string",
              "description": "Address line 2"
            },
            "city": {
              "type": "string",
              "description": "City"
            },
            "country": {
              "type": "string",
              "description": "Country ISO 3166-1 code"
            },
            "region_id": {
              "type": "number",
              "description": "Country region id"
            },
            "region_name": {
              "type": "string",
              "description": "Region name"
            },
            "region_code": {
              "type": "string",
              "description": "Region code"
            },
            "post_code": {
              "type": "string",
              "description": "Postal code"
            },
            "landline": {
              "type": "string",
              "description": "Landline number"
            },
            "first_name": {
              "type": "string",
              "description": "undefined"
            },
            "last_name": {
              "type": "string",
              "description": "undefined"
            },
            "company": {
              "type": "string",
              "description": "undefined"
            },
            "country_details": {
              "type": "object",
              "properties": {
                "currency": {
                  "type": "string",
                  "description": "Currency ISO 4217 code"
                },
                "iso_code": {
                  "type": "string",
                  "description": "Country ISO code"
                },
                "en_name": {
                  "type": "string",
                  "description": "Country EN name"
                },
                "native_name": {
                  "type": "string",
                  "description": "Country native name"
                }
              },
              "description": "Country Details"
            },
            "timeoffset_details": {
              "type": "object",
              "properties": {
                "post_code": {
                  "type": "string",
                  "description": "Postal code"
                },
                "offset": {
                  "type": "number",
                  "description": "UTC offset"
                },
                "dst": {
                  "type": "boolean",
                  "description": "Daylight Saving Time"
                }
              },
              "description": "TimeOffset Details"
            },
            "state_id": {
              "type": "string",
              "description": "undefined"
            }
          },
          "description": "Doing business as address"
        }
      },
      "description": "Doing Business As information"
    },
    "settings": {
      "type": "object",
      "properties": {
        "tax_enabled": {
          "type": "boolean",
          "description": "Whether to show tax in receipts (saved per transaction)"
        },
        "payout_type": {
          "type": "string",
          "description": "Payout type"
        },
        "payout_period": {
          "type": "string",
          "description": "Payout frequency"
        },
        "payout_on_demand_available": {
          "type": "boolean",
          "description": "Whether merchant can edit payouts on demand"
        },
        "payout_on_demand": {
          "type": "boolean",
          "description": "Whether merchant will receive payouts on demand"
        },
        "printers_enabled": {
          "type": "boolean",
          "description": "Whether to show printers in mobile app"
        },
        "payout_instrument": {
          "type": "string",
          "description": "Payout Instrument"
        },
        "moto_payment": {
          "type": "boolean",
          "description": "Whether merchant can make MOTO payments"
        },
        "adyen_merchant_code": {
          "type": "string",
          "description": "Adyen merchant code"
        },
        "adyen_user": {
          "type": "string",
          "description": "Adyen username"
        },
        "adyen_password": {
          "type": "string",
          "description": "Adyen password"
        },
        "adyen_company": {
          "type": "string",
          "description": "Adyen company"
        }
      },
      "description": "Merchant settings (like \"payout_type\", \"payout_period\")"
    },
    "vat_rates": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Internal ID"
        },
        "description": {
          "type": "string",
          "description": "Description"
        },
        "rate": {
          "type": "number",
          "description": "Rate"
        },
        "ordering": {
          "type": "number",
          "description": "Ordering"
        },
        "country": {
          "type": "string",
          "description": "Country ISO code"
        }
      },
      "description": "Merchant VAT rates"
    },
    "shelves": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Internal ID"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "order": {
            "type": "number",
            "description": "Order"
          },
          "products": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "Internal ID"
                },
                "shelf_id": {
                  "type": "number",
                  "description": "Shelf ID"
                },
                "availability": {
                  "type": "number",
                  "description": "availability"
                },
                "image_url": {
                  "type": "string",
                  "description": "Image URL"
                },
                "stock": {
                  "type": "number",
                  "description": "Stock"
                },
                "subtitle": {
                  "type": "string",
                  "description": "Subtitle"
                },
                "title": {
                  "type": "string",
                  "description": "Title"
                },
                "prices": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number",
                        "description": "ID"
                      },
                      "product_id": {
                        "type": "number",
                        "description": "Product ID"
                      },
                      "description": {
                        "type": "string",
                        "description": "Description"
                      },
                      "net": {
                        "type": "number",
                        "description": "Net"
                      }
                    }
                  },
                  "description": "prices"
                },
                "vat_rate_id": {
                  "type": "number",
                  "description": "VAT rate ID"
                },
                "color_id": {
                  "type": "number",
                  "description": "Color ID"
                }
              }
            },
            "description": "products"
          }
        }
      },
      "description": "Merchant Shelves"
    },
    "bank_accounts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bank_code": {
            "type": "string",
            "description": "Bank code"
          },
          "branch_code": {
            "type": "string",
            "description": "Branch code"
          },
          "swift": {
            "type": "string",
            "description": "SWIFT code"
          },
          "account_number": {
            "type": "string",
            "description": "Account number"
          },
          "iban": {
            "type": "string",
            "description": "IBAN"
          },
          "account_type": {
            "type": "string",
            "description": "Type of the account"
          },
          "account_holder_name": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "description": "Status in the verification process"
          },
          "primary": {
            "type": "boolean",
            "description": "The primary bank account is the one used for settlemnts"
          },
          "created_at": {
            "type": "string",
            "description": "Creation date of the bank account"
          },
          "bank_name": {
            "type": "string",
            "description": "Bank name"
          }
        }
      },
      "description": "A list of bank accounts"
    },
    "extdev": {
      "type": "boolean",
      "description": "True if the merchant is extdev"
    },
    "payout_zone_migrated": {
      "type": "boolean",
      "description": "True if the payout zone of this merchant is migrated"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Create merchant profile
PUT/v0.1/me/merchant-profile

Creates merchant profile

Required scope(s): user.profile

Resource URL

PUT https://api.sumup.com/v0.1/me/merchant-profile
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "legal_type_id": 1,
  "merchant_category_code": "...",
  "company_name": "...",
  "company_registration_number": "...",
  "vat_id": "...",
  "permanent_certificate_access_code": "...",
  "website": "...",
  "nature_and_purpose": "...",
  "mobile_phone": "...",
  "address": {
    "address_line1": "...",
    "address_line2": "...",
    "city": "...",
    "country": "...",
    "region_id": 1,
    "region_name": "...",
    "post_code": "...",
    "landline": "...",
    "first_name": "...",
    "last_name": "...",
    "company": "..."
  },
  "doing_business_as": {
    "business_name": "...",
    "tax_id": "...",
    "vat_id": "...",
    "website": "...",
    "email": "...",
    "address": {
      "address_line1": "...",
      "address_line2": "...",
      "city": "...",
      "country": "...",
      "region_id": 1,
      "region_name": "...",
      "post_code": "...",
      "landline": "...",
      "first_name": "...",
      "last_name": "...",
      "company": "..."
    }
  },
  "business_owners": [
    {
      "first_name": "...",
      "last_name": "...",
      "date_of_birth": "...",
      "mobile_phone": "...",
      "landline": "...",
      "ownership": 1,
      "country": "..."
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "legal_type_id": {
      "type": "number",
      "description": "Id of the legal type of the merchant"
    },
    "merchant_category_code": {
      "type": "string",
      "description": "Merchant category code"
    },
    "company_name": {
      "type": "string",
      "description": "Company name"
    },
    "company_registration_number": {
      "type": "string",
      "description": "Company registration number"
    },
    "vat_id": {
      "type": "string",
      "description": "null"
    },
    "permanent_certificate_access_code": {
      "type": "string",
      "description": "null"
    },
    "website": {
      "type": "string",
      "description": "Company website"
    },
    "nature_and_purpose": {
      "type": "string",
      "description": "Nature and purpose of the business. Required for the following merchant category codes: 5999, 7392, 8999, 5694, 5969, 7299, 7399"
    },
    "mobile_phone": {
      "type": "string",
      "description": "Mobile number"
    },
    "address": {
      "type": "object",
      "properties": {
        "address_line1": {
          "type": "string",
          "description": "Address line 1"
        },
        "address_line2": {
          "type": "string",
          "description": "Address line 2"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "Country ISO 3166-1 code"
        },
        "region_id": {
          "type": "number",
          "description": "Country region id"
        },
        "region_name": {
          "type": "string",
          "description": "Country region name"
        },
        "post_code": {
          "type": "string",
          "description": "Postal code"
        },
        "landline": {
          "type": "string",
          "description": "Landline number"
        },
        "first_name": {
          "type": "string",
          "description": "First name"
        },
        "last_name": {
          "type": "string",
          "description": "Last name"
        },
        "company": {
          "type": "string",
          "description": "Company name"
        }
      },
      "required": [
        "address_line1",
        "city",
        "country",
        "post_code"
      ],
      "description": "User's business address information"
    },
    "doing_business_as": {
      "type": "object",
      "properties": {
        "business_name": {
          "type": "string",
          "description": "Doing business as name"
        },
        "tax_id": {
          "type": "string",
          "description": "Doing business as Tax ID"
        },
        "vat_id": {
          "type": "string",
          "description": "Doing business as Vat ID"
        },
        "website": {
          "type": "string",
          "description": "Doing business as website"
        },
        "email": {
          "type": "string",
          "description": "Doing business as email"
        },
        "address": {
          "type": "object",
          "properties": {
            "address_line1": {
              "type": "string",
              "description": "Address line 1"
            },
            "address_line2": {
              "type": "string",
              "description": "Address line 2"
            },
            "city": {
              "type": "string",
              "description": "City"
            },
            "country": {
              "type": "string",
              "description": "Country ISO 3166-1 code"
            },
            "region_id": {
              "type": "number",
              "description": "Country region id"
            },
            "region_name": {
              "type": "string",
              "description": "Country region name"
            },
            "post_code": {
              "type": "string",
              "description": "Postal code"
            },
            "landline": {
              "type": "string",
              "description": "Landline number"
            },
            "first_name": {
              "type": "string",
              "description": "First name"
            },
            "last_name": {
              "type": "string",
              "description": "Last name"
            },
            "company": {
              "type": "string",
              "description": "Company name"
            }
          },
          "required": [
            "address_line1",
            "city",
            "country",
            "post_code"
          ],
          "description": "Doing business as address"
        }
      },
      "description": "Doing Business As"
    },
    "business_owners": {
      "type": "array",
      "description": "null"
    }
  },
  "required": [
    "legal_type_id",
    "merchant_category_code",
    "company_name",
    "address"
  ]
}
Response  200
HideShow
Body
{
  "merchant_code": "...",
  "company_name": "...",
  "website": "...",
  "legal_type": {
    "id": 1,
    "description": "...",
    "sole_trader": true
  },
  "merchant_category_code": "...",
  "mobile_phone": "...",
  "company_registration_number": "...",
  "vat_id": "...",
  "permanent_certificate_access_code": "...",
  "nature_and_purpose": "...",
  "address": {
    "address_line1": "...",
    "address_line2": "...",
    "city": "...",
    "country": "...",
    "region_id": 1,
    "region_name": "...",
    "region_code": "...",
    "post_code": "...",
    "landline": "...",
    "first_name": "...",
    "last_name": "...",
    "company": "...",
    "country_details": {
      "currency": "...",
      "iso_code": "...",
      "en_name": "...",
      "native_name": "..."
    },
    "timeoffset_details": {
      "post_code": "...",
      "offset": 1,
      "dst": true
    },
    "state_id": "..."
  },
  "business_owners": [
    {
      "first_name": "...",
      "last_name": "...",
      "date_of_birth": "...",
      "mobile_phone": "...",
      "landline": "...",
      "ownership": 1
    }
  ],
  "doing_business_as": {
    "business_name": "...",
    "company_registration_number": "...",
    "vat_id": "...",
    "website": "...",
    "email": "...",
    "address": {
      "address_line1": "...",
      "address_line2": "...",
      "city": "...",
      "country": "...",
      "region_id": 1,
      "region_name": "...",
      "region_code": "...",
      "post_code": "...",
      "landline": "...",
      "first_name": "...",
      "last_name": "...",
      "company": "...",
      "country_details": {
        "currency": "...",
        "iso_code": "...",
        "en_name": "...",
        "native_name": "..."
      },
      "timeoffset_details": {
        "post_code": "...",
        "offset": 1,
        "dst": true
      },
      "state_id": "..."
    }
  },
  "settings": {
    "tax_enabled": true,
    "payout_type": "...",
    "payout_period": "...",
    "payout_on_demand_available": true,
    "payout_on_demand": true,
    "printers_enabled": true,
    "payout_instrument": "...",
    "moto_payment": true,
    "adyen_merchant_code": "...",
    "adyen_user": "...",
    "adyen_password": "...",
    "adyen_company": "..."
  },
  "vat_rates": {
    "id": 1,
    "description": "...",
    "rate": 1,
    "ordering": 1,
    "country": "..."
  },
  "shelves": [
    {
      "id": 1,
      "name": "...",
      "order": 1,
      "products": [
        {
          "id": 1,
          "shelf_id": 1,
          "availability": 1,
          "image_url": "...",
          "stock": 1,
          "subtitle": "...",
          "title": "...",
          "prices": [
            {
              "id": 1,
              "product_id": 1,
              "description": "...",
              "net": 1
            }
          ],
          "vat_rate_id": 1,
          "color_id": 1
        }
      ]
    }
  ],
  "bank_accounts": [
    {
      "bank_code": "...",
      "branch_code": "...",
      "swift": "...",
      "account_number": "...",
      "iban": "...",
      "account_type": "...",
      "account_holder_name": "...",
      "status": "...",
      "primary": true,
      "created_at": "...",
      "bank_name": "..."
    }
  ],
  "extdev": true,
  "payout_zone_migrated": true
}
Schema
{
  "type": "object",
  "properties": {
    "merchant_code": {
      "type": "string",
      "description": "Unique identifying code of the merchant profile"
    },
    "company_name": {
      "type": "string",
      "description": "Company name"
    },
    "website": {
      "type": "string",
      "description": "Website"
    },
    "legal_type": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Unique id"
        },
        "description": {
          "type": "string",
          "description": "Legal type"
        },
        "sole_trader": {
          "type": "boolean",
          "description": "Sole trader legal type if true"
        }
      },
      "description": "Id of the legal type of the merchant profile"
    },
    "merchant_category_code": {
      "type": "string",
      "description": "Merchant category code"
    },
    "mobile_phone": {
      "type": "string",
      "description": "Mobile phone number"
    },
    "company_registration_number": {
      "type": "string",
      "description": "Company registration number"
    },
    "vat_id": {
      "type": "string",
      "description": "Vat ID"
    },
    "permanent_certificate_access_code": {
      "type": "string",
      "description": "Permanent certificate access code (Portugal)"
    },
    "nature_and_purpose": {
      "type": "string",
      "description": "Nature and purpose of the business"
    },
    "address": {
      "type": "object",
      "properties": {
        "address_line1": {
          "type": "string",
          "description": "Address line 1"
        },
        "address_line2": {
          "type": "string",
          "description": "Address line 2"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "Country ISO 3166-1 code"
        },
        "region_id": {
          "type": "number",
          "description": "Country region id"
        },
        "region_name": {
          "type": "string",
          "description": "Region name"
        },
        "region_code": {
          "type": "string",
          "description": "Region code"
        },
        "post_code": {
          "type": "string",
          "description": "Postal code"
        },
        "landline": {
          "type": "string",
          "description": "Landline number"
        },
        "first_name": {
          "type": "string",
          "description": "undefined"
        },
        "last_name": {
          "type": "string",
          "description": "undefined"
        },
        "company": {
          "type": "string",
          "description": "undefined"
        },
        "country_details": {
          "type": "object",
          "properties": {
            "currency": {
              "type": "string",
              "description": "Currency ISO 4217 code"
            },
            "iso_code": {
              "type": "string",
              "description": "Country ISO code"
            },
            "en_name": {
              "type": "string",
              "description": "Country EN name"
            },
            "native_name": {
              "type": "string",
              "description": "Country native name"
            }
          },
          "description": "Country Details"
        },
        "timeoffset_details": {
          "type": "object",
          "properties": {
            "post_code": {
              "type": "string",
              "description": "Postal code"
            },
            "offset": {
              "type": "number",
              "description": "UTC offset"
            },
            "dst": {
              "type": "boolean",
              "description": "Daylight Saving Time"
            }
          },
          "description": "TimeOffset Details"
        },
        "state_id": {
          "type": "string",
          "description": "undefined"
        }
      },
      "description": "Account's business address information"
    },
    "business_owners": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "first_name": {
            "type": "string",
            "description": "BO's first name"
          },
          "last_name": {
            "type": "string",
            "description": "BO's last name of the user"
          },
          "date_of_birth": {
            "type": "string",
            "description": "\"Date of birth\""
          },
          "mobile_phone": {
            "type": "string",
            "description": "Mobile phone number"
          },
          "landline": {
            "type": "string",
            "description": "BO's Landline"
          },
          "ownership": {
            "type": "number",
            "description": "Ownership percentage"
          }
        }
      },
      "description": "Account's business address information"
    },
    "doing_business_as": {
      "type": "object",
      "properties": {
        "business_name": {
          "type": "string",
          "description": "Doing business as name"
        },
        "company_registration_number": {
          "type": "string",
          "description": "Doing business as company registration number"
        },
        "vat_id": {
          "type": "string",
          "description": "Doing business as vat id"
        },
        "website": {
          "type": "string",
          "description": "Doing business as website"
        },
        "email": {
          "type": "string",
          "description": "Doing business as email"
        },
        "address": {
          "type": "object",
          "properties": {
            "address_line1": {
              "type": "string",
              "description": "Address line 1"
            },
            "address_line2": {
              "type": "string",
              "description": "Address line 2"
            },
            "city": {
              "type": "string",
              "description": "City"
            },
            "country": {
              "type": "string",
              "description": "Country ISO 3166-1 code"
            },
            "region_id": {
              "type": "number",
              "description": "Country region id"
            },
            "region_name": {
              "type": "string",
              "description": "Region name"
            },
            "region_code": {
              "type": "string",
              "description": "Region code"
            },
            "post_code": {
              "type": "string",
              "description": "Postal code"
            },
            "landline": {
              "type": "string",
              "description": "Landline number"
            },
            "first_name": {
              "type": "string",
              "description": "undefined"
            },
            "last_name": {
              "type": "string",
              "description": "undefined"
            },
            "company": {
              "type": "string",
              "description": "undefined"
            },
            "country_details": {
              "type": "object",
              "properties": {
                "currency": {
                  "type": "string",
                  "description": "Currency ISO 4217 code"
                },
                "iso_code": {
                  "type": "string",
                  "description": "Country ISO code"
                },
                "en_name": {
                  "type": "string",
                  "description": "Country EN name"
                },
                "native_name": {
                  "type": "string",
                  "description": "Country native name"
                }
              },
              "description": "Country Details"
            },
            "timeoffset_details": {
              "type": "object",
              "properties": {
                "post_code": {
                  "type": "string",
                  "description": "Postal code"
                },
                "offset": {
                  "type": "number",
                  "description": "UTC offset"
                },
                "dst": {
                  "type": "boolean",
                  "description": "Daylight Saving Time"
                }
              },
              "description": "TimeOffset Details"
            },
            "state_id": {
              "type": "string",
              "description": "undefined"
            }
          },
          "description": "Doing business as address"
        }
      },
      "description": "Doing Business As information"
    },
    "settings": {
      "type": "object",
      "properties": {
        "tax_enabled": {
          "type": "boolean",
          "description": "Whether to show tax in receipts (saved per transaction)"
        },
        "payout_type": {
          "type": "string",
          "description": "Payout type"
        },
        "payout_period": {
          "type": "string",
          "description": "Payout frequency"
        },
        "payout_on_demand_available": {
          "type": "boolean",
          "description": "Whether merchant can edit payouts on demand"
        },
        "payout_on_demand": {
          "type": "boolean",
          "description": "Whether merchant will receive payouts on demand"
        },
        "printers_enabled": {
          "type": "boolean",
          "description": "Whether to show printers in mobile app"
        },
        "payout_instrument": {
          "type": "string",
          "description": "Payout Instrument"
        },
        "moto_payment": {
          "type": "boolean",
          "description": "Whether merchant can make MOTO payments"
        },
        "adyen_merchant_code": {
          "type": "string",
          "description": "Adyen merchant code"
        },
        "adyen_user": {
          "type": "string",
          "description": "Adyen username"
        },
        "adyen_password": {
          "type": "string",
          "description": "Adyen password"
        },
        "adyen_company": {
          "type": "string",
          "description": "Adyen company"
        }
      },
      "description": "Merchant settings (like \"payout_type\", \"payout_period\")"
    },
    "vat_rates": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Internal ID"
        },
        "description": {
          "type": "string",
          "description": "Description"
        },
        "rate": {
          "type": "number",
          "description": "Rate"
        },
        "ordering": {
          "type": "number",
          "description": "Ordering"
        },
        "country": {
          "type": "string",
          "description": "Country ISO code"
        }
      },
      "description": "Merchant VAT rates"
    },
    "shelves": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Internal ID"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "order": {
            "type": "number",
            "description": "Order"
          },
          "products": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "Internal ID"
                },
                "shelf_id": {
                  "type": "number",
                  "description": "Shelf ID"
                },
                "availability": {
                  "type": "number",
                  "description": "availability"
                },
                "image_url": {
                  "type": "string",
                  "description": "Image URL"
                },
                "stock": {
                  "type": "number",
                  "description": "Stock"
                },
                "subtitle": {
                  "type": "string",
                  "description": "Subtitle"
                },
                "title": {
                  "type": "string",
                  "description": "Title"
                },
                "prices": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number",
                        "description": "ID"
                      },
                      "product_id": {
                        "type": "number",
                        "description": "Product ID"
                      },
                      "description": {
                        "type": "string",
                        "description": "Description"
                      },
                      "net": {
                        "type": "number",
                        "description": "Net"
                      }
                    }
                  },
                  "description": "prices"
                },
                "vat_rate_id": {
                  "type": "number",
                  "description": "VAT rate ID"
                },
                "color_id": {
                  "type": "number",
                  "description": "Color ID"
                }
              }
            },
            "description": "products"
          }
        }
      },
      "description": "Merchant Shelves"
    },
    "bank_accounts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bank_code": {
            "type": "string",
            "description": "Bank code"
          },
          "branch_code": {
            "type": "string",
            "description": "Branch code"
          },
          "swift": {
            "type": "string",
            "description": "SWIFT code"
          },
          "account_number": {
            "type": "string",
            "description": "Account number"
          },
          "iban": {
            "type": "string",
            "description": "IBAN"
          },
          "account_type": {
            "type": "string",
            "description": "Type of the account"
          },
          "account_holder_name": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "description": "Status in the verification process"
          },
          "primary": {
            "type": "boolean",
            "description": "The primary bank account is the one used for settlemnts"
          },
          "created_at": {
            "type": "string",
            "description": "Creation date of the bank account"
          },
          "bank_name": {
            "type": "string",
            "description": "Bank name"
          }
        }
      },
      "description": "A list of bank accounts"
    },
    "extdev": {
      "type": "boolean",
      "description": "True if the merchant is extdev"
    },
    "payout_zone_migrated": {
      "type": "boolean",
      "description": "True if the payout zone of this merchant is migrated"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow
Body
{
  "error_code": "ALREADY_EXISTS",
  "message": "Resource already exists"
}

Doing Business As

Get DBA
GET/v0.1/me/merchant-profile/doing-business-as

Get Doing Business As profile

Required scope(s): user.profile, user.profile_readonly

Resource URL

GET https://api.sumup.com/v0.1/me/merchant-profile/doing-business-as
Response  200
HideShow
Body
{
  "business_name": "...",
  "company_registration_number": "...",
  "vat_id": "...",
  "website": "...",
  "email": "...",
  "address": {
    "address_line1": "...",
    "address_line2": "...",
    "city": "...",
    "country": "...",
    "region_id": 1,
    "region_name": "...",
    "region_code": "...",
    "post_code": "...",
    "landline": "...",
    "first_name": "...",
    "last_name": "...",
    "company": "...",
    "country_details": {
      "currency": "...",
      "iso_code": "...",
      "en_name": "...",
      "native_name": "..."
    },
    "timeoffset_details": {
      "post_code": "...",
      "offset": 1,
      "dst": true
    },
    "state_id": "..."
  }
}
Schema
{
  "type": "object",
  "properties": {
    "business_name": {
      "type": "string",
      "description": "Doing business as name"
    },
    "company_registration_number": {
      "type": "string",
      "description": "Doing business as company registration number"
    },
    "vat_id": {
      "type": "string",
      "description": "Doing business as vat id"
    },
    "website": {
      "type": "string",
      "description": "Doing business as website"
    },
    "email": {
      "type": "string",
      "description": "Doing business as email"
    },
    "address": {
      "type": "object",
      "properties": {
        "address_line1": {
          "type": "string",
          "description": "Address line 1"
        },
        "address_line2": {
          "type": "string",
          "description": "Address line 2"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "Country ISO 3166-1 code"
        },
        "region_id": {
          "type": "number",
          "description": "Country region id"
        },
        "region_name": {
          "type": "string",
          "description": "Region name"
        },
        "region_code": {
          "type": "string",
          "description": "Region code"
        },
        "post_code": {
          "type": "string",
          "description": "Postal code"
        },
        "landline": {
          "type": "string",
          "description": "Landline number"
        },
        "first_name": {
          "type": "string",
          "description": "undefined"
        },
        "last_name": {
          "type": "string",
          "description": "undefined"
        },
        "company": {
          "type": "string",
          "description": "undefined"
        },
        "country_details": {
          "type": "object",
          "properties": {
            "currency": {
              "type": "string",
              "description": "Currency ISO 4217 code"
            },
            "iso_code": {
              "type": "string",
              "description": "Country ISO code"
            },
            "en_name": {
              "type": "string",
              "description": "Country EN name"
            },
            "native_name": {
              "type": "string",
              "description": "Country native name"
            }
          },
          "description": "Country Details"
        },
        "timeoffset_details": {
          "type": "object",
          "properties": {
            "post_code": {
              "type": "string",
              "description": "Postal code"
            },
            "offset": {
              "type": "number",
              "description": "UTC offset"
            },
            "dst": {
              "type": "boolean",
              "description": "Daylight Saving Time"
            }
          },
          "description": "TimeOffset Details"
        },
        "state_id": {
          "type": "string",
          "description": "undefined"
        }
      },
      "description": "Doing business as address"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Edit DBA
PUT/v0.1/me/merchant-profile/doing-business-as

Create or Update Doing Business As profile

Required scope(s): user.profile

Resource URL

PUT https://api.sumup.com/v0.1/me/merchant-profile/doing-business-as
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "business_name": "...",
  "tax_id": "...",
  "vat_id": "...",
  "website": "...",
  "email": "...",
  "address": {
    "address_line1": "...",
    "address_line2": "...",
    "city": "...",
    "country": "...",
    "region_id": 1,
    "region_name": "...",
    "post_code": "...",
    "landline": "...",
    "first_name": "...",
    "last_name": "...",
    "company": "..."
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "business_name": {
      "type": "string",
      "description": "Doing business as name"
    },
    "tax_id": {
      "type": "string",
      "description": "Doing business as Tax ID"
    },
    "vat_id": {
      "type": "string",
      "description": "Doing business as Vat ID"
    },
    "website": {
      "type": "string",
      "description": "Doing business as website"
    },
    "email": {
      "type": "string",
      "description": "Doing business as email"
    },
    "address": {
      "type": "object",
      "properties": {
        "address_line1": {
          "type": "string",
          "description": "Address line 1"
        },
        "address_line2": {
          "type": "string",
          "description": "Address line 2"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "Country ISO 3166-1 code"
        },
        "region_id": {
          "type": "number",
          "description": "Country region id"
        },
        "region_name": {
          "type": "string",
          "description": "Country region name"
        },
        "post_code": {
          "type": "string",
          "description": "Postal code"
        },
        "landline": {
          "type": "string",
          "description": "Landline number"
        },
        "first_name": {
          "type": "string",
          "description": "First name"
        },
        "last_name": {
          "type": "string",
          "description": "Last name"
        },
        "company": {
          "type": "string",
          "description": "Company name"
        }
      },
      "required": [
        "address_line1",
        "city",
        "country",
        "post_code"
      ],
      "description": "Doing business as address"
    }
  }
}
Response  200
HideShow
Body
{
  "business_name": "...",
  "company_registration_number": "...",
  "vat_id": "...",
  "website": "...",
  "email": "...",
  "address": {
    "address_line1": "...",
    "address_line2": "...",
    "city": "...",
    "country": "...",
    "region_id": 1,
    "region_name": "...",
    "region_code": "...",
    "post_code": "...",
    "landline": "...",
    "first_name": "...",
    "last_name": "...",
    "company": "...",
    "country_details": {
      "currency": "...",
      "iso_code": "...",
      "en_name": "...",
      "native_name": "..."
    },
    "timeoffset_details": {
      "post_code": "...",
      "offset": 1,
      "dst": true
    },
    "state_id": "..."
  }
}
Schema
{
  "type": "object",
  "properties": {
    "business_name": {
      "type": "string",
      "description": "Doing business as name"
    },
    "company_registration_number": {
      "type": "string",
      "description": "Doing business as company registration number"
    },
    "vat_id": {
      "type": "string",
      "description": "Doing business as vat id"
    },
    "website": {
      "type": "string",
      "description": "Doing business as website"
    },
    "email": {
      "type": "string",
      "description": "Doing business as email"
    },
    "address": {
      "type": "object",
      "properties": {
        "address_line1": {
          "type": "string",
          "description": "Address line 1"
        },
        "address_line2": {
          "type": "string",
          "description": "Address line 2"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "Country ISO 3166-1 code"
        },
        "region_id": {
          "type": "number",
          "description": "Country region id"
        },
        "region_name": {
          "type": "string",
          "description": "Region name"
        },
        "region_code": {
          "type": "string",
          "description": "Region code"
        },
        "post_code": {
          "type": "string",
          "description": "Postal code"
        },
        "landline": {
          "type": "string",
          "description": "Landline number"
        },
        "first_name": {
          "type": "string",
          "description": "undefined"
        },
        "last_name": {
          "type": "string",
          "description": "undefined"
        },
        "company": {
          "type": "string",
          "description": "undefined"
        },
        "country_details": {
          "type": "object",
          "properties": {
            "currency": {
              "type": "string",
              "description": "Currency ISO 4217 code"
            },
            "iso_code": {
              "type": "string",
              "description": "Country ISO code"
            },
            "en_name": {
              "type": "string",
              "description": "Country EN name"
            },
            "native_name": {
              "type": "string",
              "description": "Country native name"
            }
          },
          "description": "Country Details"
        },
        "timeoffset_details": {
          "type": "object",
          "properties": {
            "post_code": {
              "type": "string",
              "description": "Postal code"
            },
            "offset": {
              "type": "number",
              "description": "UTC offset"
            },
            "dst": {
              "type": "boolean",
              "description": "Daylight Saving Time"
            }
          },
          "description": "TimeOffset Details"
        },
        "state_id": {
          "type": "string",
          "description": "undefined"
        }
      },
      "description": "Doing business as address"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  409
HideShow
Body
{"error_code":"merchant_account_missing","message":"Operation cannot be applied on missing merchant profile. Create merchant profile first."}
<p>&nbsp;</p>

Manage payouts

Bank account

Get Bank Accounts
GET/v0.1/me/merchant-profile/bank-accounts

Get bank accounts of the merchant. If you only want the primary account(the one used for settlements) use primary=true filter.

Required scope(s): user.payout-settings, user.profile, user.profile_readonly

Resource URL

GET https://api.sumup.com/v0.1/me/merchant-profile/bank-accounts
Parameters
HideShow
primary
boolean (optional) 

If true will return only the primary bank account

Response  200
HideShow
Body
{
  "bank_code": "...",
  "branch_code": "...",
  "swift": "...",
  "account_number": "...",
  "iban": "...",
  "account_type": "...",
  "account_holder_name": "...",
  "status": "...",
  "primary": true,
  "created_at": "...",
  "bank_name": "..."
}
Schema
{
  "type": "object",
  "properties": {
    "bank_code": {
      "type": "string",
      "description": "Bank code"
    },
    "branch_code": {
      "type": "string",
      "description": "Branch code"
    },
    "swift": {
      "type": "string",
      "description": "SWIFT code"
    },
    "account_number": {
      "type": "string",
      "description": "Account number"
    },
    "iban": {
      "type": "string",
      "description": "IBAN"
    },
    "account_type": {
      "type": "string",
      "description": "Type of the account"
    },
    "account_holder_name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "Status in the verification process"
    },
    "primary": {
      "type": "boolean",
      "description": "The primary bank account is the one used for settlemnts"
    },
    "created_at": {
      "type": "string",
      "description": "Creation date of the bank account"
    },
    "bank_name": {
      "type": "string",
      "description": "Bank name"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Create Bank Accounts
POST/v0.1/me/merchant-profile/bank-accounts

Add bank account to the merchant profile

Required scope(s): user.payout-settings

Resource URL

POST https://api.sumup.com/v0.1/me/merchant-profile/bank-accounts
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "bank_code": "...",
  "branch_code": "...",
  "account_number": "...",
  "iban": "...",
  "swift": "...",
  "account_type": "CURRENT|SAVINGS",
  "account_holder_name": "...",
  "check_digit": "...",
  "primary": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "bank_code": {
      "type": "string",
      "description": "Bank code"
    },
    "branch_code": {
      "type": "string",
      "description": "Branch code"
    },
    "account_number": {
      "type": "string",
      "description": "Account number"
    },
    "iban": {
      "type": "string",
      "description": "IBAN"
    },
    "swift": {
      "type": "string",
      "description": "SWIFT code"
    },
    "account_type": {
      "type": "string",
      "description": "Type of the account - Possible values CURRENT,SAVINGS"
    },
    "account_holder_name": {
      "type": "string",
      "description": "null"
    },
    "check_digit": {
      "type": "string",
      "description": "null"
    },
    "primary": {
      "type": "boolean",
      "description": "Determines if this bank account will be primary. Default is false"
    }
  },
  "required": [
    "account_holder_name"
  ]
}
Response  201
HideShow
Body
{
  "bank_code": "...",
  "branch_code": "...",
  "swift": "...",
  "account_number": "...",
  "iban": "...",
  "account_type": "...",
  "account_holder_name": "...",
  "status": "...",
  "primary": true,
  "created_at": "...",
  "bank_name": "..."
}
Schema
{
  "type": "object",
  "properties": {
    "bank_code": {
      "type": "string",
      "description": "Bank code"
    },
    "branch_code": {
      "type": "string",
      "description": "Branch code"
    },
    "swift": {
      "type": "string",
      "description": "SWIFT code"
    },
    "account_number": {
      "type": "string",
      "description": "Account number"
    },
    "iban": {
      "type": "string",
      "description": "IBAN"
    },
    "account_type": {
      "type": "string",
      "description": "Type of the account"
    },
    "account_holder_name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "Status in the verification process"
    },
    "primary": {
      "type": "boolean",
      "description": "The primary bank account is the one used for settlemnts"
    },
    "created_at": {
      "type": "string",
      "description": "Creation date of the bank account"
    },
    "bank_name": {
      "type": "string",
      "description": "Bank name"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  409
HideShow
Body
{
  "error_code": "merchant_account_missing",
  "message": "Operation cannot be applied on missing merchant profile. Create merchant profile first."
}
Response  409
HideShow
Body
{
  "error_code": "max_number_of_bank_accounts_exceeded",
  "message": "User has exceeded the max number of bank accounts"
}
Response  409
HideShow
Body
{
  "error_code": "cannot_add_bank_account",
  "message": "User has a pending bank account verification"
}

Settings

Get settings
GET/v0.1/me/merchant-profile/settings

Get merchant settings

Required scope(s): user.payout-settings

Resource URL

GET https://api.sumup.com/v0.1/me/merchant-profile/settings
Response  200
HideShow
Body
{
  "tax_enabled": true,
  "payout_type": "...",
  "payout_period": "...",
  "payout_on_demand_available": true,
  "payout_on_demand": true,
  "printers_enabled": true,
  "payout_instrument": "...",
  "moto_payment": true,
  "adyen_merchant_code": "...",
  "adyen_user": "...",
  "adyen_password": "...",
  "adyen_company": "..."
}
Schema
{
  "type": "object",
  "properties": {
    "tax_enabled": {
      "type": "boolean",
      "description": "Whether to show tax in receipts (saved per transaction)"
    },
    "payout_type": {
      "type": "string",
      "description": "Payout type"
    },
    "payout_period": {
      "type": "string",
      "description": "Payout frequency"
    },
    "payout_on_demand_available": {
      "type": "boolean",
      "description": "Whether merchant can edit payouts on demand"
    },
    "payout_on_demand": {
      "type": "boolean",
      "description": "Whether merchant will receive payouts on demand"
    },
    "printers_enabled": {
      "type": "boolean",
      "description": "Whether to show printers in mobile app"
    },
    "payout_instrument": {
      "type": "string",
      "description": "Payout Instrument"
    },
    "moto_payment": {
      "type": "boolean",
      "description": "Whether merchant can make MOTO payments"
    },
    "adyen_merchant_code": {
      "type": "string",
      "description": "Adyen merchant code"
    },
    "adyen_user": {
      "type": "string",
      "description": "Adyen username"
    },
    "adyen_password": {
      "type": "string",
      "description": "Adyen password"
    },
    "adyen_company": {
      "type": "string",
      "description": "Adyen company"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Edit settings
PUT/v0.1/me/merchant-profile/settings

Update merchant settings

Required scope(s): user.payout-settings

Resource URL

PUT https://api.sumup.com/v0.1/me/merchant-profile/settings
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "payout_type: SINGLE_PAYMENT": "Hello, world!",
  "payout_on_demand": false,
  "payout_on_demand_available: true|false(boolean, optional) - If true, the merchant will be able to manage  payout_on_demand settings": "Hello, world!",
  "expected_max_transaction_amount": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "payout_type: SINGLE_PAYMENT": {
      "type": "string",
      "description": "Payout type - Possible values SINGLE_PAYMENT"
    },
    "payout_on_demand": {
      "type": "boolean",
      "description": "If true, the merchant will not receive automatic payouts - Possible values true,false"
    },
    "payout_on_demand_available: true|false(boolean, optional) - If true, the merchant will be able to manage  payout_on_demand settings": {
      "type": "string",
      "description": "Possible values true,false"
    },
    "expected_max_transaction_amount": {
      "type": "number",
      "description": "Expected maximum amount of a single purchase"
    }
  }
}
Response  200
HideShow
Body
{
  "tax_enabled": true,
  "payout_type": "...",
  "payout_period": "...",
  "payout_on_demand_available": true,
  "payout_on_demand": true,
  "printers_enabled": true,
  "payout_instrument": "...",
  "moto_payment": true,
  "adyen_merchant_code": "...",
  "adyen_user": "...",
  "adyen_password": "...",
  "adyen_company": "..."
}
Schema
{
  "type": "object",
  "properties": {
    "tax_enabled": {
      "type": "boolean",
      "description": "Whether to show tax in receipts (saved per transaction)"
    },
    "payout_type": {
      "type": "string",
      "description": "Payout type"
    },
    "payout_period": {
      "type": "string",
      "description": "Payout frequency"
    },
    "payout_on_demand_available": {
      "type": "boolean",
      "description": "Whether merchant can edit payouts on demand"
    },
    "payout_on_demand": {
      "type": "boolean",
      "description": "Whether merchant will receive payouts on demand"
    },
    "printers_enabled": {
      "type": "boolean",
      "description": "Whether to show printers in mobile app"
    },
    "payout_instrument": {
      "type": "string",
      "description": "Payout Instrument"
    },
    "moto_payment": {
      "type": "boolean",
      "description": "Whether merchant can make MOTO payments"
    },
    "adyen_merchant_code": {
      "type": "string",
      "description": "Adyen merchant code"
    },
    "adyen_user": {
      "type": "string",
      "description": "Adyen username"
    },
    "adyen_password": {
      "type": "string",
      "description": "Adyen password"
    },
    "adyen_company": {
      "type": "string",
      "description": "Adyen company"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  409
HideShow
Body
{"error_code":"merchant_account_missing","message":"Operation cannot be applied on missing merchant profile. Create merchant profile first."}
<p>&nbsp;</p>

Manage Employees

Employees

Create Employee
POST/v0.1/me/accounts

Create operator

Required scope(s): user.subaccounts

Resource URL

POST https://api.sumup.com/v0.1/me/accounts
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "username": "...",
  "password": "..."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "Username of the new account. Must be a valid email address"
    },
    "password": {
      "type": "string",
      "description": "Password"
    }
  },
  "required": [
    "username",
    "password"
  ]
}
Response  201
HideShow
Body
{
  "id": 1,
  "username": "...",
  "created_at": "...",
  "permissions": {
    "create_moto_payments": true,
    "refund_transactions": true
  },
  "app_settings": {
    "checkout_preference": "...",
    "sound_enabled": true,
    "tips_enabled": true,
    "font_name": "...",
    "include_vat": true,
    "max_amount_no_signature": "...",
    "manual_entry_tutorial": true,
    "mobile_payment_tutorial": true,
    "tax_enabled": true,
    "mobile_payment": "...",
    "reader_payment": "...",
    "cash_payment": "...",
    "advanced_mode": "...",
    "expected_max_transaction_amount": 1,
    "bitcoin_payment": "...",
    "manual_entry": "...",
    "terminal_mode_tutorial": true,
    "tipping": "...",
    "tip_rates": []
  }
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Id of the operator"
    },
    "username": {
      "type": "string",
      "description": "Username of the operator"
    },
    "created_at": {
      "type": "string",
      "description": "Creation date of the operator"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create_moto_payments": {
          "type": "boolean",
          "description": "Create MOTO payments"
        },
        "refund_transactions": {
          "type": "boolean",
          "description": "Refund transactions"
        }
      },
      "description": "Permissions"
    },
    "app_settings": {
      "type": "object",
      "properties": {
        "checkout_preference": {
          "type": "string",
          "description": "undefined"
        },
        "sound_enabled": {
          "type": "boolean",
          "description": "undefined"
        },
        "tips_enabled": {
          "type": "boolean",
          "description": "undefined"
        },
        "font_name": {
          "type": "string",
          "description": "undefined"
        },
        "include_vat": {
          "type": "boolean",
          "description": "undefined"
        },
        "max_amount_no_signature": {
          "type": "string",
          "description": "undefined"
        },
        "manual_entry_tutorial": {
          "type": "boolean",
          "description": "undefined"
        },
        "mobile_payment_tutorial": {
          "type": "boolean",
          "description": "undefined"
        },
        "tax_enabled": {
          "type": "boolean",
          "description": "undefined"
        },
        "mobile_payment": {
          "type": "string",
          "description": "undefined"
        },
        "reader_payment": {
          "type": "string",
          "description": "undefined"
        },
        "cash_payment": {
          "type": "string",
          "description": "undefined"
        },
        "advanced_mode": {
          "type": "string",
          "description": "undefined"
        },
        "expected_max_transaction_amount": {
          "type": "number",
          "description": "undefined"
        },
        "bitcoin_payment": {
          "type": "string",
          "description": "undefined"
        },
        "manual_entry": {
          "type": "string",
          "description": "undefined"
        },
        "terminal_mode_tutorial": {
          "type": "boolean",
          "description": "undefined"
        },
        "tipping": {
          "type": "string",
          "description": "undefined"
        },
        "tip_rates": {
          "type": "array",
          "description": "undefined"
        }
      },
      "description": "Mobile app settings"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  409
HideShow
Body
{
  "error_code": "merchant_account_missing",
  "message": "Operation cannot be applied on missing merchant profile. Create merchant profile first."
}

Get Employees
GET/v0.1/me/accounts

Get operators

Required scope(s): user.subaccounts

Resource URL

GET https://api.sumup.com/v0.1/me/accounts
Parameters
HideShow
include[]
array (optional) 

A list of additional information you want to receive for operators. Possible values: permissions, app_settings

Response  200
HideShow
Body
{
  "id": 1,
  "username": "...",
  "created_at": "...",
  "permissions": {
    "create_moto_payments": true,
    "refund_transactions": true
  },
  "app_settings": {
    "checkout_preference": "...",
    "sound_enabled": true,
    "tips_enabled": true,
    "font_name": "...",
    "include_vat": true,
    "max_amount_no_signature": "...",
    "manual_entry_tutorial": true,
    "mobile_payment_tutorial": true,
    "tax_enabled": true,
    "mobile_payment": "...",
    "reader_payment": "...",
    "cash_payment": "...",
    "advanced_mode": "...",
    "expected_max_transaction_amount": 1,
    "bitcoin_payment": "...",
    "manual_entry": "...",
    "terminal_mode_tutorial": true,
    "tipping": "...",
    "tip_rates": []
  }
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Id of the operator"
    },
    "username": {
      "type": "string",
      "description": "Username of the operator"
    },
    "created_at": {
      "type": "string",
      "description": "Creation date of the operator"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create_moto_payments": {
          "type": "boolean",
          "description": "Create MOTO payments"
        },
        "refund_transactions": {
          "type": "boolean",
          "description": "Refund transactions"
        }
      },
      "description": "Permissions"
    },
    "app_settings": {
      "type": "object",
      "properties": {
        "checkout_preference": {
          "type": "string",
          "description": "undefined"
        },
        "sound_enabled": {
          "type": "boolean",
          "description": "undefined"
        },
        "tips_enabled": {
          "type": "boolean",
          "description": "undefined"
        },
        "font_name": {
          "type": "string",
          "description": "undefined"
        },
        "include_vat": {
          "type": "boolean",
          "description": "undefined"
        },
        "max_amount_no_signature": {
          "type": "string",
          "description": "undefined"
        },
        "manual_entry_tutorial": {
          "type": "boolean",
          "description": "undefined"
        },
        "mobile_payment_tutorial": {
          "type": "boolean",
          "description": "undefined"
        },
        "tax_enabled": {
          "type": "boolean",
          "description": "undefined"
        },
        "mobile_payment": {
          "type": "string",
          "description": "undefined"
        },
        "reader_payment": {
          "type": "string",
          "description": "undefined"
        },
        "cash_payment": {
          "type": "string",
          "description": "undefined"
        },
        "advanced_mode": {
          "type": "string",
          "description": "undefined"
        },
        "expected_max_transaction_amount": {
          "type": "number",
          "description": "undefined"
        },
        "bitcoin_payment": {
          "type": "string",
          "description": "undefined"
        },
        "manual_entry": {
          "type": "string",
          "description": "undefined"
        },
        "terminal_mode_tutorial": {
          "type": "boolean",
          "description": "undefined"
        },
        "tipping": {
          "type": "string",
          "description": "undefined"
        },
        "tip_rates": {
          "type": "array",
          "description": "undefined"
        }
      },
      "description": "Mobile app settings"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Employee

Change employee credentials
PUT/v0.1/me/accounts/:operator_code

Update operator

Required scope(s): user.subaccounts

Resource URL

PUT https://api.sumup.com/v0.1/me/accounts/:operator_code
Parameters
HideShow
operator_code
string (required) 

Operator code

Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "username": "...",
  "password": "..."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "New username for the operator"
    },
    "password": {
      "type": "string",
      "description": "New password for the operator"
    }
  }
}

Disable employee account
DELETE/v0.1/me/accounts/:operator_code

Disable operator

Required scope(s): user.subaccounts

Resource URL

DELETE https://api.sumup.com/v0.1/me/accounts/:operator_code
Parameters
HideShow
operator_code
string (required) 

Operator code

 

Manage Products

Shelves

Get shelves
GET/v0.1/me/merchant-profile/shelves

Get product shelves

Required scope(s): products

Resource URL

GET https://api.sumup.com/v0.1/me/merchant-profile/shelves
Parameters
HideShow
include[]
array (optional) 

A list of additional information you want to receive for the shelves. Possible values: “products” - will include return the list of products for each shelf

Response  200
HideShow
Body
{
  "id": 1,
  "name": "...",
  "order": 1,
  "products": [
    {
      "id": 1,
      "shelf_id": 1,
      "availability": 1,
      "image_url": "...",
      "stock": 1,
      "subtitle": "...",
      "title": "...",
      "prices": [
        {
          "id": 1,
          "product_id": 1,
          "description": "...",
          "net": 1
        }
      ],
      "vat_rate_id": 1,
      "color_id": 1
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Internal ID"
    },
    "name": {
      "type": "string",
      "description": "Name"
    },
    "order": {
      "type": "number",
      "description": "Order"
    },
    "products": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Internal ID"
          },
          "shelf_id": {
            "type": "number",
            "description": "Shelf ID"
          },
          "availability": {
            "type": "number",
            "description": "availability"
          },
          "image_url": {
            "type": "string",
            "description": "Image URL"
          },
          "stock": {
            "type": "number",
            "description": "Stock"
          },
          "subtitle": {
            "type": "string",
            "description": "Subtitle"
          },
          "title": {
            "type": "string",
            "description": "Title"
          },
          "prices": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "ID"
                },
                "product_id": {
                  "type": "number",
                  "description": "Product ID"
                },
                "description": {
                  "type": "string",
                  "description": "Description"
                },
                "net": {
                  "type": "number",
                  "description": "Net"
                }
              }
            },
            "description": "prices"
          },
          "vat_rate_id": {
            "type": "number",
            "description": "VAT rate ID"
          },
          "color_id": {
            "type": "number",
            "description": "Color ID"
          }
        }
      },
      "description": "products"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Create shelf
POST/v0.1/me/merchant-profile/shelves

Creates a product shelf

Required scope(s): products

Resource URL

POST https://api.sumup.com/v0.1/me/merchant-profile/shelves
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "...",
  "order": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Shelf name"
    },
    "order": {
      "type": "number",
      "description": "Shelf order"
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": 1,
  "name": "...",
  "order": 1,
  "products": [
    {
      "id": 1,
      "shelf_id": 1,
      "availability": 1,
      "image_url": "...",
      "stock": 1,
      "subtitle": "...",
      "title": "...",
      "prices": [
        {
          "id": 1,
          "product_id": 1,
          "description": "...",
          "net": 1
        }
      ],
      "vat_rate_id": 1,
      "color_id": 1
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Internal ID"
    },
    "name": {
      "type": "string",
      "description": "Name"
    },
    "order": {
      "type": "number",
      "description": "Order"
    },
    "products": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Internal ID"
          },
          "shelf_id": {
            "type": "number",
            "description": "Shelf ID"
          },
          "availability": {
            "type": "number",
            "description": "availability"
          },
          "image_url": {
            "type": "string",
            "description": "Image URL"
          },
          "stock": {
            "type": "number",
            "description": "Stock"
          },
          "subtitle": {
            "type": "string",
            "description": "Subtitle"
          },
          "title": {
            "type": "string",
            "description": "Title"
          },
          "prices": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "ID"
                },
                "product_id": {
                  "type": "number",
                  "description": "Product ID"
                },
                "description": {
                  "type": "string",
                  "description": "Description"
                },
                "net": {
                  "type": "number",
                  "description": "Net"
                }
              }
            },
            "description": "prices"
          },
          "vat_rate_id": {
            "type": "number",
            "description": "VAT rate ID"
          },
          "color_id": {
            "type": "number",
            "description": "Color ID"
          }
        }
      },
      "description": "products"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Shelf

Get shelf
GET/v0.1/me/merchant-profile/shelves/:shelf_id

Get product shelf

Required scope(s): products

Resource URL

GET https://api.sumup.com/v0.1/me/merchant-profile/shelves/:shelf_id
Parameters
HideShow
shelf_id
string (optional) 
include[]
array (optional) 

A list of additional information you want to receive for the shelf. Possible values: “products” - will include return a list of products for the shelf

Response  200
HideShow
Body
{
  "id": 1,
  "name": "...",
  "order": 1,
  "products": [
    {
      "id": 1,
      "shelf_id": 1,
      "availability": 1,
      "image_url": "...",
      "stock": 1,
      "subtitle": "...",
      "title": "...",
      "prices": [
        {
          "id": 1,
          "product_id": 1,
          "description": "...",
          "net": 1
        }
      ],
      "vat_rate_id": 1,
      "color_id": 1
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Internal ID"
    },
    "name": {
      "type": "string",
      "description": "Name"
    },
    "order": {
      "type": "number",
      "description": "Order"
    },
    "products": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Internal ID"
          },
          "shelf_id": {
            "type": "number",
            "description": "Shelf ID"
          },
          "availability": {
            "type": "number",
            "description": "availability"
          },
          "image_url": {
            "type": "string",
            "description": "Image URL"
          },
          "stock": {
            "type": "number",
            "description": "Stock"
          },
          "subtitle": {
            "type": "string",
            "description": "Subtitle"
          },
          "title": {
            "type": "string",
            "description": "Title"
          },
          "prices": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "ID"
                },
                "product_id": {
                  "type": "number",
                  "description": "Product ID"
                },
                "description": {
                  "type": "string",
                  "description": "Description"
                },
                "net": {
                  "type": "number",
                  "description": "Net"
                }
              }
            },
            "description": "prices"
          },
          "vat_rate_id": {
            "type": "number",
            "description": "VAT rate ID"
          },
          "color_id": {
            "type": "number",
            "description": "Color ID"
          }
        }
      },
      "description": "products"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Edit shelf
PUT/v0.1/me/merchant-profile/shelves/:shelf_id

Updates a product shelf

Required scope(s): products

Resource URL

PUT https://api.sumup.com/v0.1/me/merchant-profile/shelves/:shelf_id
Parameters
HideShow
shelf_id
string (optional) 
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "...",
  "order": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Shelf name"
    },
    "order": {
      "type": "number",
      "description": "Shelf order"
    }
  }
}

Delete shelf
DELETE/v0.1/me/merchant-profile/shelves/:shelf_id

Deletes a product shelf

Required scope(s): products

Resource URL

DELETE https://api.sumup.com/v0.1/me/merchant-profile/shelves/:shelf_id
Parameters
HideShow
shelf_id
string (optional) 

Products

Get products
GET/v0.1/me/merchant-profile/shelves/:shelf_id/products

Get shelf products

Required scope(s): products

Resource URL

GET https://api.sumup.com/v0.1/me/merchant-profile/shelves/:shelf_id/products
Parameters
HideShow
shelf_id
number (required) 

Id of shelf

Response  200
HideShow
Body
{
  "id": 1,
  "shelf_id": 1,
  "availability": 1,
  "image_url": "...",
  "stock": 1,
  "subtitle": "...",
  "title": "...",
  "prices": [
    {
      "id": 1,
      "product_id": 1,
      "description": "...",
      "net": 1
    }
  ],
  "vat_rate_id": 1,
  "color_id": 1
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Internal ID"
    },
    "shelf_id": {
      "type": "number",
      "description": "Shelf ID"
    },
    "availability": {
      "type": "number",
      "description": "availability"
    },
    "image_url": {
      "type": "string",
      "description": "Image URL"
    },
    "stock": {
      "type": "number",
      "description": "Stock"
    },
    "subtitle": {
      "type": "string",
      "description": "Subtitle"
    },
    "title": {
      "type": "string",
      "description": "Title"
    },
    "prices": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "ID"
          },
          "product_id": {
            "type": "number",
            "description": "Product ID"
          },
          "description": {
            "type": "string",
            "description": "Description"
          },
          "net": {
            "type": "number",
            "description": "Net"
          }
        }
      },
      "description": "prices"
    },
    "vat_rate_id": {
      "type": "number",
      "description": "VAT rate ID"
    },
    "color_id": {
      "type": "number",
      "description": "Color ID"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Create product
POST/v0.1/me/merchant-profile/shelves/:shelf_id/products

Create product

Required scope(s): products

Resource URL

POST https://api.sumup.com/v0.1/me/merchant-profile/shelves/:shelf_id/products
Parameters
HideShow
shelf_id
number (required) 

Id of the shelf

Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "title": "...",
  "subtitle": "...",
  "image_url": "...",
  "availability": 1,
  "vat_rate_id": 1,
  "stock": 1,
  "color_id": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Product title"
    },
    "subtitle": {
      "type": "string",
      "description": "Product subtitle"
    },
    "image_url": {
      "type": "string",
      "description": "Product image url"
    },
    "availability": {
      "type": "number",
      "description": "Product availability"
    },
    "vat_rate_id": {
      "type": "number",
      "description": "Product merchant vat rate id"
    },
    "stock": {
      "type": "number",
      "description": "Product stock"
    },
    "color_id": {
      "type": "number",
      "description": "Product color id"
    }
  },
  "required": [
    "title"
  ]
}
Response  201
HideShow
Body
{
  "id": 1,
  "shelf_id": 1,
  "availability": 1,
  "image_url": "...",
  "stock": 1,
  "subtitle": "...",
  "title": "...",
  "prices": [
    {
      "id": 1,
      "product_id": 1,
      "description": "...",
      "net": 1
    }
  ],
  "vat_rate_id": 1,
  "color_id": 1
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Internal ID"
    },
    "shelf_id": {
      "type": "number",
      "description": "Shelf ID"
    },
    "availability": {
      "type": "number",
      "description": "availability"
    },
    "image_url": {
      "type": "string",
      "description": "Image URL"
    },
    "stock": {
      "type": "number",
      "description": "Stock"
    },
    "subtitle": {
      "type": "string",
      "description": "Subtitle"
    },
    "title": {
      "type": "string",
      "description": "Title"
    },
    "prices": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "ID"
          },
          "product_id": {
            "type": "number",
            "description": "Product ID"
          },
          "description": {
            "type": "string",
            "description": "Description"
          },
          "net": {
            "type": "number",
            "description": "Net"
          }
        }
      },
      "description": "prices"
    },
    "vat_rate_id": {
      "type": "number",
      "description": "VAT rate ID"
    },
    "color_id": {
      "type": "number",
      "description": "Color ID"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Product

Get product
GET/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id

Get shelf product

Required scope(s): products

Resource URL

GET https://api.sumup.com/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id
Parameters
HideShow
shelf_id
number (required) 

Id of shelf

product_id
number (required) 

Id of the product

Response  200
HideShow
Body
{
  "id": 1,
  "shelf_id": 1,
  "availability": 1,
  "image_url": "...",
  "stock": 1,
  "subtitle": "...",
  "title": "...",
  "prices": [
    {
      "id": 1,
      "product_id": 1,
      "description": "...",
      "net": 1
    }
  ],
  "vat_rate_id": 1,
  "color_id": 1
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Internal ID"
    },
    "shelf_id": {
      "type": "number",
      "description": "Shelf ID"
    },
    "availability": {
      "type": "number",
      "description": "availability"
    },
    "image_url": {
      "type": "string",
      "description": "Image URL"
    },
    "stock": {
      "type": "number",
      "description": "Stock"
    },
    "subtitle": {
      "type": "string",
      "description": "Subtitle"
    },
    "title": {
      "type": "string",
      "description": "Title"
    },
    "prices": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "ID"
          },
          "product_id": {
            "type": "number",
            "description": "Product ID"
          },
          "description": {
            "type": "string",
            "description": "Description"
          },
          "net": {
            "type": "number",
            "description": "Net"
          }
        }
      },
      "description": "prices"
    },
    "vat_rate_id": {
      "type": "number",
      "description": "VAT rate ID"
    },
    "color_id": {
      "type": "number",
      "description": "Color ID"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Edit product
PUT/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id

Update product

Required scope(s): products

Resource URL

PUT https://api.sumup.com/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id
Parameters
HideShow
shelf_id
number (required) 

Id of the shelf

product_id
number (required) 

Id of the product

Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "title": "...",
  "subtitle": "...",
  "image_url": "...",
  "availability": 1,
  "vat_rate_id": 1,
  "stock": 1,
  "color_id": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Product title"
    },
    "subtitle": {
      "type": "string",
      "description": "Product subtitle"
    },
    "image_url": {
      "type": "string",
      "description": "Product image url"
    },
    "availability": {
      "type": "number",
      "description": "Product availability"
    },
    "vat_rate_id": {
      "type": "number",
      "description": "Product merchant vat rate id"
    },
    "stock": {
      "type": "number",
      "description": "Product stock"
    },
    "color_id": {
      "type": "number",
      "description": "Product color id"
    }
  }
}

Delete product
DELETE/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id

Delete product

Required scope(s): products

Resource URL

DELETE https://api.sumup.com/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id
Parameters
HideShow
shelf_id
number (required) 

Id of the shelf

product_id
number (required) 

Id of the product

Product prices

Get product prices
GET/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id/prices

Get product prices

Required scope(s): products

Resource URL

GET https://api.sumup.com/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id/prices
Parameters
HideShow
shelf_id
number (required) 

Id of shelf

product_id
number (required) 

Id of product

Response  200
HideShow
Body
{
  "id": 1,
  "product_id": 1,
  "description": "...",
  "net": 1
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID"
    },
    "product_id": {
      "type": "number",
      "description": "Product ID"
    },
    "description": {
      "type": "string",
      "description": "Description"
    },
    "net": {
      "type": "number",
      "description": "Net"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Create product price
POST/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id/prices

Create product price

Required scope(s): products

Resource URL

POST https://api.sumup.com/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id/prices
Parameters
HideShow
shelf_id
number (required) 

Id of the shelf

product_id
number (required) 

Id of the product

Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "description": "...",
  "net": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "Price description"
    },
    "net": {
      "type": "number",
      "description": "Net value"
    }
  }
}
Response  201
HideShow
Body
{
  "id": 1,
  "product_id": 1,
  "description": "...",
  "net": 1
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID"
    },
    "product_id": {
      "type": "number",
      "description": "Product ID"
    },
    "description": {
      "type": "string",
      "description": "Description"
    },
    "net": {
      "type": "number",
      "description": "Net"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Product price

Get product price
GET/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id/prices/:price_id

Get product price

Required scope(s): products

Resource URL

GET https://api.sumup.com/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id/prices/:price_id
Parameters
HideShow
shelf_id
number (required) 

Id of shelf

product_id
number (required) 

Id of product

price_id
number (required) 

Id of price

Response  200
HideShow
Body
{
  "id": 1,
  "product_id": 1,
  "description": "...",
  "net": 1
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID"
    },
    "product_id": {
      "type": "number",
      "description": "Product ID"
    },
    "description": {
      "type": "string",
      "description": "Description"
    },
    "net": {
      "type": "number",
      "description": "Net"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Edit product price
PUT/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id/prices/:price_id

Update product price

Required scope(s): products

Resource URL

PUT https://api.sumup.com/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id/prices/:price_id
Parameters
HideShow
shelf_id
number (required) 

Id of the shelf

product_id
number (required) 

Id of the product

price_id
number (required) 

Id of the price

Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "description": "...",
  "net": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "Price description"
    },
    "net": {
      "type": "number",
      "description": "Net value"
    }
  }
}

Delete product price
DELETE/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id/prices/:price_id

Delete product price

Required scope(s): products

Resource URL

DELETE https://api.sumup.com/v0.1/me/merchant-profile/shelves/:shelf_id/products/:product_id/prices/:price_id
Parameters
HideShow
shelf_id
number (required) 

Id of the shelf

product_id
number (required) 

Id of the product

price_id
number (required) 

Id of the price

 

Manage settings

Application settings

Get settings
GET/v0.1/me/app-settings

Get mobile app settings

Required scope(s): user.app-settings

Resource URL

GET https://api.sumup.com/v0.1/me/app-settings
Response  200
HideShow
Body
{
  "checkout_preference": "...",
  "sound_enabled": true,
  "tips_enabled": true,
  "font_name": "...",
  "include_vat": true,
  "max_amount_no_signature": "...",
  "manual_entry_tutorial": true,
  "mobile_payment_tutorial": true,
  "tax_enabled": true,
  "mobile_payment": "...",
  "reader_payment": "...",
  "cash_payment": "...",
  "advanced_mode": "...",
  "expected_max_transaction_amount": 1,
  "bitcoin_payment": "...",
  "manual_entry": "...",
  "terminal_mode_tutorial": true,
  "tipping": "...",
  "tip_rates": []
}
Schema
{
  "type": "object",
  "properties": {
    "checkout_preference": {
      "type": "string",
      "description": "undefined"
    },
    "sound_enabled": {
      "type": "boolean",
      "description": "undefined"
    },
    "tips_enabled": {
      "type": "boolean",
      "description": "undefined"
    },
    "font_name": {
      "type": "string",
      "description": "undefined"
    },
    "include_vat": {
      "type": "boolean",
      "description": "undefined"
    },
    "max_amount_no_signature": {
      "type": "string",
      "description": "undefined"
    },
    "manual_entry_tutorial": {
      "type": "boolean",
      "description": "undefined"
    },
    "mobile_payment_tutorial": {
      "type": "boolean",
      "description": "undefined"
    },
    "tax_enabled": {
      "type": "boolean",
      "description": "undefined"
    },
    "mobile_payment": {
      "type": "string",
      "description": "undefined"
    },
    "reader_payment": {
      "type": "string",
      "description": "undefined"
    },
    "cash_payment": {
      "type": "string",
      "description": "undefined"
    },
    "advanced_mode": {
      "type": "string",
      "description": "undefined"
    },
    "expected_max_transaction_amount": {
      "type": "number",
      "description": "undefined"
    },
    "bitcoin_payment": {
      "type": "string",
      "description": "undefined"
    },
    "manual_entry": {
      "type": "string",
      "description": "undefined"
    },
    "terminal_mode_tutorial": {
      "type": "boolean",
      "description": "undefined"
    },
    "tipping": {
      "type": "string",
      "description": "undefined"
    },
    "tip_rates": {
      "type": "array",
      "description": "undefined"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Edit settings
PUT/v0.1/me/app-settings

Update mobile app settings

Required scope(s): user.app-settings

Resource URL

PUT https://api.sumup.com/v0.1/me/app-settings
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "terminal_mode_tutorial": true,
  "advanced_mode": "ON|OFF",
  "include_vat": true,
  "checkout_preference: magstripe|chipsig|pinplus|air|air_lite|miura": "Hello, world!",
  "mobile_payment": "ON|OFF",
  "reader_payment": "ON|OFF",
  "tipping": "ON|OFF",
  "tip_rates": [
    1
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "terminal_mode_tutorial": {
      "type": "boolean",
      "description": "Terminal mode tutorial"
    },
    "advanced_mode": {
      "type": "string",
      "description": "Advanced Mode - Possible values ON,OFF"
    },
    "include_vat": {
      "type": "boolean",
      "description": "Include Vat"
    },
    "checkout_preference: magstripe|chipsig|pinplus|air|air_lite|miura": {
      "type": "string",
      "description": "Checkout Preference - Possible values magstripe,chipsig,pinplus,air,air_lite,miura"
    },
    "mobile_payment": {
      "type": "string",
      "description": "Mobile payment (if applicable) - Possible values ON,OFF"
    },
    "reader_payment": {
      "type": "string",
      "description": "Reader payment (if applicable) - Possible values ON,OFF"
    },
    "tipping": {
      "type": "string",
      "description": "Tipping enabled, or otherwise - Possible values ON,OFF"
    },
    "tip_rates": {
      "type": "array",
      "description": "Predefined tipping rates"
    }
  }
}
Response  200
HideShow
Body
{
  "checkout_preference": "...",
  "sound_enabled": true,
  "tips_enabled": true,
  "font_name": "...",
  "include_vat": true,
  "max_amount_no_signature": "...",
  "manual_entry_tutorial": true,
  "mobile_payment_tutorial": true,
  "tax_enabled": true,
  "mobile_payment": "...",
  "reader_payment": "...",
  "cash_payment": "...",
  "advanced_mode": "...",
  "expected_max_transaction_amount": 1,
  "bitcoin_payment": "...",
  "manual_entry": "...",
  "terminal_mode_tutorial": true,
  "tipping": "...",
  "tip_rates": []
}
Schema
{
  "type": "object",
  "properties": {
    "checkout_preference": {
      "type": "string",
      "description": "undefined"
    },
    "sound_enabled": {
      "type": "boolean",
      "description": "undefined"
    },
    "tips_enabled": {
      "type": "boolean",
      "description": "undefined"
    },
    "font_name": {
      "type": "string",
      "description": "undefined"
    },
    "include_vat": {
      "type": "boolean",
      "description": "undefined"
    },
    "max_amount_no_signature": {
      "type": "string",
      "description": "undefined"
    },
    "manual_entry_tutorial": {
      "type": "boolean",
      "description": "undefined"
    },
    "mobile_payment_tutorial": {
      "type": "boolean",
      "description": "undefined"
    },
    "tax_enabled": {
      "type": "boolean",
      "description": "undefined"
    },
    "mobile_payment": {
      "type": "string",
      "description": "undefined"
    },
    "reader_payment": {
      "type": "string",
      "description": "undefined"
    },
    "cash_payment": {
      "type": "string",
      "description": "undefined"
    },
    "advanced_mode": {
      "type": "string",
      "description": "undefined"
    },
    "expected_max_transaction_amount": {
      "type": "number",
      "description": "undefined"
    },
    "bitcoin_payment": {
      "type": "string",
      "description": "undefined"
    },
    "manual_entry": {
      "type": "string",
      "description": "undefined"
    },
    "terminal_mode_tutorial": {
      "type": "boolean",
      "description": "undefined"
    },
    "tipping": {
      "type": "string",
      "description": "undefined"
    },
    "tip_rates": {
      "type": "array",
      "description": "undefined"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  204
HideShow
Body
Merchant settings are successfully updated
Response  409
HideShow
Body
{
  "error_code": "merchant_account_missing",
  "message": "Operation cannot be applied on missing merchant profile. Create merchant profile first."
}