Sign in

v1

latestOpenAPI 3.1.02026-07-26490301.4 KB
Consumer

Create consumer (user)

post/consumer

Headers

X-Request-IDstring

Unique ID of request

Request body

externalIdstring required

Merchant consumer ID (user ID)

usernamestring

Username

emailstring email

Email address

firstNamestring

First name

lastNamestring

Last name

birthdaystring nullable

Date of birth

countrystring ISO3

Country name in ISO3 format

{"stackTrail":"paths:/consumer:post:requestBody:content:application/json:schema:properties:groupId","oasType":"schema","type":"unknown","title":"Consumer group ID","description":"| id | description\n|---|---|\n| 1 | whitelist |\n| 2 | blacklist |\n| 3 | junior |\n| 4 | senior |\n| 5 | expert |"}

Example request

{
  "externalId": "14253ms92m0as",
  "username": "Jonny Sonny",
  "email": "jonny.sonny@google.com",
  "firstName": "Jonny",
  "lastName": "Sonny",
  "birthday": "1987-12-23",
  "country": "USA",
  "groupId": 3
}

Response

Created

idstring required

Gateway consumer ID (user ID)

externalIdstring

Merchant consumer ID (user ID)

usernamestring

Username

emailstring email

Email address

firstNamestring

First name

lastNamestring

Last name

birthdaystring nullable

Date of birth

countrystring ISO3

Country name in ISO3 format

{"stackTrail":"paths:/consumer:post:responses:201:content:application/json:schema:properties:groupId","oasType":"schema","type":"unknown","title":"Consumer group ID","description":"| id | description\n|---|---|\n| 1 | whitelist |\n| 2 | blacklist |\n| 3 | junior |\n| 4 | senior |\n| 5 | expert |"}
blockedboolean

Consumer ID blocked

Example response

{
  "externalId": "14253ms92m0as",
  "email": "jonny.sonny@google.com",
  "birthday": "Yyyy-mm-dd",
  "country": "GBR"
}