EndUser (1.0)

Download OpenAPI specification:Download

API to manage endusers

EndUser

Get items

Authorizations:

Bearer

query Parameters

required	object (Pageable)
predicate required	object
target	string
storeId	any Filter end user by its exact storeId
email	any Filter end user by its exact email
country	any Example: country=FR Filter end user by its country (code iso 2)
zipCode	any Filter end user by its zipCode
status	any Filter end user by its status (ENABLED, DISABLED)
type	any Filter end user by its type (BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED)
groupId	any Filter end user by its groupId
firstName	any Filter end user by its exact firstName
lastName	any Filter end user by its exact lastName
cpf	any Example: cpf=FR Filter end user by its cpf
city	any Filter end user by its city
locale	any Filter end user by its locale
login	any Filter end user by its login
phone	any Filter end user by its phone
title	any Filter end user by its title (MR, MRS)
company.companyName	any Filter end user by its exact companyName
company.vatNumber	any Filter end user by its exact vatNumber
company.website	any Example: company.website=FR Filter end user by its website
company.cnpj	any Filter end user by its cnpj
company.fullRegistrationNumber	any Filter end user by its fullRegistrationNumber
company.registrationNumber	any Filter end user by its registrationNumber
company.apeCode	any Filter end user by its apeCode

Responses

Response samples

Content type

application/json

{"items": [{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Create an item

Authorizations:

Bearer

Request Body schema: application/json
required

acceptResellerPINUpdate	boolean
accountCreated	boolean
anonymousEndUser	boolean The boolean is used in order to know if an end-user is anonymous or not
birthDate	string <date-time> Birth date
captchaToken	string
city required	string City
cloneId	string end-user id from the clone which was cloned from this end-user
clonedFromEndUser	string end-user id from where this end-user was cloned
	object (Company) Company information
consumerType	string End user consumer type, company or personal
country required	string Country
cpf	string CPF value
createDate	string <date-time> Deprecated
customerId	string
dbVersion	integer <int64>
email required	string [ 6 .. 150 ] characters Email
enduserId	string
externalId	string External ID
firstName	string [ 1 .. 250 ] characters First name
fullName	string
groupId	string Group ID
id	string Deprecated
imported	boolean defined if the end user was imported from another platform
isClone	boolean it determines if an end-user is cloned or not
lastName	string [ 1 .. 250 ] characters Last name
lastUpdateReason	string
locale required	string Locale used by end user
login	string Deprecated Login
modelVersion	string Deprecated
originalId	string
phone	string Phone
recipientCode	string Recipient Code, specially for Italy, San Marino and Vatican
region	string Region
resellerTaxExemptionEligible	boolean Flag to indicate tax exemption eligibility for reseller
resellerTaxExemptionExpirationDate	string <date-time> End date when tax exemption for reseller is not eligible anymore
	object (ShippingAddress)
	Array of objects (ShippingAddress) List of shipping address
storeId required	string Store ID
	object (Route) Store route used known by the end user
streetAddress	string Street address
taxExemptionEligible	boolean Flag to indicate tax exemption eligibility
title	string Enum: "MR" "MRS" Title
token	string Create token to initiate and reset password
type	string Enum: "BUYER" "RESELLER" "PENDING_POST_REGISTRATION" "RESELLER_NOT_APPROVED" "RESELLER_DECLINED" Type
updateDate	string <date-time> Deprecated
userName	string
	object (Wallet) List of payment methods
zipCode	string Zip/postal code of town

Responses

Request samples

Payload

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"captchaToken": "string",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"originalId": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"hasSubscription": "string"
},
"zipCode": 75001
}

Response samples

Content type

application/json

{"details": [{"errorType": "string",
"resourceDisplayName": "string",
"resourceId": "string",
"resourceType": "string",
"specific": { }
}
],
"error": "string",
"message": "string",
"status": 0,
"timestamp": 0
}

Clone endUser from a customer to another customer.

Authorizations:

Bearer

Request Body schema: application/json
required

fromCustomerId required	string
originalEndUserId required	string
toCustomerId required	string
toStoreId required	string

Responses

Request samples

Payload

Content type

application/json

{"fromCustomerId": "string",
"originalEndUserId": "string",
"toCustomerId": "string",
"toStoreId": "string"
}

Response samples

Content type

application/json

{"id": "string"
}

Get distinct values for a given field

Authorizations:

Bearer

query Parameters

target	string
required	object (Pageable)
predicate required	object

Responses

Response samples

Content type

application/json

{"items": [{ }
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Import end user

Authorizations:

Bearer

query Parameters

dryRun	boolean dryRun or not dryRun
reason	string reason of request

Request Body schema: application/json
required

End user to import

acceptResellerPINUpdate	boolean
accountCreated	boolean
anonymousEndUser	boolean The boolean is used in order to know if an end-user is anonymous or not
birthDate	string <date-time> Birth date
captchaToken	string
city required	string City
cloneId	string end-user id from the clone which was cloned from this end-user
clonedFromEndUser	string end-user id from where this end-user was cloned
	object (Company) Company information
consumerType	string End user consumer type, company or personal
country required	string Country
cpf	string CPF value
createDate	string <date-time> Deprecated
customerId	string
dbVersion	integer <int64>
email required	string [ 6 .. 150 ] characters Email
enduserId	string
externalId	string External ID
firstName	string [ 1 .. 250 ] characters First name
fullName	string
groupId	string Group ID
id	string Deprecated
imported	boolean defined if the end user was imported from another platform
isClone	boolean it determines if an end-user is cloned or not
lastName	string [ 1 .. 250 ] characters Last name
lastUpdateReason	string
locale required	string Locale used by end user
login	string Deprecated Login
modelVersion	string Deprecated
originalId	string
password	string
phone	string Phone
recipientCode	string Recipient Code, specially for Italy, San Marino and Vatican
region	string Region
resellerTaxExemptionEligible	boolean Flag to indicate tax exemption eligibility for reseller
resellerTaxExemptionExpirationDate	string <date-time> End date when tax exemption for reseller is not eligible anymore
sgUpdateDate	string <date-time>
	object (ShippingAddress)
	Array of objects (ShippingAddress) List of shipping address
storeId required	string Store ID
	object (Route) Store route used known by the end user
streetAddress	string Street address
	Array of objects (Subscription) unique
taxExemptionEligible	boolean Flag to indicate tax exemption eligibility
title	string Enum: "MR" "MRS" Title
token	string Create token to initiate and reset password
type	string Enum: "BUYER" "RESELLER" "PENDING_POST_REGISTRATION" "RESELLER_NOT_APPROVED" "RESELLER_DECLINED" Type
updateDate	string <date-time> Deprecated
userName	string
	object (Wallet) List of payment methods
zipCode	string Zip/postal code of town

Responses

Request samples

Payload

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"captchaToken": "string",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"originalId": "string",
"password": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"sgUpdateDate": "2019-08-24T14:15:22Z",
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"subscriptionsToImport": [{"displayPriceFunctionParametersUpgrade": true,
"endUserId": "string",
"id": "string",
"orders": [{"generation": "string",
"id": "string",
"previousOrderIds": ["string"
],
"taxTransactionId": "string"
}
],
"paymentMethodDetails": {"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
},
"products": [{"activationCode": "activationCode-0123456",
"currency": "EUR",
"id": "406c6dcc-033c-46ad-ab16-d7666a994213",
"lineItemId": "406c6dcc-033c-46ad-ab16-d7666a994213",
"name": "Product A",
"price": 99,
"priceFunctionParameters": {"property1": "string",
"property2": "string"
},
"productId": "406c6dcc-033c-46ad-ab16-d7666a994213",
"quantity": 12
}
],
"status": "Running, Canceled",
"transactionId": "0370be2e-6dfb-4e36-b16a-fa4cc968a9d5"
}
],
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"hasSubscription": "string"
},
"zipCode": 75001
}

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Login

Authorizations:

Bearer

Request Body schema: application/json
required

customerId required	string Customer ID
identifier	string
password required	string End user password
storeId	string
username required	string End user username

Responses

Request samples

Payload

Content type

application/json

{"customerId": "d9efab80-541e-11eb-ae93-0242ac130002",
"identifier": "string",
"password": "mySecurePassword",
"storeId": "string",
"username": "myUserName"
}

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Get recap quantities for a given field

Authorizations:

Bearer

query Parameters

target required	string
required	object (Pageable)
predicate required	object

Responses

Response samples

Content type

application/json

{"items": [{"count": 0,
"targetValue": "string"
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

get personal enduser

Authorizations:

Bearer

Request Body schema: application/json
required

city required	string [ 1 .. 150 ] characters City
	object (ResellerCompany) Company information
country required	string Country
cpf	string CPF value
email required	string [ 6 .. 150 ] characters Email
firstName required	string [ 1 .. 250 ] characters First name
lastName required	string [ 1 .. 250 ] characters Last name
locale	string Locale used by end user
phone	string Street address
resellerPIN required	string Reseller PIN
streetAddress	string Street address
zipCode required	string [ 1 .. 50 ] characters Zip/postal code of town

Responses

Request samples

Payload

Content type

application/json

{"city": "Sens",
"company": {"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"vatNumber": "FR0012346789"
},
"country": "FR",
"cpf": "984.789.857-00",
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"locale": "fr-FR",
"phone": 2,
"resellerPIN": "XXXXX",
"streetAddress": 2,
"zipCode": 75001
}

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Create or update a Reseller by SSO

Authorizations:

Bearer

Request Body schema: application/json
required

city required	string [ 1 .. 150 ] characters City
	object (ResellerCompany) Company information
country required	string Country
cpf	string CPF value
email required	string [ 6 .. 150 ] characters Email
firstName required	string [ 1 .. 250 ] characters First name
lastName required	string [ 1 .. 250 ] characters Last name
locale	string Locale used by end user
phone	string Street address
resellerPIN required	string Reseller PIN
streetAddress	string Street address
zipCode required	string [ 1 .. 50 ] characters Zip/postal code of town

Responses

Request samples

Payload

Content type

application/json

{"city": "Sens",
"company": {"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"vatNumber": "FR0012346789"
},
"country": "FR",
"cpf": "984.789.857-00",
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"locale": "fr-FR",
"phone": 2,
"resellerPIN": "XXXXX",
"streetAddress": 2,
"zipCode": 75001
}

Response samples

Content type

application/json

{"redirectionURL": "https://www.nexway.com"
}

update a partial Reseller data by JWE

Authorizations:

Bearer

Request Body schema: application/json
required

city required	string [ 1 .. 150 ] characters City
	object (ResellerCompany) Company information
country required	string Country
cpf	string CPF value
email required	string [ 6 .. 150 ] characters Email
firstName required	string [ 1 .. 250 ] characters First name
lastName required	string [ 1 .. 250 ] characters Last name
locale	string Locale used by end user
phone	string Street address
resellerPIN required	string Reseller PIN
streetAddress	string Street address
zipCode required	string [ 1 .. 50 ] characters Zip/postal code of town

Responses

Request samples

Payload

Content type

application/json

{"city": "Sens",
"company": {"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"vatNumber": "FR0012346789"
},
"country": "FR",
"cpf": "984.789.857-00",
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"locale": "fr-FR",
"phone": 2,
"resellerPIN": "XXXXX",
"streetAddress": 2,
"zipCode": 75001
}

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Toggle subscription status

Authorizations:

Bearer

path Parameters

subscriptionId required	string subscription id
action required	string Example: reactive, suspend action to toggle

Responses

Response samples

Content type

application/json

{"details": [{"errorType": "string",
"resourceDisplayName": "string",
"resourceId": "string",
"resourceType": "string",
"specific": { }
}
],
"error": "string",
"message": "string",
"status": 0,
"timestamp": 0
}

Search unwind for a given field

Authorizations:

Bearer

query Parameters

target required	string
required	object (Pageable)
predicate required	object

Responses

Response samples

Content type

application/json

{"items": [{"empty": true,
"property1": { },
"property2": { }
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Deactivate Paypal payment method

Authorizations:

Bearer

Request Body schema: application/json
required

deactivationDateLimit

string <date-time>

End date of deactivation

Responses

Request samples

Payload

Content type

application/json

{"deactivationDateLimit": "2022-06-08 08:40:11"
}

Response samples

Content type

application/json

{"details": [{"errorType": "string",
"resourceDisplayName": "string",
"resourceId": "string",
"resourceType": "string",
"specific": { }
}
],
"error": "string",
"message": "string",
"status": 0,
"timestamp": 0
}

Delete item

Authorizations:

Bearer

path Parameters

required

string

Responses

Response samples

Content type

application/json

{ }

Get item

Authorizations:

Bearer

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Update item

Authorizations:

Bearer

path Parameters

required

string

Request Body schema: application/json
required

acceptResellerPINUpdate	boolean
accountCreated	boolean
anonymousEndUser	boolean The boolean is used in order to know if an end-user is anonymous or not
birthDate	string <date-time> Birth date
captchaToken	string
city required	string City
	object (Company) Company information
consumerType	string End user consumer type, company or personal
country required	string Country
cpf	string CPF value
createDate	string <date-time> Deprecated
customerId	string
dbVersion	integer <int64>
email required	string [ 6 .. 150 ] characters Email
enduserId	string
externalId	string External ID
firstName	string [ 1 .. 250 ] characters First name
fullName	string
groupId	string Group ID
id	string Deprecated
lastName	string [ 1 .. 250 ] characters Last name
lastUpdateReason	string
locale required	string Locale used by end user
login	string Deprecated Login
modelVersion	string Deprecated
originalId	string
phone	string Phone
recipientCode	string Recipient Code, specially for Italy, San Marino and Vatican
region	string Region
resellerTaxExemptionEligible	boolean Flag to indicate tax exemption eligibility for reseller
resellerTaxExemptionExpirationDate	string <date-time> End date when tax exemption for reseller is not eligible anymore
	object (ShippingAddress)
	Array of objects (ShippingAddress) List of shipping address
streetAddress	string Street address
taxExemptionEligible	boolean Flag to indicate tax exemption eligibility
title	string Enum: "MR" "MRS" Title
type	string Enum: "BUYER" "RESELLER" "PENDING_POST_REGISTRATION" "RESELLER_NOT_APPROVED" "RESELLER_DECLINED" Type
updateDate	string <date-time> Deprecated
userName	string
zipCode	string Zip/postal code of town

Responses

Request samples

Payload

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"captchaToken": "string",
"city": "Sens",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"originalId": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"zipCode": 75001
}

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Reset account of given end user id

Authorizations:

Bearer

path Parameters

required

string

End user id

query Parameters

reason

string

reason of request

Responses

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Change store route and storeId within the same customer for the enduser.

Authorizations:

Bearer

path Parameters

id required	string End user id
storeId required	string

query Parameters

reason

string

reason of request

Request Body schema: application/json
required

object (Route)

fullUrl	string
hostname	string
pathPrefix	string
url	string

Responses

Request samples

Payload

Content type

application/json

{"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
}
}

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Get replayable payment info attached to subscription of given end user by subscription id

Authorizations:

Bearer

path Parameters

id required	string End user id
subscriptionId required	string subscription id

query Parameters

reason

string

reason of request

Responses

Response samples

Content type

application/json

{"paymentMethodType": "string",
"replayable": true,
"subscriptionId": "string"
}

Get subscription of given end user by subscription id

Authorizations:

Bearer

path Parameters

id required	string End user id
subscriptionId required	string subscription id

query Parameters

reason

string

reason of request

Responses

Response samples

Content type

application/json

{"displayPriceFunctionParametersUpgrade": true,
"endUserId": "string",
"id": "string",
"orders": [{"generation": "string",
"id": "string",
"previousOrderIds": ["string"
],
"taxTransactionId": "string"
}
],
"paymentMethodDetails": {"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
},
"products": [{"activationCode": "activationCode-0123456",
"currency": "EUR",
"id": "406c6dcc-033c-46ad-ab16-d7666a994213",
"lineItemId": "406c6dcc-033c-46ad-ab16-d7666a994213",
"name": "Product A",
"price": 99,
"priceFunctionParameters": {"property1": "string",
"property2": "string"
},
"productId": "406c6dcc-033c-46ad-ab16-d7666a994213",
"quantity": 12
}
],
"status": "Running, Canceled",
"transactionId": "0370be2e-6dfb-4e36-b16a-fa4cc968a9d5"
}

Resynchronize subscription by payment method for given end user id

Authorizations:

Bearer

path Parameters

id required	string End user id
subscriptionId required	string subscription id

query Parameters

reason

string

reason of request

Responses

Response samples

Content type

application/json

{"details": [{"errorType": "string",
"resourceDisplayName": "string",
"resourceId": "string",
"resourceType": "string",
"specific": { }
}
],
"error": "string",
"message": "string",
"status": 0,
"timestamp": 0
}

Resynchronize transaction info (payment method) by transactionId for a given end user id

Authorizations:

Bearer

path Parameters

id required	string End user id
transactionId required	string Transaction id

Responses

Response samples

Content type

application/json

{"details": [{"errorType": "string",
"resourceDisplayName": "string",
"resourceId": "string",
"resourceType": "string",
"specific": { }
}
],
"error": "string",
"message": "string",
"status": 0,
"timestamp": 0
}

Add transaction in the wallet of given end user id

Authorizations:

Bearer

path Parameters

id required	string End user id
transactionId required	string

query Parameters

reason

string

reason of request

Responses

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Link subscription Id to payment method by transactionId of a given end user id

Authorizations:

Bearer

path Parameters

id required	string End user id
transactionId required	string transaction id
subscriptionId required	string subscription id

query Parameters

reason

string

reason of request

Responses

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Get payment replay data for given end user id and payment method id

Authorizations:

Bearer

path Parameters

id required	string End user id
paymentMethodId required	string payment method id

Responses

Response samples

Content type

application/json

{"paymentMethodId": "string",
"transactionId": "string",
"type": "string"
}

Group

Get items

Authorizations:

Bearer

query Parameters

required	object (Pageable)
predicate required	object
target	string
name	any Filter end user by its exact name
fallbackLocale	any Filter end user by its exact fallbackLocale
country	any Example: country=FR Filter end user by its country (code iso 2)
zipCode	any Filter end user by its zipCode

Responses

Response samples

Content type

application/json

{"items": [{"banner": {"href": "string",
"url": "https://wwww.domain.com/myLogo.png"
},
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"fallbackLocale": "en-US",
"id": "string",
"lastUpdateReason": "string",
"localizedBanner": "en-US",
"localizedLogo": "en-US",
"localizedLongDesc": "en-US",
"localizedShortDesc": "en-US",
"logo": {"href": "string",
"url": "https://wwww.domain.com/myLogo.png"
},
"modelVersion": "string",
"name": "myGroupName",
"updateDate": "2019-08-24T14:15:22Z",
"usedAsDefault": true
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Create an item

Authorizations:

Bearer

Request Body schema: application/json
required

	object (Asset) Deprecated Banner
createDate	string <date-time> Deprecated
customerId	string
dbVersion	integer <int64>
fallbackLocale	string This is the fallback locale
id	string Deprecated
lastUpdateReason	string
	object Localized banners group (map)
	object Localized logos group (map)
	object Localized long descriptions (map)
	object Localized short descriptions (map)
	object (Asset) Deprecated Logo
modelVersion	string Deprecated
name required	string Name
originalId	string
updateDate	string <date-time> Deprecated
usedAsDefault	boolean Group used by default

Responses

Request samples

Payload

Content type

application/json

{"banner": {"href": "string",
"url": "https://wwww.domain.com/myLogo.png"
},
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"fallbackLocale": "en-US",
"id": "string",
"lastUpdateReason": "string",
"localizedBanner": "en-US",
"localizedLogo": "en-US",
"localizedLongDesc": "en-US",
"localizedShortDesc": "en-US",
"logo": {"href": "string",
"url": "https://wwww.domain.com/myLogo.png"
},
"modelVersion": "string",
"name": "myGroupName",
"originalId": "string",
"updateDate": "2019-08-24T14:15:22Z",
"usedAsDefault": true
}

Response samples

Content type

application/json

{"details": [{"errorType": "string",
"resourceDisplayName": "string",
"resourceId": "string",
"resourceType": "string",
"specific": { }
}
],
"error": "string",
"message": "string",
"status": 0,
"timestamp": 0
}

Get distinct values for a given field

Authorizations:

Bearer

query Parameters

target	string
required	object (Pageable)
predicate required	object

Responses

Response samples

Content type

application/json

{"items": [{ }
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Get recap quantities for a given field

Authorizations:

Bearer

query Parameters

target required	string
required	object (Pageable)
predicate required	object

Responses

Response samples

Content type

application/json

{"items": [{"count": 0,
"targetValue": "string"
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Search unwind for a given field

Authorizations:

Bearer

query Parameters

target required	string
required	object (Pageable)
predicate required	object

Responses

Response samples

Content type

application/json

{"items": [{"empty": true,
"property1": { },
"property2": { }
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Delete item

Authorizations:

Bearer

path Parameters

required

string

Responses

Response samples

Content type

application/json

{ }

Get item

Authorizations:

Bearer

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"banner": {"href": "string",
"url": "https://wwww.domain.com/myLogo.png"
},
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"fallbackLocale": "en-US",
"id": "string",
"lastUpdateReason": "string",
"localizedBanner": "en-US",
"localizedLogo": "en-US",
"localizedLongDesc": "en-US",
"localizedShortDesc": "en-US",
"logo": {"href": "string",
"url": "https://wwww.domain.com/myLogo.png"
},
"modelVersion": "string",
"name": "myGroupName",
"updateDate": "2019-08-24T14:15:22Z",
"usedAsDefault": true
}

Update item

Authorizations:

Bearer

path Parameters

required

string

Request Body schema: application/json
required

	object (Asset) Deprecated Banner
createDate	string <date-time> Deprecated
customerId	string
dbVersion	integer <int64>
fallbackLocale	string This is the fallback locale
id	string Deprecated
lastUpdateReason	string
	object Localized banners group (map)
	object Localized logos group (map)
	object Localized long descriptions (map)
	object Localized short descriptions (map)
	object (Asset) Deprecated Logo
modelVersion	string Deprecated
name required	string Name
originalId	string
updateDate	string <date-time> Deprecated
usedAsDefault	boolean Group used by default

Responses

Request samples

Payload

Content type

application/json

{"banner": {"href": "string",
"url": "https://wwww.domain.com/myLogo.png"
},
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"fallbackLocale": "en-US",
"id": "string",
"lastUpdateReason": "string",
"localizedBanner": "en-US",
"localizedLogo": "en-US",
"localizedLongDesc": "en-US",
"localizedShortDesc": "en-US",
"logo": {"href": "string",
"url": "https://wwww.domain.com/myLogo.png"
},
"modelVersion": "string",
"name": "myGroupName",
"originalId": "string",
"updateDate": "2019-08-24T14:15:22Z",
"usedAsDefault": true
}

Response samples

Content type

application/json

{"banner": {"href": "string",
"url": "https://wwww.domain.com/myLogo.png"
},
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"fallbackLocale": "en-US",
"id": "string",
"lastUpdateReason": "string",
"localizedBanner": "en-US",
"localizedLogo": "en-US",
"localizedLongDesc": "en-US",
"localizedShortDesc": "en-US",
"logo": {"href": "string",
"url": "https://wwww.domain.com/myLogo.png"
},
"modelVersion": "string",
"name": "myGroupName",
"updateDate": "2019-08-24T14:15:22Z",
"usedAsDefault": true
}

EndUserPortal

Get end user portal by given end user ID Deprecated

Authorizations:

Bearer

Responses

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consent": {"consentStatus": {"newsletterOptin": true
},
"id": "string"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Update end user

Authorizations:

Bearer

query Parameters

storeHostname	string store host-name
version	integer <int64> version
dryRun	boolean dryRun or not dryRun
reason	string reason of request

Request Body schema: application/json
required

acceptResellerPINUpdate	boolean
accountCreated	boolean
anonymousEndUser	boolean The boolean is used in order to know if an end-user is anonymous or not
birthDate	string <date-time> Birth date
captchaToken	string
city required	string City
	object (Company) Company information
consumerType	string End user consumer type, company or personal
country required	string Country
cpf	string CPF value
createDate	string <date-time> Deprecated
customerId	string
dbVersion	integer <int64>
email required	string [ 6 .. 150 ] characters Email
enduserId	string
externalId	string External ID
firstName	string [ 1 .. 250 ] characters First name
fullName	string
groupId	string Group ID
id	string Deprecated
lastName	string [ 1 .. 250 ] characters Last name
lastUpdateReason	string
locale required	string Locale used by end user
login	string Deprecated Login
modelVersion	string Deprecated
originalId	string
phone	string Phone
recipientCode	string Recipient Code, specially for Italy, San Marino and Vatican
region	string Region
resellerTaxExemptionEligible	boolean Flag to indicate tax exemption eligibility for reseller
resellerTaxExemptionExpirationDate	string <date-time> End date when tax exemption for reseller is not eligible anymore
	object (ShippingAddress)
	Array of objects (ShippingAddress) List of shipping address
streetAddress	string Street address
taxExemptionEligible	boolean Flag to indicate tax exemption eligibility
title	string Enum: "MR" "MRS" Title
type	string Enum: "BUYER" "RESELLER" "PENDING_POST_REGISTRATION" "RESELLER_NOT_APPROVED" "RESELLER_DECLINED" Type
updateDate	string <date-time> Deprecated
userName	string
zipCode	string Zip/postal code of town

Responses

Request samples

Payload

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"captchaToken": "string",
"city": "Sens",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"originalId": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"zipCode": 75001
}

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Get end user public details

Get end user public details by password token and store id of end user

Authorizations:

Bearer

query Parameters

token required	string End user password token
storeId required	string store ID

Responses

Response samples

Content type

application/json

{"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED"
}

Get end user credit note as pdf

Authorizations:

Bearer

path Parameters

orderId required	string order id
creditNoteId required	string credit note id

Responses

Get end user Invoice as pdf(v2)

Authorizations:

Bearer

path Parameters

orderId

required

string

order id

Responses

Get subscription details of given end user id

Authorizations:

Bearer

path Parameters

subscriptionId

required

string

subscription id

query Parameters

reason

string

reason of request

Responses

Response samples

Content type

application/json

{"displayPriceFunctionParametersUpgrade": true,
"endUserId": "string",
"id": "string",
"orders": [{"generation": "string",
"id": "string",
"previousOrderIds": ["string"
],
"taxTransactionId": "string"
}
],
"paymentMethodDetails": {"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
},
"products": [{"activationCode": "activationCode-0123456",
"currency": "EUR",
"id": "406c6dcc-033c-46ad-ab16-d7666a994213",
"lineItemId": "406c6dcc-033c-46ad-ab16-d7666a994213",
"name": "Product A",
"price": 99,
"priceFunctionParameters": {"property1": "string",
"property2": "string"
},
"productId": "406c6dcc-033c-46ad-ab16-d7666a994213",
"quantity": 12
}
],
"status": "Running, Canceled",
"transactionId": "0370be2e-6dfb-4e36-b16a-fa4cc968a9d5"
}

Update end user subscription payment method

Authorizations:

Bearer

path Parameters

subscriptionId required	string subscription id
paymentMethodId required	string payment method id

query Parameters

dryRun	boolean dryRun or not dryRun
reason	string reason of request

Responses

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Update subscription status

Authorizations:

Bearer

path Parameters

subscriptionId required	string subscription id
action required	string Example: REACTIVATE, SUSPEND action

Responses

Response samples

Content type

application/json

{"details": [{"errorType": "string",
"resourceDisplayName": "string",
"resourceId": "string",
"resourceType": "string",
"specific": { }
}
],
"error": "string",
"message": "string",
"status": 0,
"timestamp": 0
}

Update password for given end user id

Authorizations:

Bearer

query Parameters

dryRun	boolean dryRun or not dryRun
reason	string reason of request

Request Body schema: application/json
required

newPassword required	string End user new password
oldPassword required	string End user old password
storeHostname required	string Hostname of store

Responses

Request samples

Payload

Content type

application/json

{"newPassword": "MyNewSecurePassword",
"oldPassword": "mySecurePassword",
"storeHostname": "reselleruk-store.staging.nexway.build"
}

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Update password for given end user id

Authorizations:

Bearer

path Parameters

required

string

End user id

query Parameters

dryRun	boolean dryRun or not dryRun
reason	string reason of request

Request Body schema: application/json
required

newPassword required	string End user new password
oldPassword required	string End user old password
storeHostname required	string Hostname of store

Responses

Request samples

Payload

Content type

application/json

{"newPassword": "MyNewSecurePassword",
"oldPassword": "mySecurePassword",
"storeHostname": "reselleruk-store.staging.nexway.build"
}

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Get end user payment method for subscription

Authorizations:

Bearer

path Parameters

subscriptionId

required

string

subscription id

Responses

Response samples

Content type

application/json

Example

CreditCard

{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}

Get wallet view for given end user id

Authorizations:

Bearer

query Parameters

status

string

Example: status= ACTIVATED, PENDING, ERROR, DEACTIVATED

status of payment

Responses

Response samples

Content type

application/json

{"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
}

Delete an end user payment method

Authorizations:

Bearer

path Parameters

paymentMethodId

required

string

payment Method id

query Parameters

dryRun	boolean dryRun or not dryRun
reason	string reason of request
force	boolean

Responses

Response samples

Content type

application/json

{"details": [{"errorType": "string",
"resourceDisplayName": "string",
"resourceId": "string",
"resourceType": "string",
"specific": { }
}
],
"error": "string",
"message": "string",
"status": 0,
"timestamp": 0
}

Get payment method public view by payment method id

Authorizations:

Bearer

path Parameters

paymentMethodId

required

string

payment method id

Responses

Response samples

Content type

application/json

Example

CreditCard

{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}

Add payment method to end user

Authorizations:

Bearer

path Parameters

paymentType

required

string

Example: paypal, sepa

paymentType

query Parameters

dryRun	boolean dryRun or not dryRun
reason	string reason of request

Request Body schema: application/json
required

context	string
	object
endUserId	string
endUserIp	string
paymentTypeId	string
requestReplayability	boolean
returnUrl	string
sessionId	string
storeId	string

Responses

Request samples

Payload

Content type

application/json

{"context": "string",
"currency": {"currencyCode": "string",
"defaultFractionDigits": 0,
"displayName": "string",
"numericCode": 0,
"numericCodeAsString": "string",
"symbol": "string"
},
"endUserId": "string",
"endUserIp": "string",
"paymentTypeId": "string",
"requestReplayability": true,
"returnUrl": "string",
"sessionId": "string",
"storeId": "string"
}

Response samples

Content type

application/json

{"message": "string",
"paymentMethodId": "string",
"redirect": "string",
"status": "string",
"uuid": "string"
}

Get the activation content of a fulfillment operation

Authorizations:

Bearer

path Parameters

endUserId required	string End user id
licenseId required	string nexway fulfillment id

Responses

Response samples

Content type

application/json

{ }

Get end user portal by given end user ID Deprecated

Authorizations:

Bearer

path Parameters

required

string

End user id

Responses

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consent": {"consentStatus": {"newsletterOptin": true
},
"id": "string"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Update end user

Authorizations:

Bearer

path Parameters

required

string

End user id

query Parameters

storeHostname	string store host-name
version	integer <int64> version
dryRun	boolean dryRun or not dryRun
reason	string reason of request

Request Body schema: application/json
required

acceptResellerPINUpdate	boolean
accountCreated	boolean
anonymousEndUser	boolean The boolean is used in order to know if an end-user is anonymous or not
birthDate	string <date-time> Birth date
captchaToken	string
city required	string City
	object (Company) Company information
consumerType	string End user consumer type, company or personal
country required	string Country
cpf	string CPF value
createDate	string <date-time> Deprecated
customerId	string
dbVersion	integer <int64>
email required	string [ 6 .. 150 ] characters Email
enduserId	string
externalId	string External ID
firstName	string [ 1 .. 250 ] characters First name
fullName	string
groupId	string Group ID
id	string Deprecated
lastName	string [ 1 .. 250 ] characters Last name
lastUpdateReason	string
locale required	string Locale used by end user
login	string Deprecated Login
modelVersion	string Deprecated
originalId	string
phone	string Phone
recipientCode	string Recipient Code, specially for Italy, San Marino and Vatican
region	string Region
resellerTaxExemptionEligible	boolean Flag to indicate tax exemption eligibility for reseller
resellerTaxExemptionExpirationDate	string <date-time> End date when tax exemption for reseller is not eligible anymore
	object (ShippingAddress)
	Array of objects (ShippingAddress) List of shipping address
streetAddress	string Street address
taxExemptionEligible	boolean Flag to indicate tax exemption eligibility
title	string Enum: "MR" "MRS" Title
type	string Enum: "BUYER" "RESELLER" "PENDING_POST_REGISTRATION" "RESELLER_NOT_APPROVED" "RESELLER_DECLINED" Type
updateDate	string <date-time> Deprecated
userName	string
zipCode	string Zip/postal code of town

Responses

Request samples

Payload

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"captchaToken": "string",
"city": "Sens",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"originalId": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"zipCode": 75001
}

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Get end user credit note as pdf

Authorizations:

Bearer

path Parameters

id required	string End user id
orderId required	string order id
creditNoteId required	string credit note id

Responses

Get end user Invoice as pdf(v2)

Authorizations:

Bearer

path Parameters

id required	string End user id
orderId required	string order id

Responses

Get subscription details of given end user id

Authorizations:

Bearer

path Parameters

id required	string End user id
subscriptionId required	string subscription id

query Parameters

reason

string

reason of request

Responses

Response samples

Content type

application/json

{"displayPriceFunctionParametersUpgrade": true,
"endUserId": "string",
"id": "string",
"orders": [{"generation": "string",
"id": "string",
"previousOrderIds": ["string"
],
"taxTransactionId": "string"
}
],
"paymentMethodDetails": {"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
},
"products": [{"activationCode": "activationCode-0123456",
"currency": "EUR",
"id": "406c6dcc-033c-46ad-ab16-d7666a994213",
"lineItemId": "406c6dcc-033c-46ad-ab16-d7666a994213",
"name": "Product A",
"price": 99,
"priceFunctionParameters": {"property1": "string",
"property2": "string"
},
"productId": "406c6dcc-033c-46ad-ab16-d7666a994213",
"quantity": 12
}
],
"status": "Running, Canceled",
"transactionId": "0370be2e-6dfb-4e36-b16a-fa4cc968a9d5"
}

Update end user subscription payment method

Authorizations:

Bearer

path Parameters

id required	string End user id
subscriptionId required	string subscription id
paymentMethodId required	string payment method id

query Parameters

dryRun	boolean dryRun or not dryRun
reason	string reason of request

Responses

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Update subscription status

Authorizations:

Bearer

path Parameters

id required	string End user id
subscriptionId required	string subscription id
action required	string Example: REACTIVATE, SUSPEND action

Responses

Response samples

Content type

application/json

{"details": [{"errorType": "string",
"resourceDisplayName": "string",
"resourceId": "string",
"resourceType": "string",
"specific": { }
}
],
"error": "string",
"message": "string",
"status": 0,
"timestamp": 0
}

Get upgrade recommendations of a previous item

Get recommendations for upgrade from already purchased product

Authorizations:

Bearer

path Parameters

required

string

End user id

query Parameters

previousLineItemId

required

string

previous LineItem id

Responses

Response samples

Content type

application/json

{ }

Get end user payment method for subscription

Authorizations:

Bearer

path Parameters

id required	string End user id
subscriptionId required	string subscription id

Responses

Response samples

Content type

application/json

Example

CreditCard

{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}

Get wallet view for given end user id

Authorizations:

Bearer

path Parameters

required

string

End user id

query Parameters

status

string

Example: status= ACTIVATED, PENDING, ERROR, DEACTIVATED

status of payment

Responses

Response samples

Content type

application/json

{"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
}

Delete an end user payment method

Authorizations:

Bearer

path Parameters

id required	string End user id
paymentMethodId required	string payment Method id

query Parameters

dryRun	boolean dryRun or not dryRun
reason	string reason of request
force	boolean

Responses

Response samples

Content type

application/json

{"details": [{"errorType": "string",
"resourceDisplayName": "string",
"resourceId": "string",
"resourceType": "string",
"specific": { }
}
],
"error": "string",
"message": "string",
"status": 0,
"timestamp": 0
}

Get payment method public view by payment method id

Authorizations:

Bearer

path Parameters

id required	string End user id
paymentMethodId required	string payment method id

Responses

Response samples

Content type

application/json

Example

CreditCard

{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}

Add payment method to end user

Authorizations:

Bearer

path Parameters

id required	string End user id
paymentType required	string Example: paypal, sepa paymentType

query Parameters

dryRun	boolean dryRun or not dryRun
reason	string reason of request

Request Body schema: application/json
required

context	string
	object
endUserId	string
endUserIp	string
paymentTypeId	string
requestReplayability	boolean
returnUrl	string
sessionId	string
storeId	string

Responses

Request samples

Payload

Content type

application/json

{"context": "string",
"currency": {"currencyCode": "string",
"defaultFractionDigits": 0,
"displayName": "string",
"numericCode": 0,
"numericCodeAsString": "string",
"symbol": "string"
},
"endUserId": "string",
"endUserIp": "string",
"paymentTypeId": "string",
"requestReplayability": true,
"returnUrl": "string",
"sessionId": "string",
"storeId": "string"
}

Response samples

Content type

application/json

{"message": "string",
"paymentMethodId": "string",
"redirect": "string",
"status": "string",
"uuid": "string"
}

Public

Create a new end user

Authorizations:

None

query Parameters

storeHostname	string Store host name
reason	string reason of request

Request Body schema: application/json
required

acceptResellerPINUpdate	boolean
accountCreated	boolean
anonymousEndUser	boolean The boolean is used in order to know if an end-user is anonymous or not
birthDate	string <date-time> Birth date
captchaToken	string
city required	string City
cloneId	string end-user id from the clone which was cloned from this end-user
clonedFromEndUser	string end-user id from where this end-user was cloned
	object (Company) Company information
consumerType	string End user consumer type, company or personal
country required	string Country
cpf	string CPF value
createDate	string <date-time> Deprecated
customerId	string
dbVersion	integer <int64>
email required	string [ 6 .. 150 ] characters Email
enduserId	string
externalId	string External ID
firstName	string [ 1 .. 250 ] characters First name
fullName	string
groupId	string Group ID
id	string Deprecated
imported	boolean defined if the end user was imported from another platform
isClone	boolean it determines if an end-user is cloned or not
lastName	string [ 1 .. 250 ] characters Last name
lastUpdateReason	string
locale required	string Locale used by end user
login	string Deprecated Login
modelVersion	string Deprecated
originalId	string
phone	string Phone
recipientCode	string Recipient Code, specially for Italy, San Marino and Vatican
region	string Region
resellerTaxExemptionEligible	boolean Flag to indicate tax exemption eligibility for reseller
resellerTaxExemptionExpirationDate	string <date-time> End date when tax exemption for reseller is not eligible anymore
	object (ShippingAddress)
	Array of objects (ShippingAddress) List of shipping address
storeId required	string Store ID
	object (Route) Store route used known by the end user
streetAddress	string Street address
taxExemptionEligible	boolean Flag to indicate tax exemption eligibility
title	string Enum: "MR" "MRS" Title
token	string Create token to initiate and reset password
type	string Enum: "BUYER" "RESELLER" "PENDING_POST_REGISTRATION" "RESELLER_NOT_APPROVED" "RESELLER_DECLINED" Type
updateDate	string <date-time> Deprecated
userName	string
	object (Wallet) List of payment methods
zipCode	string Zip/postal code of town

Responses

Request samples

Payload

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"captchaToken": "string",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"originalId": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"hasSubscription": "string"
},
"zipCode": 75001
}

Response samples

Content type

application/json

{ }

Initialize password and login

Authorizations:

None

path Parameters

passwordToken

required

string

End user password token

query Parameters

dryRun	boolean dryRun or not dryRun
reason	string reason of request

Request Body schema: application/json
required

login	string username to login
password required	string End user password
storeHostname required	string Hostname of store

Responses

Request samples

Payload

Content type

application/json

{"login": "jdoe",
"password": "mySecurePassword",
"storeHostname": "reselleruk-store.staging.nexway.build"
}

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

Register a new end user

Authorizations:

None

query Parameters

data required	string Base64 encoded data, contains end user information
reason	string reason of request
storeHostname required	string Store host name

Responses

Response samples

Content type

application/json

{ }

Reset end user password

Authorizations:

None

query Parameters

dryRun	boolean dryRun or not dryRun
reason	string reason of request

Request Body schema: application/json
required

email required	string [ 6 .. 150 ] characters End user email
storeHostname	string Store hostname
storeId required	string Store unique identifier

Responses

Request samples

Payload

Content type

application/json

{"email": "[email protected]",
"storeHostname": "reselleruk-store.staging.nexway.build",
"storeId": "f2c419a5-e486-44ef-b0c4-3c4368c6c74f"
}

Response samples

Content type

application/json

{"details": [{"errorType": "string",
"resourceDisplayName": "string",
"resourceId": "string",
"resourceType": "string",
"specific": { }
}
],
"error": "string",
"message": "string",
"status": 0,
"timestamp": 0
}

signIn without password

Authorizations:

None

Request Body schema: application/json
required

email required	string [ 6 .. 150 ] characters End user email
storeHostname required	string Store hostname
storeId required	string Store unique identifier

Responses

Request samples

Payload

Content type

application/json

{"email": "[email protected]",
"storeHostname": "reselleruk-store.staging.nexway.build",
"storeId": "f2c419a5-e486-44ef-b0c4-3c4368c6c74f"
}

Response samples

Content type

application/json

{"details": [{"errorType": "string",
"resourceDisplayName": "string",
"resourceId": "string",
"resourceType": "string",
"specific": { }
}
],
"error": "string",
"message": "string",
"status": 0,
"timestamp": 0
}

Update end user password

Authorizations:

None

path Parameters

token

required

string

End user password token

query Parameters

dryRun	boolean dryRun or not dryRun
reason	string reason of request

Request Body schema: application/json
required

password required	string End user password
storeHostname required	string Hostname of store

Responses

Request samples

Payload

Content type

application/json

{"password": "mySecurePassword",
"storeHostname": "reselleruk-store.staging.nexway.build"
}

Response samples

Content type

application/json

{"acceptResellerPINUpdate": true,
"accountCreated": true,
"anonymousEndUser": true,
"birthDate": "2002-01-09",
"city": "Sens",
"cloneId": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"clonedFromEndUser": "e8ba8d13-0736-47ae-80ad-1927ee88d658",
"company": {"apeCode": "0121Z",
"bannerResellerEmail": "string",
"cnpj": "34.517.518/0001-19",
"companyName": "Nexway",
"fullRegistrationNumber": 12345678900000,
"registrationNumber": 123456789,
"vatNumber": "FR0012346789",
"website": "http://wwww.nexway.com"
},
"consumerType": "company",
"country": "FR",
"cpf": "984.789.857-00",
"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"email": "[email protected]",
"emails": [{"createDate": 1610375836393,
"emailId": 12345,
"error": "Template not yet existing, you now need to add some template inside",
"id": "61a3a824-541a-11eb-ae93-0242ac130002",
"type": "ResetPasswordConfirmation"
}
],
"enduserId": "string",
"externalId": "string",
"firstName": "John",
"fullName": "string",
"groupId": "0dc22c4e-a0a8-4817-80b0-0d568398cceb",
"id": "string",
"imported": true,
"isClone": true,
"lastName": "John",
"lastUpdateReason": "string",
"locale": "fr-FR",
"login": "jhon_doe",
"modelVersion": "string",
"phone": "0612345678",
"recipientCode": "0000000 for individual, 1234567 (7 characters) for company and 123456 (6 characters) for public administration",
"region": "FR-MQ",
"resellerTaxExemptionEligible": true,
"resellerTaxExemptionExpirationDate": 1756290932000,
"shippingAddress": {"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
},
"shippingAddresses": [{"city": "Sens",
"country": "FR",
"firstName": "John",
"lastName": "John",
"phone": "0612345678",
"region": "FR-MQ",
"streetAddress": 2,
"title": "MR, MRS",
"zipCode": 75001
}
],
"status": "ENABLED, DISABLED",
"storeId": "7242c416-541b-11eb-ae93-0242ac130002",
"storeRoute": {"fullUrl": "string",
"hostname": "string",
"pathPrefix": "string",
"url": "string"
},
"streetAddress": 2,
"taxExemptionEligible": true,
"title": "MR, MRS",
"token": "67649705a43975baeec34c8749c0fda2",
"type": "BUYER, RESELLER, RESELLER_NOT_APPROVED, RESELLER_DECLINED",
"updateDate": "2019-08-24T14:15:22Z",
"userName": "string",
"wallet": {"creditCards": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"bin": "string",
"expirationDate": "12/2050",
"hash": "string"
}
],
"paymentMethodIdToUseForSubscriptionId": {"property1": "string",
"property2": "string"
},
"paypals": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"paypalPayerEmail": "[email protected]",
"paypalPayerFirstName": "John",
"paypalPayerLastName": "Doe",
"paypalUser": "sandrine-facilitator_api1.nexway.com"
}
],
"recurringUnknowns": [{"active": true,
"activeDetails": true,
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa",
"name": "string"
}
],
"sepas": [{"accountHolderName": "John",
"active": true,
"activeDetails": true,
"firstName": "Doe",
"iban": "FR4912739000509426863725O31",
"id": "147690b8-df3a-4622-be75-e71148f99b97",
"mainTransactionId": "string",
"paymentMethodType": "CreditCard, Sepa, Paypal, NonRecurringUnknown, RecurringUnknown",
"paymentType": {"category": "string",
"creditCard": true,
"id": "string",
"replayable": true,
"sepa": true
},
"status": "ACTIVATED, PENDING, ERROR, DEACTIVATED",
"transactionIds": "['88bd2803-9550-4077-8c41-4a05b03bb38d', '0dcf2166-8be7-4b98-840f-e02b31f17009']",
"type": "visa"
}
]
},
"zipCode": 75001
}

EndUser (1.0)

EndUser

Get items

Authorizations:

query Parameters

Responses

Response samples

Create an item

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Clone endUser from a customer to another customer.

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get distinct values for a given field

Authorizations:

query Parameters

Responses

Response samples

Import end user

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Login

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get recap quantities for a given field

Authorizations:

query Parameters

Responses

Response samples

get personal enduser

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create or update a Reseller by SSO

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

update a partial Reseller data by JWE

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Toggle subscription status

Authorizations:

path Parameters

Responses

Response samples

Search unwind for a given field

Authorizations:

query Parameters

Responses

Response samples

Deactivate Paypal payment method

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete item

Authorizations:

path Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required