EndUser resource

Methods

  • post - Create a new end-user
  • get - Get an end-user by ID
  • put - End-user: Initialize password
  • put - Update an end-user
  • put - Update end-user password

Resource

{
    "accountCreated": "boolean",
    "city": "string",
    "company": {
        "cnpj": "string",
        "companyName": "string",
        "vatNumber": "string"
    },
    "country": "string",
    "cpf": "string",
    "createDate": "date-time",
    "customerId": "string",
    "dbVersion": "int64",
    "email": "string",
    "emails": [
        {
            "createDate": "date-time",
            "emailId": "string",
            "error": "string",
            "id": "string",
            "type": "string"
        }
    ],
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "locale": "string",
    "status": "string",
    "storeId": "string",
    "streetAddress": "string",
    "token": "string",
    "updateDate": "date-time",
    "wallet": {
        "creditCards": [
            {
                "active": "boolean",
                "bin": "string",
                "expirationDate": "string",
                "hash": "string",
                "id": "string",
                "paymentMethodType": "string",
                "status": "string",
                "transactionIds": [
                    "string"
                ],
                "type": "string"
            }
        ],
        "paymentMethodIdToUseForSubscriptionId": {
            "<key>": "string"
        },
        "paypals": [
            {
                "active": "boolean",
                "id": "string",
                "paymentMethodType": "string",
                "paypalPayerEmail": "string",
                "paypalPayerFirstName": "string",
                "paypalPayerLastName": "string",
                "status": "string",
                "transactionIds": [
                    "string"
                ],
                "type": "string"
            }
        ],
        "recurringUnknowns": [
            {
                "active": "boolean",
                "id": "string",
                "name": "string",
                "paymentMethodType": "string",
                "status": "string",
                "transactionIds": [
                    "string"
                ],
                "type": "string"
            }
        ]
    },
    "zipCode": "string"
}

Properties

Name Type Description Additional
accountCreated boolean Optional
city string

City

company object Company Optional
company.cnpj string

CPNJ

Optional
company.companyName string

End-user company name

company.vatNumber string

Company VAT number

Optional
country string

Country

cpf string

CPF value

createDate date-time Optional
customerId string

Customer ID

dbVersion int64 Optional
email string

Email

emails[] array

List of emails sent to end-user

Optional
emails[].createDate date-time

Creation date

Optional, read only.
emails[].emailId string

Reference in email storage

Optional, read only.
emails[].error string

Error message if error occurs while sending email

Optional, read only.
emails[].id string

Email unique identifier

Optional, read only.
emails[].type string

Mail type

Optional, read only.
firstName string

First name

id string Optional
lastName string

Last name

locale string

Locale used by end-user

status string

Status

Possible values are:

  • ENABLED
  • DISABLED
Optional, read only.
storeId string

Store ID

streetAddress string

Street address

Optional
token string

Create token to initiate and reset password

Optional
updateDate date-time Optional
wallet object Wallet Optional
wallet.creditCards[] array

List of credit cards

Optional
wallet.creditCards[].active boolean Optional
wallet.creditCards[].bin string Optional
wallet.creditCards[].expirationDate string

Expiration date

Optional
wallet.creditCards[].hash string Optional
wallet.creditCards[].id string

Reference ID

Optional
wallet.creditCards[].paymentMethodType string

Type of payment method (ex: Credit card, Paypal)

Possible values are:

  • CreditCard
  • Paypal
  • NonRecurringUnknown
  • RecurringUnknown
Optional
wallet.creditCards[].status string

Activation status

Possible values are:

  • ACTIVATED
  • PENDING
  • ERROR
Optional
wallet.creditCards[].transactionIds[] array of string

List of transaction IDs

Optional
wallet.creditCards[].type string

Type in DP

Optional
wallet.paymentMethodIdToUseForSubscriptionId object

List of credit card use for each subscription

Optional
wallet.paymentMethodIdToUseForSubscriptionId.<key> map of string Optional
wallet.paypals[] array

List of PayPal accounts

Optional
wallet.paypals[].active boolean Optional
wallet.paypals[].id string

Reference ID

Optional
wallet.paypals[].paymentMethodType string

Type of payment method (ex: Credit card, Paypal)

Possible values are:

  • CreditCard
  • Paypal
  • NonRecurringUnknown
  • RecurringUnknown
Optional
wallet.paypals[].paypalPayerEmail string

PayPal payer email

Optional, read only.
wallet.paypals[].paypalPayerFirstName string

PayPal payer first name

Optional, read only.
wallet.paypals[].paypalPayerLastName string

PayPal payer last name

Optional, read only.
wallet.paypals[].status string

Activation status

Possible values are:

  • ACTIVATED
  • PENDING
  • ERROR
Optional
wallet.paypals[].transactionIds[] array of string

List of transaction IDs

Optional
wallet.paypals[].type string

Type in DP

Optional
wallet.recurringUnknowns[] array

List of recurring unknown payment methods

Optional
wallet.recurringUnknowns[].active boolean Optional
wallet.recurringUnknowns[].id string

Reference ID

Optional
wallet.recurringUnknowns[].name string Optional
wallet.recurringUnknowns[].paymentMethodType string

Type of payment method (ex: Credit card, Paypal)

Possible values are:

  • CreditCard
  • Paypal
  • NonRecurringUnknown
  • RecurringUnknown
Optional
wallet.recurringUnknowns[].status string

Activation status

Possible values are:

  • ACTIVATED
  • PENDING
  • ERROR
Optional
wallet.recurringUnknowns[].transactionIds[] array of string

List of transaction IDs

Optional
wallet.recurringUnknowns[].type string

Type in DP

Optional
zipCode string

Zip/postal code of town

Optional

Example

{
    "company": {},
    "wallet": {}
}