Skip to main content
API docs by Redocly

Customer (1.0)

Download OpenAPI specification:Download

License: Nexway License Version 1.0

API to manage customers

Customer

Get items

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string
Example: target=vatNumber,addressBook,fulfillments,...

Return selected fields only (multiple occurrences allowed for selecting multiple fields)

email
string

Filter customer by its exact email

vatNumber
string
Example: vatNumber=FRXX999999999

Filter customer by its exact vatNumber

addressBook.country
string
Example: addressBook.country=USA

Filter customer by its addressBook country (code iso 2)

addressBook.streetAddress
string
Example: addressBook.streetAddress=1009

Filter customer by its addressBook streetAddress

addressBook.city
string
Example: addressBook.city=Brooklyn

Filter customer by its addressBook city

addressBook.state
string
Example: addressBook.state=New York

Filter customer by its addressBook state

addressBook.zipCode
integer <int64>
Example: addressBook.zipCode=11208

Filter customer by its addressBook zipCode

addressBook.phoneNumber
string
Example: addressBook.phoneNumber=9172457546

Filter customer by its addressBook phoneNumber

status
string
Enum: "TRIAL" "RUNNING"
Examples:
  • status=RUNNING - Customer status is RUNNING
  • status=TRIAL - Customer status is TRIAL

Filter customer by its exact customer status

cancelPeriod
integer <int32>
Example: cancelPeriod=15

Minimum number of days before cancel

bannerEmail
string
Example: bannerEmail=A Banner Email

Banner email

retryPaymentValidityDuration
integer <int64>
Example: retryPaymentValidityDuration=30

Retry payment validity duration. Max 90 days

quoteValidityDuration
integer <int64>
Example: quoteValidityDuration=30

Quote validity duration. Max 90 days

quoteSubscriptionValidityDuration
integer <int64>
Example: quoteSubscriptionValidityDuration=30

Quote Subscription validity duration. Max 90 days

multiplePaymentsValidityDuration
integer <int64>
Example: multiplePaymentsValidityDuration=30

Multiple payments validity duration. Max 90 days

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Create an item

Authorizations:
Bearer
Request Body schema: application/json
required
object (AddressBook)

Customer addressbook

authorizedCustomers
Array of strings unique
availableAdditionalPaymentTypes
Array of strings
Deprecated
availableLocales
Array of strings unique

Available locales

bannerEmail
string

Banner email

blackListedCountries
Array of strings

List of countries not authorized for this customer

blackListedPaymentTypes
Array of strings
Deprecated
cancelPeriod
integer <int32> >= 0

Cancel period (Day)

createDate
string <date-time>
Deprecated
createInvoice
boolean

Create the invoice as part of the order processing

dbVersion
integer <int64>
defaultFraudPoints
integer <int32> [ -9999 .. 9999 ]

Default fraud points

object (DefaultOnboardingProperties)

Default onboarding properties

required
object (Features)
object

Map of customer fulfillments

id
string
Deprecated
lastUpdateReason
string
legalEntityId
string

Legal Entity of the customer

object

Payment descriptors

object
logo
string

Logo

modelVersion
string
Deprecated
multiplePaymentsValidityDuration
integer <int64> <= 90

multiple payments validity duration

name
required
string [ 1 .. 150 ] characters

Customer name (company name)

onboardingGuideUrl
string

GuideUrl

onboardingManager
boolean
onboardingTermsUrl
string

TermsUrl

originalId
string
object (PaymentServiceConfiguration)
paymentVendor
string
Deprecated
promoteOneClickPayment
boolean
Deprecated
quoteSubscriptionValidityDuration
integer <int64> <= 90

quote subscription payment validity duration

quoteValidityDuration
integer <int64> <= 90

quote payment validity duration

remittableId
string
retryPaymentValidityDuration
integer <int64> <= 90

Retry payment validity duration

sendOrderConfirmationEmail
boolean

Send the confirmation email to the end user as part of the order processing

status
string
Enum: "TRIAL" "RUNNING"

Customer status

subscriptionUpgradeAuthorized
boolean

is subscription upgrade authorized on this customer

object

Customer subscriptions

updateDate
string <date-time>
Deprecated
urlToOverrideDirectPaymentPublicUrl
string

Directpayment Public URL

vatNumber
required
string [ 0 .. 50 ] characters

Customer vat number

zendeskBrandId
string

Responses

Request samples

Content type
application/json
{
  • "addressBook": {
    },
  • "authorizedCustomers": [
    ],
  • "availableAdditionalPaymentTypes": [
    ],
  • "availableLocales": [
    ],
  • "bannerEmail": "string",
  • "blackListedCountries": "[AF,AX]",
  • "blackListedPaymentTypes": [
    ],
  • "cancelPeriod": 30,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createInvoice": true,
  • "dbVersion": 0,
  • "defaultFraudPoints": 100,
  • "defaultOnboardingProperties": {
    },
  • "features": {
    },
  • "fulfillments": "{\"fulfilmentName\" \"fulfillmentName\"}",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "legalEntityId": "string",
  • "localizedPaymentDescriptors": {
    },
  • "localizedZendeskGuideUrls": {
    },
  • "logo": "https://www.domain.com/logo.png",
  • "modelVersion": "string",
  • "multiplePaymentsValidityDuration": 30,
  • "name": "My company name",
  • "onboardingGuideUrl": "https://www.domain.com/guide.pdf",
  • "onboardingManager": true,
  • "onboardingTermsUrl": "https://www.domain.com/terms.pdf",
  • "originalId": "string",
  • "paymentServiceConfiguration": {
    },
  • "paymentVendor": "string",
  • "promoteOneClickPayment": true,
  • "quoteSubscriptionValidityDuration": 30,
  • "quoteValidityDuration": 30,
  • "remittableId": "string",
  • "retryPaymentValidityDuration": 30,
  • "sendOrderConfirmationEmail": true,
  • "status": "TRIAL,RUNNING",
  • "subscriptionUpgradeAuthorized": true,
  • "subscriptions": {
    },
  • "updateDate": "2019-08-24T14:15:22Z",
  • "urlToOverrideDirectPaymentPublicUrl": "string",
  • "vatNumber": "FR47852256666666666666666",
  • "zendeskBrandId": "string"
}

Response samples

Content type
application/json
{
  • "addressBook": {
    },
  • "authorizedCustomers": [
    ],
  • "availableAdditionalPaymentTypes": [
    ],
  • "availableLocales": [
    ],
  • "bannerEmail": "string",
  • "blackListedCountries": "[AF,AX]",
  • "blackListedPaymentTypes": [
    ],
  • "cancelPeriod": 30,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createInvoice": true,
  • "dbVersion": 0,
  • "defaultFraudPoints": 100,
  • "defaultOnboardingProperties": {
    },
  • "features": {
    },
  • "fulfillments": "{\"fulfilmentName\" \"fulfillmentName\"}",
  • "iamClient": {
    },
  • "id": "string",
  • "lastUpdateReason": "string",
  • "legalEntityId": "string",
  • "localizedPaymentDescriptors": {
    },
  • "localizedZendeskGuideUrls": {
    },
  • "logo": "https://www.domain.com/logo.png",
  • "modelVersion": "string",
  • "multiplePaymentsValidityDuration": 30,
  • "name": "My company name",
  • "onboardingGuideUrl": "https://www.domain.com/guide.pdf",
  • "onboardingManager": true,
  • "onboardingTermsUrl": "https://www.domain.com/terms.pdf",
  • "paymentServiceConfiguration": {
    },
  • "paymentVendor": "string",
  • "promoteOneClickPayment": true,
  • "quoteSubscriptionValidityDuration": 30,
  • "quoteValidityDuration": 30,
  • "remittableId": "string",
  • "retryPaymentValidityDuration": 30,
  • "sendOrderConfirmationEmail": true,
  • "status": "TRIAL,RUNNING",
  • "subscriptionUpgradeAuthorized": true,
  • "subscriptionUpgradeConfiguration": {
    },
  • "subscriptions": {
    },
  • "type": "PUBLISHER,RESELLER",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "urlToOverrideDirectPaymentPublicUrl": "string",
  • "vatNumber": "FR47852256666666666666666",
  • "zendeskBrandId": "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
}

Get my customer

Get my customer using my JWT

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "blackListedPaymentTypes": [
    ],
  • "forcedPaymentTypes": [
    ],
  • "fulfillments": {
    },
  • "id": "string",
  • "localizedZendeskGuideUrls": {
    },
  • "logo": "string",
  • "name": "string",
  • "onboardingEnabled": true,
  • "onboardingGuideUrl": "string",
  • "onboardingTermsUrl": "string",
  • "status": "string",
  • "subscriptions": {
    },
  • "urlToOverrideDirectPaymentPublicUrl": "string",
  • "usingBillingPlan": true,
  • "usingFulfillmentV1": true,
  • "usingSafePIIData": true
}

Get a customer by name Deprecated

Get a customer by name

Authorizations:
Bearer
path Parameters
name
required
string
Example: A customer name

Customer name

Responses

Response samples

Content type
application/json
{
  • "addressBook": {
    },
  • "authorizedCustomers": [
    ],
  • "availableAdditionalPaymentTypes": [
    ],
  • "availableLocales": [
    ],
  • "bannerEmail": "string",
  • "blackListedCountries": "[AF,AX]",
  • "blackListedPaymentTypes": [
    ],
  • "cancelPeriod": 30,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createInvoice": true,
  • "dbVersion": 0,
  • "defaultFraudPoints": 100,
  • "defaultOnboardingProperties": {
    },
  • "features": {
    },
  • "fulfillments": "{\"fulfilmentName\" \"fulfillmentName\"}",
  • "iamClient": {
    },
  • "id": "string",
  • "lastUpdateReason": "string",
  • "legalEntityId": "string",
  • "localizedPaymentDescriptors": {
    },
  • "localizedZendeskGuideUrls": {
    },
  • "logo": "https://www.domain.com/logo.png",
  • "modelVersion": "string",
  • "multiplePaymentsValidityDuration": 30,
  • "name": "My company name",
  • "onboardingGuideUrl": "https://www.domain.com/guide.pdf",
  • "onboardingManager": true,
  • "onboardingTermsUrl": "https://www.domain.com/terms.pdf",
  • "paymentServiceConfiguration": {
    },
  • "paymentVendor": "string",
  • "promoteOneClickPayment": true,
  • "quoteSubscriptionValidityDuration": 30,
  • "quoteValidityDuration": 30,
  • "remittableId": "string",
  • "retryPaymentValidityDuration": 30,
  • "sendOrderConfirmationEmail": true,
  • "status": "TRIAL,RUNNING",
  • "subscriptionUpgradeAuthorized": true,
  • "subscriptionUpgradeConfiguration": {
    },
  • "subscriptions": {
    },
  • "type": "PUBLISHER,RESELLER",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "urlToOverrideDirectPaymentPublicUrl": "string",
  • "vatNumber": "FR47852256666666666666666",
  • "zendeskBrandId": "string"
}

Get customers by customer IDs or customer name

Get customers with public access, by list of customer id or customer name, can not process id and name search at the same time

Authorizations:
Bearer
query Parameters
required
object (Pageable)
Example: pageable=page=1&size=150

Pageable parameter, such size, page

id
string
Example: id=id1,id2,id3

List of customer id

name
string
Example: name=A customer name

Name of customer

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Verify the signed data

Verify for given customer id, if the signed data is valid or not

Authorizations:
Bearer
path Parameters
id
required
string
Example: 72fbb274-a6f2-4ba6-a74e-00a97cbd6c29

Customer id

Request Body schema: application/json
required
signedData
required
string

Signed data to verify and decode

Responses

Request samples

Content type
application/json
{
  • "signedData": "string"
}

Response samples

Content type
{ }

Get a customer

Get a customer with public access, by customer realm name or id

Authorizations:
Bearer
path Parameters
pathOrId
required
string
Example: 7d180bdd-3d82-41f5-8159-f0ab22ffb266 or A customer realm name

Customer realm name or id

Responses

Response samples

Content type
application/json
{
  • "blackListedPaymentTypes": [
    ],
  • "forcedPaymentTypes": [
    ],
  • "fulfillments": {
    },
  • "id": "string",
  • "localizedZendeskGuideUrls": {
    },
  • "logo": "string",
  • "name": "string",
  • "onboardingEnabled": true,
  • "onboardingGuideUrl": "string",
  • "onboardingTermsUrl": "string",
  • "status": "string",
  • "subscriptions": {
    },
  • "urlToOverrideDirectPaymentPublicUrl": "string",
  • "usingBillingPlan": true,
  • "usingFulfillmentV1": true,
  • "usingSafePIIData": true
}

Get a customer by realm name Deprecated

Get a customer by realm name

Authorizations:
Bearer
path Parameters
name
required
string
Example: A customer realm name

Customer realm name

Responses

Response samples

Content type
application/json
{
  • "addressBook": {
    },
  • "authorizedCustomers": [
    ],
  • "availableAdditionalPaymentTypes": [
    ],
  • "availableLocales": [
    ],
  • "bannerEmail": "string",
  • "blackListedCountries": "[AF,AX]",
  • "blackListedPaymentTypes": [
    ],
  • "cancelPeriod": 30,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createInvoice": true,
  • "dbVersion": 0,
  • "defaultFraudPoints": 100,
  • "defaultOnboardingProperties": {
    },
  • "features": {
    },
  • "fulfillments": "{\"fulfilmentName\" \"fulfillmentName\"}",
  • "iamClient": {
    },
  • "id": "string",
  • "lastUpdateReason": "string",
  • "legalEntityId": "string",
  • "localizedPaymentDescriptors": {
    },
  • "localizedZendeskGuideUrls": {
    },
  • "logo": "https://www.domain.com/logo.png",
  • "modelVersion": "string",
  • "multiplePaymentsValidityDuration": 30,
  • "name": "My company name",
  • "onboardingGuideUrl": "https://www.domain.com/guide.pdf",
  • "onboardingManager": true,
  • "onboardingTermsUrl": "https://www.domain.com/terms.pdf",
  • "paymentServiceConfiguration": {
    },
  • "paymentVendor": "string",
  • "promoteOneClickPayment": true,
  • "quoteSubscriptionValidityDuration": 30,
  • "quoteValidityDuration": 30,
  • "remittableId": "string",
  • "retryPaymentValidityDuration": 30,
  • "sendOrderConfirmationEmail": true,
  • "status": "TRIAL,RUNNING",
  • "subscriptionUpgradeAuthorized": true,
  • "subscriptionUpgradeConfiguration": {
    },
  • "subscriptions": {
    },
  • "type": "PUBLISHER,RESELLER",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "urlToOverrideDirectPaymentPublicUrl": "string",
  • "vatNumber": "FR47852256666666666666666",
  • "zendeskBrandId": "string"
}

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": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Sign data with JWT

Sign data for the authenticated (by JWT) customer

Authorizations:
Bearer
query Parameters
customerId
string
Example: customerId=d174b90c-1857-4646-86c9-6c9ef3bb41fb

Customer id

max
integer <int32>
Example: max=200

Max limit of Base64 encoded signed data, if the length of encoded signed data is longer than max or the sign is persist, then return SignedResponse with sign data and SIGNED- concatenated by PersistedSignedData id

persist
boolean
Example: persist=true

If persist is true or the length of Base64 encoded signed data is longer than max, then return SignedResponse with sign data and SIGNED- concatenated by PersistedSignedData id

header Parameters
Content-Type
string
Examples:
  • application/json - application/json
  • text/plain - text/plain

Content type of request

Request Body schema:
required

data to sign

string

Responses

Request samples

Content type
"string"

Response samples

Content type
application/json
{
  • "originalData": { },
  • "signedData": "string"
}

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": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Verify the signed data with JWT

Check for the authenticated customer with JWT, whether the signed data is valid or not

Authorizations:
Bearer
query Parameters
customerId
string
Example: customerId=0c379646-f594-46dd-81b3-9e0368649432

Customer id

Request Body schema: application/json
required
signedData
required
string

Signed data to verify and decode

Responses

Request samples

Content type
application/json
{
  • "signedData": "string"
}

Response samples

Content type
{ }

Sign data

Sign data for the given customer id

Authorizations:
Bearer
path Parameters
customerId
required
string
Example: 630da7a8-83f0-4cba-ba87-25f10680fdc9

Customer id

query Parameters
max
integer <int32>
Example: max=200

Max limit of Base64 encoded signed data, if the length of encoded signed data is longer than max or the sign is persist, then return SignedResponse with sign data and SIGNED- concatenated by PersistedSignedData id

persist
boolean
Example: persist=true

If persist is true or the length of encoded signed data is longer than max, then return SignedResponse with sign data and SIGNED- concatenated by PersistedSignedData id

header Parameters
Content-Type
string
Examples:
  • application/json - application/json
  • text/plain - text/plain

Content type of request

Request Body schema:
required

data to sign

string

Responses

Request samples

Content type
"string"

Response samples

Content type
application/json
{
  • "originalData": { },
  • "signedData": "string"
}

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "addressBook": {
    },
  • "authorizedCustomers": [
    ],
  • "availableAdditionalPaymentTypes": [
    ],
  • "availableLocales": [
    ],
  • "bannerEmail": "string",
  • "blackListedCountries": "[AF,AX]",
  • "blackListedPaymentTypes": [
    ],
  • "cancelPeriod": 30,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createInvoice": true,
  • "dbVersion": 0,
  • "defaultFraudPoints": 100,
  • "defaultOnboardingProperties": {
    },
  • "features": {
    },
  • "fulfillments": "{\"fulfilmentName\" \"fulfillmentName\"}",
  • "iamClient": {
    },
  • "id": "string",
  • "lastUpdateReason": "string",
  • "legalEntityId": "string",
  • "localizedPaymentDescriptors": {
    },
  • "localizedZendeskGuideUrls": {
    },
  • "logo": "https://www.domain.com/logo.png",
  • "modelVersion": "string",
  • "multiplePaymentsValidityDuration": 30,
  • "name": "My company name",
  • "onboardingGuideUrl": "https://www.domain.com/guide.pdf",
  • "onboardingManager": true,
  • "onboardingTermsUrl": "https://www.domain.com/terms.pdf",
  • "paymentServiceConfiguration": {
    },
  • "paymentVendor": "string",
  • "promoteOneClickPayment": true,
  • "quoteSubscriptionValidityDuration": 30,
  • "quoteValidityDuration": 30,
  • "remittableId": "string",
  • "retryPaymentValidityDuration": 30,
  • "sendOrderConfirmationEmail": true,
  • "status": "TRIAL,RUNNING",
  • "subscriptionUpgradeAuthorized": true,
  • "subscriptionUpgradeConfiguration": {
    },
  • "subscriptions": {
    },
  • "type": "PUBLISHER,RESELLER",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "urlToOverrideDirectPaymentPublicUrl": "string",
  • "vatNumber": "FR47852256666666666666666",
  • "zendeskBrandId": "string"
}

Update item

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema: application/json
required
object (AddressBook)

Customer addressbook

authorizedCustomers
Array of strings unique
availableAdditionalPaymentTypes
Array of strings
Deprecated
availableLocales
Array of strings unique

Available locales

bannerEmail
string

Banner email

blackListedCountries
Array of strings

List of countries not authorized for this customer

blackListedPaymentTypes
Array of strings
Deprecated
cancelPeriod
integer <int32> >= 0

Cancel period (Day)

createDate
string <date-time>
Deprecated
createInvoice
boolean

Create the invoice as part of the order processing

dbVersion
integer <int64>
defaultFraudPoints
integer <int32> [ -9999 .. 9999 ]

Default fraud points

object (DefaultOnboardingProperties)

Default onboarding properties

required
object (Features)
object

Map of customer fulfillments

id
string
Deprecated
lastUpdateReason
string
legalEntityId
string

Legal Entity of the customer

object

Payment descriptors

object
logo
string

Logo

modelVersion
string
Deprecated
multiplePaymentsValidityDuration
integer <int64> <= 90

multiple payments validity duration

name
required
string [ 1 .. 150 ] characters

Customer name (company name)

onboardingGuideUrl
string

GuideUrl

onboardingManager
boolean
onboardingTermsUrl
string

TermsUrl

originalId
string
object (PaymentServiceConfiguration)
paymentVendor
string
Deprecated
promoteOneClickPayment
boolean
Deprecated
quoteSubscriptionValidityDuration
integer <int64> <= 90

quote subscription payment validity duration

quoteValidityDuration
integer <int64> <= 90

quote payment validity duration

remittableId
string
retryPaymentValidityDuration
integer <int64> <= 90

Retry payment validity duration

sendOrderConfirmationEmail
boolean

Send the confirmation email to the end user as part of the order processing

status
string
Enum: "TRIAL" "RUNNING"

Customer status

subscriptionUpgradeAuthorized
boolean

is subscription upgrade authorized on this customer

object

Customer subscriptions

updateDate
string <date-time>
Deprecated
urlToOverrideDirectPaymentPublicUrl
string

Directpayment Public URL

vatNumber
required
string [ 0 .. 50 ] characters

Customer vat number

zendeskBrandId
string

Responses

Request samples

Content type
application/json
{
  • "addressBook": {
    },
  • "authorizedCustomers": [
    ],
  • "availableAdditionalPaymentTypes": [
    ],
  • "availableLocales": [
    ],
  • "bannerEmail": "string",
  • "blackListedCountries": "[AF,AX]",
  • "blackListedPaymentTypes": [
    ],
  • "cancelPeriod": 30,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createInvoice": true,
  • "dbVersion": 0,
  • "defaultFraudPoints": 100,
  • "defaultOnboardingProperties": {
    },
  • "features": {
    },
  • "fulfillments": "{\"fulfilmentName\" \"fulfillmentName\"}",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "legalEntityId": "string",
  • "localizedPaymentDescriptors": {
    },
  • "localizedZendeskGuideUrls": {
    },
  • "logo": "https://www.domain.com/logo.png",
  • "modelVersion": "string",
  • "multiplePaymentsValidityDuration": 30,
  • "name": "My company name",
  • "onboardingGuideUrl": "https://www.domain.com/guide.pdf",
  • "onboardingManager": true,
  • "onboardingTermsUrl": "https://www.domain.com/terms.pdf",
  • "originalId": "string",
  • "paymentServiceConfiguration": {
    },
  • "paymentVendor": "string",
  • "promoteOneClickPayment": true,
  • "quoteSubscriptionValidityDuration": 30,
  • "quoteValidityDuration": 30,
  • "remittableId": "string",
  • "retryPaymentValidityDuration": 30,
  • "sendOrderConfirmationEmail": true,
  • "status": "TRIAL,RUNNING",
  • "subscriptionUpgradeAuthorized": true,
  • "subscriptions": {
    },
  • "updateDate": "2019-08-24T14:15:22Z",
  • "urlToOverrideDirectPaymentPublicUrl": "string",
  • "vatNumber": "FR47852256666666666666666",
  • "zendeskBrandId": "string"
}

Response samples

Content type
application/json
{
  • "addressBook": {
    },
  • "authorizedCustomers": [
    ],
  • "availableAdditionalPaymentTypes": [
    ],
  • "availableLocales": [
    ],
  • "bannerEmail": "string",
  • "blackListedCountries": "[AF,AX]",
  • "blackListedPaymentTypes": [
    ],
  • "cancelPeriod": 30,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createInvoice": true,
  • "dbVersion": 0,
  • "defaultFraudPoints": 100,
  • "defaultOnboardingProperties": {
    },
  • "features": {
    },
  • "fulfillments": "{\"fulfilmentName\" \"fulfillmentName\"}",
  • "iamClient": {
    },
  • "id": "string",
  • "lastUpdateReason": "string",
  • "legalEntityId": "string",
  • "localizedPaymentDescriptors": {
    },
  • "localizedZendeskGuideUrls": {
    },
  • "logo": "https://www.domain.com/logo.png",
  • "modelVersion": "string",
  • "multiplePaymentsValidityDuration": 30,
  • "name": "My company name",
  • "onboardingGuideUrl": "https://www.domain.com/guide.pdf",
  • "onboardingManager": true,
  • "onboardingTermsUrl": "https://www.domain.com/terms.pdf",
  • "paymentServiceConfiguration": {
    },
  • "paymentVendor": "string",
  • "promoteOneClickPayment": true,
  • "quoteSubscriptionValidityDuration": 30,
  • "quoteValidityDuration": 30,
  • "remittableId": "string",
  • "retryPaymentValidityDuration": 30,
  • "sendOrderConfirmationEmail": true,
  • "status": "TRIAL,RUNNING",
  • "subscriptionUpgradeAuthorized": true,
  • "subscriptionUpgradeConfiguration": {
    },
  • "subscriptions": {
    },
  • "type": "PUBLISHER,RESELLER",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "urlToOverrideDirectPaymentPublicUrl": "string",
  • "vatNumber": "FR47852256666666666666666",
  • "zendeskBrandId": "string"
}

Create an Account Holder

Create an Account Holder for the given customer id

Authorizations:
Bearer
path Parameters
id
required
string
Example: 57bb3a89-0561-4cfc-a109-3122eb16441a

Customer id

query Parameters
reason
string
Example: reason=A reason of create the account holder

Request reason

Request Body schema: application/json
required
customerId
string
details
object (RemittanceAccount)

Details of remittance account, used by the partner payment account

parentRemittableId
string

Id of parent remittable, used to link with the partner payment account

vendor
string

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "details": { },
  • "parentRemittableId": "string",
  • "vendor": "string"
}

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "error": "string",
  • "message": "string",
  • "status": 0,
  • "timestamp": 0
}

Generate an additional secret key

Generate an additional secret key for the given customer id

Authorizations:
Bearer
path Parameters
id
required
string
Example: 8ed1d919-75bb-445b-8e57-26f6263fd72d

Customer id

query Parameters
reason
string
Example: reason=A generate secret key reason

Request reason

Responses

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "error": "string",
  • "message": "string",
  • "status": 0,
  • "timestamp": 0
}

Delete a secret key

Delete a secret key for the given customer id

Authorizations:
Bearer
path Parameters
id
required
string
Example: 8d95d991-b6d6-4a80-b335-4b8e28a60728

Customer id

secret
required
string
Example: A secret key

Customer secret

query Parameters
reason
string
Example: reason=A reason of delete the secret key

Reason of request

Responses

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "error": "string",
  • "message": "string",
  • "status": 0,
  • "timestamp": 0
}

BlackedSignedData

Get items

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Create an item

Authorizations:
Bearer
Request Body schema: application/json
required
createDate
string <date-time>
Deprecated
customerId
string
dbVersion
integer <int64>
id
string
Deprecated
lastUpdateReason
string
modelVersion
string
Deprecated
originalId
string
signedData
required
string

Signed data to be blacklisted

updateDate
string <date-time>
Deprecated

Responses

Request samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "originalId": "string",
  • "signedData": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "clear": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "reason": "string",
  • "signature": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

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": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Remove blacklisted signed data

Remove a blacklisted signed data for authenticated customer or given customer id

Authorizations:
Bearer
query Parameters
customerId
string
Example: customerId=1ce58d01-3ad6-4614-9dbd-088fef63ac85

Customer id

reason
string
Example: reason=A reason of remove blacklisted signed data

Reason of request

Request Body schema: application/json
required
createDate
string <date-time>
Deprecated
customerId
string
dbVersion
integer <int64>
id
string
Deprecated
lastUpdateReason
string
modelVersion
string
Deprecated
originalId
string
signedData
required
string

Signed data to be blacklisted

updateDate
string <date-time>
Deprecated

Responses

Request samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "originalId": "string",
  • "signedData": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "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": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "clear": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "reason": "string",
  • "signature": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Update item

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema: application/json
required
clear
string
createDate
string <date-time>
Deprecated
customerId
string
dbVersion
integer <int64>
id
string
Deprecated
lastUpdateReason
string
modelVersion
string
Deprecated
originalId
string
reason
string
signature
string
updateDate
string <date-time>
Deprecated

Responses

Request samples

Content type
application/json
{
  • "clear": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "originalId": "string",
  • "reason": "string",
  • "signature": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "clear": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "reason": "string",
  • "signature": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Provider

Get items

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Create an item

Authorizations:
Bearer
Request Body schema: application/json
required
createDate
string <date-time>
Deprecated
dbVersion
integer <int64>
id
string
Deprecated
lastUpdateReason
string
required
object (LinkDefinition)
modelVersion
string
Deprecated
name
required
string

Provider name

originalId
string
updateDate
string <date-time>
Deprecated

Responses

Request samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "linkDefinition": {
    },
  • "modelVersion": "string",
  • "name": "My provider name",
  • "originalId": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "linkDefinition": {
    },
  • "modelVersion": "string",
  • "name": "My provider name",
  • "updateDate": "2019-08-24T14:15:22Z"
}

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": [
    ],
  • "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": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "linkDefinition": {
    },
  • "modelVersion": "string",
  • "name": "My provider name",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Update item

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema: application/json
required
createDate
string <date-time>
Deprecated
dbVersion
integer <int64>
id
string
Deprecated
lastUpdateReason
string
required
object (LinkDefinition)
modelVersion
string
Deprecated
name
required
string

Provider name

originalId
string
updateDate
string <date-time>
Deprecated

Responses

Request samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "linkDefinition": {
    },
  • "modelVersion": "string",
  • "name": "My provider name",
  • "originalId": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "linkDefinition": {
    },
  • "modelVersion": "string",
  • "name": "My provider name",
  • "updateDate": "2019-08-24T14:15:22Z"
}