Merchants

Returns the Persons related to a Merchant.

get/v1/merchants/{merchant_code}/persons

Request

  • Base URL
    https://api.sumup.com
  • URL
    https://api.sumup.com/v1/merchants/{merchant_code}/persons
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.sumup.com/authorize
      Token URL: https://api.sumup.com/token scopes: user.profile, user.profile_readonly

Path parameters

merchant_codestring required
Example:MK10CL2A

Short unique identifier for the merchant.

Response

Returns a list of Persons for a valid Merchant identifier.

Example response

{
  "items": [
    {
      "id": "pers_2EGQ057R6C8J791RVCG5NWAEAB",
      "user_id": "ef263f37-8701-4181-9758-acddbb778ee9",
      "birthdate": "1980-01-12",
      "given_name": "Sofia",
      "family_name": "Rossi",
      "phone_number": "+420123456789",
      "relationships": [
        "representative"
      ],
      "ownership": {
        "share": 50000
      },
      "address": {
        "street_address": [
          "Paul-Linke-Ufer 39-40",
          "2. Hinterhof"
        ],
        "post_code": "10999",
        "city": "Berlin",
        "country": "DE"
      },
      "identifiers": [
        {
          "ref": "br.cpf",
          "value": "847.060.136-90"
        }
      ],
      "citizenship": "BR",
      "version": "chng_01HS0KG3MPVEVWW85E3KNXH55J"
    }
  ]
}

Changes

    • breaking

      the ////// response's property type changed from no type to object for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ////// response's property type changed from no type to object for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • warning

      removed the optional property ////// from the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      removed subschema #1 from the ////// response property allOf list for the response status

    • info

      removed subschema #1 from the ////// response property allOf list for the response status

    • info

      removed subschema #1 from the ////// response property allOf list for the response status

    • info

      removed subschema #1 from the ////// response property allOf list for the response status

    • info

      the ////// response's property pattern ^[A-Z]{2}$ was added for the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • breaking

      the ////// response property's maxLength was unset from 2 for the response status

    • breaking

      the ////// response property's maxLength was unset from 16 for the response status

    • breaking

      the ////// response property's minLength was decreased from 2 to 0 for the response status

    • breaking

      the ////// response's property type changed from object to no type for status

    • breaking

      the ////// response's property type changed from string to no type for status

    • breaking

      the ////// response's property type changed from object to no type for status

    • breaking

      the ////// response's property type changed from string to no type for status

    • breaking

      removed the required property /////// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • info

      added subschema #1 to the ////// response property allOf list for the response status

    • info

      added subschema #1 to the ////// response property allOf list for the response status

    • info

      added subschema #1 to the ////// response property allOf list for the response status

    • info

      added subschema #1 to the ////// response property allOf list for the response status

    • info

      the ////// response's property pattern ^[A-Z]{2}$ was removed for the status