Create a new enduser

Create a new enduser entry

Request

POST https://api.nexway.store/endusers

Request body

The request body takes a complete EndUser resource, containing the following writable properties:

{
    "accountCreated": "boolean",
    "city": "string",
    "company": {
        "companyId": "string",
        "companyName": "string",
        "vatNumber": "string"
    },
    "country": "string",
    "createDate": "date-time",
    "dbVersion": "int64",
    "email": "string",
    "emails": null,
    "firstName": "string",
    "id": "string",
    "identity": {
        "identityType": "string",
        "identityValue": "string"
    },
    "lastName": "string",
    "locale": "string",
    "modelVersion": "string",
    "storeId": "string",
    "streetAddress": "string",
    "token": "string",
    "updateDate": "date-time",
    "wallet": {
        "creditCards": [
            {
                "bin": "string",
                "expirationDate": "string",
                "hash": "string",
                "id": "string",
                "paymentMethodType": "string",
                "transactionIds": [
                    "string"
                ],
                "type": "string"
            }
        ],
        "paymentMethodIdToUseForSubscriptionId": {
            "<key>": "string"
        },
        "paypals": [
            {
                "id": "string",
                "paymentMethodType": "string",
                "transactionIds": [
                    "string"
                ]
            }
        ]
    },
    "zipCode": "string"
}

Properties

Name Type Description Additional
accountCreated boolean Optional
city string

City

company object Company Optional
company.companyId string

Company ID

Optional
company.companyName string

End-user company name

company.vatNumber string

Company VAT number

Optional
country string

Country

createDate date-time Optional
dbVersion int64 Optional
email string

Email

emails[] array

List of email send at the user

Optional
firstName string

First name

id string Optional
identity object Identity Optional
identity.identityType string

Entity type

identity.identityValue string

Entity value

lastName string

Last name

locale string

Locale use by the end user

modelVersion string Optional
storeId string

Store id

streetAddress string

Street address

token string

Token create for initiate and reset the password

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

List of credit cards

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
Optional
wallet.creditCards[].transactionIds[] array of string

List of transaction IDs

Optional
wallet.creditCards[].type string

Type of credit card (ex: VISA, MASTERCARD)

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 account

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
Optional
wallet.paypals[].transactionIds[] array of string

List of transaction IDs

Optional
zipCode string

Zipcode of the town

Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created

Success

EndUser
400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

409 Conflict

Conflict

500 Internal Server Error

Failure

503 Service Unavailable

Service not available

Example

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

Explore this API

endUser

endUser

Request Content-Type
Response Content-Type
Try it out!