This document describes the expected response of an API call that returns Seller data. The sample data presented below is fictitious and serves to illustrate the structure and meaning of each field in the response.
{
"data": {
"id": "00d8bdbd-f071-48da-85fe-29ca04a11569",
"name": "Maria",
"lastname": "Panagiotula Theodore Gatos",
"account_number": "20805496521-4",
"taxpayer_id": "06497982876",
"email": "[email protected]",
"phone": "+5569984157918",
"birthdate": "1961-02-06",
"mcc": "123",
"status": "active",
"statement_descriptor": "Panagiotula",
"address": {
"zip_code": "76811668",
"street": "Rua Açaí",
"number": "462",
"city": "Porto Velho",
"state": "RO",
"district": "Eldorado"
}
}
}
Attribute | Description |
---|---|
id (string) | Unique identifier of the user. |
name (string) | User's first name. |
lastname (string) | User's full last name. |
account_number (string) | User's account number. |
taxpayer_id (string) | User's CPF or CNPJ, without formatting. |
email (string) | User's email address. |
phone (string) | User's phone number with country code. |
birthdate (string) | User's date of birth in the format YYYY-MM-DD . |
mcc (string) | Seller's merchant category code. |
status (string) | User account status (e.g.: active , inactive ). |
statement_descriptor (string) | Name that will appear on the invoice. |
zip_code (string) | Postal code (ZIP) of the user's address. |
street (string) | Street name. |
number (string) | Street number. |
city (string) | Address city. |
state (string) | Address state in abbreviation format (e.g.: SP ). |
district (string) | Address district (neighborhood). |