POST https://api.nexway.store/endusers/import
The request body takes a complete EndUserImport resource, containing the following writable properties:
{
"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": null,
"firstName": "string",
"id": "string",
"lastName": "string",
"locale": "string",
"originalId": "string",
"password": "string",
"storeId": "string",
"streetAddress": "string",
"subscriptionsToImport": [
{
"subscriptionId": "string",
"transactionId": "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",
"status": "string",
"transactionIds": [
"string"
],
"type": "string"
}
],
"recurringUnknowns": [
{
"active": "boolean",
"id": "string",
"name": "string",
"paymentMethodType": "string",
"status": "string",
"transactionIds": [
"string"
],
"type": "string"
}
]
},
"zipCode": "string"
}
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 | |
string |
|
||
emails[] | array |
List of emails sent to end-user |
Optional |
firstName | string |
First name |
|
id | string | Optional | |
lastName | string |
Last name |
|
locale | string |
Locale used by end-user |
|
originalId | string | Optional | |
password | string | Optional | |
storeId | string |
Store ID |
|
streetAddress | string |
Street address |
Optional |
subscriptionsToImport[] | array | Optional | |
subscriptionsToImport[].subscriptionId | string | Optional | |
subscriptionsToImport[].transactionId | string | 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:
|
Optional |
wallet.creditCards[].status | string |
Activation status Possible values are:
|
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:
|
Optional |
wallet.paypals[].status | string |
Activation status Possible values are:
|
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:
|
Optional |
wallet.recurringUnknowns[].status | string |
Activation status Possible values are:
|
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 |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
OK |
{
"company": {},
"wallet": {}
}