Follow

Get Consumer Info

Returns the consumer info based on the externalId and systemType.

 

Attributes 

Attribute

Value

Path

/v3/consumers

Support Formats

JSON, XML

HTTP Method

GET

Secure

Yes

Rate Limited

No

Cache Timeout

TBC

HTTP Codes

·        200 - OK

·        400 - Bad Request

·        500 - Internal Server Error

 

Request

The following table contains the details of a typical HTTP request for this service:

Type

Value

Header

GET /v3/consumers HTTP/1.1

Host: merchant.api.vmob.co

Content-Type: application/json

Accept-Language: en-US

x-vmob-authorization: dm1vYi53aW5kb3dzLjE6

Query
Params

?externalId=(string)
&systemType=(int)&externalConsumerIdToken={string}

Notes:
  • If externalConsumerIdToken is provided, it will be used to find the consumer
  • If externalConsumerIdToken is not provided, both externalId and systemType are required
  • if all externalConsumerIdToken, externalId and systemType are provided, it will use externalConsumerIdToken to find consumer and fall back to use externalId and systemType if externalConsumerIdToken is invalid or with no consumers been found

 

Successful Response

The following table contains the details of a typical successful HTTP request for this service.

Type

Value

Header

HTTP/1.1 200 OK

Content-Type: application/json

Cache-Control: no-store

Pragma: no-cache

Body

{

 "dateOfBirth":"2003-07-30",

 "emailAddress":"info44@vmob.co",

 "firstName":"Joe",

 "fullName":"Joe Bloggs",

 "gender":"m",

 "homeCity":3,

 "lastName":"Bloggs",

 "userName":"info44@vmob.co",

 "extendedData:"",

 "verificationToken":0

}

Notes:

verificationToken is a one-off code generated and sent in the response only if Settings.GeneratePOSVerificationToken platform setting is set to true. POS devices then include this token in the sales data in order for VMob to identify the consumer. This verificationToken can only be used once.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.