Create a Soletrader application

Parameters

Request Header Parameters

- api-version
- The requested API version
  3.0

- ApiKey
- Standard Authorization header using the ApiKey scheme.

- Content-Type
- Only application/json is supported.

Request Body Parameters

applicant

Applicant

- firstName
- <= 50 characters
  First name of the applicant. Maximum length is 33 when Middle Name is provided.

- middleName
- <= 33 characters
  Middle name of the applicant

- lastName
- <= 50 characters
  Last name of the applicant. Maximum length is 33 when Middle Name is provided

<= 50 characters

Social security number. Icelandic target market specific. Mandatory if target market is Icelandic.

For the countries listed in the following table, this field is also required and must not be null or blank. It must comply with the format that is specified in the Pattern column.

Country-specific validation rules:

Country	Identifier Name	Format	Length	Pattern
Belgium (BE)	Enterprise Number	10 numeric digits starting with 0 or 1	10	`^[01]\d{9}$`
Luxembourg (LU)	Business ID / VAT	8 numeric digits	8	`^\d{8}$`
France (FR)	SIRET	14 numeric digits	14	`^\d{14}$`
Italy (IT)	Codice Fiscale	16 alphanumeric characters	16	`^[A-Z]{6}[0-9L-V]{2}[A-EHLMPR-T][0-9L-V]{2}[A-Z][0-9L-V]{3}[A-Z]$`

- address
- Note: applicant and store address country code must be the same!
  street
  <= 50 characters
  Street and name/number of the building. Allowed characters: A-Z, a-z, 0-9 '()*.+,-
  postalCode
  [ 3 .. 10 ] characters
  Postal code for the building. Allowed characters: A-Z, a-z, 0-9 '()*.+,-
  city
  <= 100 characters
  Town or city name. Allowed characters: A-Z, a-z, 0-9 '()*.+,-
  countryCode
  <= 2 characters
  Alpha-2 code for country.

- phone
- <= 15 characters
  Phone number in the format +[country code]/[phone number], where forward slash (/) represents separator of country code and telephone number. Country code may only contain digits.The telephone number may include blank spaces and hyphen (-)

- email
- <= 60 characters
  Email address

- dateOfBirth
- Applicant's date of birth, in the format YYYY-MM-DD. Mandatory if target market is crossborder, otherwise this field is optional.

- identificationAttachment
- Attachment to be uploaded.
  file
  Byte array
  fileName
  <= 250 characters
  File name

- invoiceStatementOnMerchantLevel
- If true, created terminals will be linked to one agreement. If false, each terminal will have its own agreement.
  false

- stores
- Array of objects. Trading As info
  name
  <= 25 characters
  Doing business as (DBA) name Allowed characters: A-Z, a-z, 0-9 '()*.+,-
  merchantCategoryCode
  Four digit merchant category code
  acceptedCardTypes
  Enum: VISA, MasterCard, Amex
  Card types accepted
  address
  Note: applicant and store address country code must be the same!
  street
  <= 50 characters
  Street and name/number of the building. Allowed characters: A-Z, a-z, 0-9 '()*.+,-
  postalCode
  [ 3 .. 10 ] characters
  Postal code for the building. Allowed characters: A-Z, a-z, 0-9 '()*.+,-
  city
  <= 100 characters
  Town or city name. Allowed characters: A-Z, a-z, 0-9 '()*.+,-
  countryCode
  <= 2 characters
  Alpha-2 code for country.
  transactionInformation
  Transaction information for the store.
  expectedAverageTransactionAmount
  Expected value of average transaction in USD rounded to the nearest major value
  expectedMaximumTransactionAmount
  Expected maximum transaction value in USD
  averageTimeBetweenPurchaseAndDeliveryInDays
  Average number of days between purchase and delivery of items/service
  averageMonthlyVolume
  Average monthly transaction value in USD
  acceptedTransactionTypes
  Enum: ECommerce, CardPresent
  Transaction type category is Ecommerce or CardPresent. If Ecommerce is used then the object ECommerceSolutions should be added.
  eCommerceSolutions
  E-commerce solution details. Required when acceptedTransactionTypes includes ECommerce.
  eCommerceType
  Enum: WebPaymentPage, Checkout, ValitorPay
  The type of e-commerce solution used.
  websiteURL
  <= 50 characters
  Your website URL. Mandatory if ECommerceType is set.
  webPaymentPageInformation
  Web payment page configuration details.
  sellerEmail
  <= 50 characters
  Email of the seller
  sellerPhone
  <= 50 characters
  Phone number of the seller
  logoAttachment
  Attachment to be uploaded.
  file
  Byte array
  fileName
  <= 250 characters
  File name
  recurring
  Indicates whether the store accepts recurring payments.
  false
  descriptionOfProductsAndServices
  <= 1000 characters
  Description of products and services
  acceptedPaymentCardsInPast
  Has merchant accepted cards in the past.
  false

- bankAccount
- The merchant's bank account details.
  bankName
  <= 50 characters
  Name of the bank holding the applicant's bank account
  accountNumber
  <= 50 characters
  Bank account number
  bankAddress
  Note: applicant and store address country code must be the same!
  street
  <= 50 characters
  Street and name/number of the building. Allowed characters: A-Z, a-z, 0-9 '()*.+,-
  postalCode
  [ 3 .. 10 ] characters
  Postal code for the building. Allowed characters: A-Z, a-z, 0-9 '()*.+,-
  city
  <= 100 characters
  Town or city name. Allowed characters: A-Z, a-z, 0-9 '()*.+,-
  countryCode
  <= 2 characters
  Alpha-2 code for country.
  iban
  <= 50 characters
  International Bank Account Number. Required if not Icelandic target market.
  ownerNationalIdNumber
  <= 50 characters
  National identification number of the account owner. This is required when target market is Iceland.
  swiftNumber
  <= 50 characters.
  Business Identifier Code. This is required when target market is cross-border.
  sortCode
  <= 20 characters
  Identifies both the bank and the branch where the account is held. Formatted as three pairs of numbers. Example: 12-34-56.
  bankAccountConfirmationAttachment
  Attachment to be uploaded.
  file
  Byte array
  fileName
  <= 250 characters
  File name
  bankAccountConfirmed
  Confirmation that the bank account has been checked

- fees
- The fee structure applied to the merchant.
  merchantServiceChargeFees
  Array of objects. Merchant service charge fees
  name
  <= 100 characters
  Name
  fixedValue
  Fixed value of the fee. 4 decimal place precision.
  percentageValue
  Percentage value of the fee. 4 decimal place precision.

- additionalAttachments
- Array of objects. Additional attachment list.
  file
  Byte array
  fileName
  <= 250 characters
  File name

201 Created Response

- success
- Indicates whether the request was successful.

- statusCode
- The HTTP status code of the response.

- message
- A human-readable message describing the result.

- data
- An object containing the created merchant's details.
  merchantName
  Name of the merchant
  merchantId
  The merchant ID
  stores
  List of stores
  storeName
  Store name
  agreementId
  Agreement ID
  terminalId
  Terminal ID

400 Bad Request Response

- success
- Indicates whether the request was successful.

- statusCode
- The HTTP status code of the response.

- message
- Bad request.

- data
- property
  error message

401 Unauthorized Response

- success
- Indicates whether the request was successful.

- statusCode
- The HTTP status code of the response.

- message
- Api Key was not provided.

- data
- null

404 Not Found Response

- success
- Indicates whether the request was successful.

- statusCode
- The HTTP status code of the response.

- message
- Not Found.

- data
- null

500 Internal Server Error Response

- success
- Indicates whether the request was successful.

- statusCode
- The HTTP status code of the response.

- message
- Unexpected error occured. Please contact support.

- data
- null

/isoapi/soletrader

201 Created

curl -X POST
https://boarding.valitor.com/isoapi/soletrader
-H 'ApiKey: my-ApiKey'
-H 'Content-Type: application/json'
-d '{
  "applicant": {
    "firstName": "Robert",
    "middleName": "Thor",
    "lastName": "Leifsson",
    "ssn": "010101-2340",
    "address": {
      "street": "Oxfordstreet 12",
      "postalCode": "HFJ220",
      "city": "London",
      "countryCode": "is"
    },
    "phone": "+123/4567890",
    "email": "email@email.com",
    "dateOfBirth": "1978-10-07",
    "identificationAttachment": {
      "file": "string",
      "fileName": "string"
    },
    "invoiceStatementOnMerchantLevel": false
  },
  "stores": [
    {
      "name": "My Awesome Store",
      "merchantCategoryCode": 1234,
      "acceptedCardTypes": [
        "VISA"
      ],
      "address": {
        "street": "Oxfordstreet 12",
        "postalCode": "HFJ220",
        "city": "London",
        "countryCode": "is"
      },
      "transactionInformation": {
        "expectedAverageTransactionAmount": 10000,
        "expectedMaximumTransactionAmount": 10000,
        "averageTimeBetweenPurchaseAndDeliveryInDays": 1,
        "averageMonthlyVolume": 1000
      },
      "acceptedTransactionTypes": [
        "ECommerce"
      ],
      "eCommerceSolutions": {
        "eCommerceType": "WebPaymentPage",
        "websiteURL": "www.example.com",
        "webPaymentPageInformation": {
          "sellerEmail": "johndoe@domain.com",
          "sellerPhone": "+123/4567890",
          "logoAttachment": {
            "file": "string",
            "fileName": "string"
          }
        }
      },
      "recurring": false,
      "descriptionOfProductsAndServices": "string",
      "acceptedPaymentCardsInPast": false
    }
  ],
  "bankAccount": {
    "bankName": "Nombre de Banco",
    "accountNumber": "123241234",
    "bankAddress": {
      "street": "Oxfordstreet 12",
      "postalCode": "HFJ220",
      "city": "London",
      "countryCode": "is"
    },
    "iban": "NWBK60161331926819",
    "ownerNationalIdNumber": "2501992323",
    "swiftNumber": "CITIDE55",
    "sortCode": "12-34-56",
    "bankAccountConfirmationAttachment": {
      "file": "string",
      "fileName": "string"
    },
    "bankAccountConfirmed": true
  },
  "fees": {
    "merchantServiceChargeFees": [
      {
        "name": "VisaCredit",
        "fixedValue": 0.1,
        "percentageValue": 0.1
      }
    ]
  },
  "additionalAttachments": [
    {
      "file": "string",
      "fileName": "string"
    }
  ]
}
'

{
  "success": true,
  "statusCode": 201,
  "message": "Created",
  "data": {
    "merchantName": "House of goods",
    "merchantId": 1000,
    "stores": [
      {
        "storeName": "Store name",
        "agreementId": 1,
        "terminalId": 1
      }
    ]
  }
}

400 Bad Request

curl -X POST
https://boarding.valitor.com/isoapi/soletrader
-H 'ApiKey: my-ApiKey'
-H 'Content-Type: application/json'
-d '{
  "applicant": {
    "firstName": "Robert",
    "middleName": "Thor",
    "lastName": "Leifsson",
    "ssn": "010101-2340",
    "address": {
      "street": "Oxfordstreet 12",
      "postalCode": "HFJ220",
      "city": "London",
      "countryCode": "is"
    },
    "phone": "+123/4567890",
    "email": "email@email.com",
    "dateOfBirth": "1978-10-07",
    "identificationAttachment": {
      "file": "string",
      "fileName": "string"
    },
    "invoiceStatementOnMerchantLevel": false
  },
  "stores": [
    {
      "name": "My Awesome Store",
      "merchantCategoryCode": 1234,
      "acceptedCardTypes": [
        "VISA"
      ],
      "address": {
        "street": "Oxfordstreet 12",
        "postalCode": "HFJ220",
        "city": "London",
        "countryCode": "is"
      },
      "transactionInformation": {
        "expectedAverageTransactionAmount": 10000,
        "expectedMaximumTransactionAmount": 10000,
        "averageTimeBetweenPurchaseAndDeliveryInDays": 1,
        "averageMonthlyVolume": 1000
      },
      "acceptedTransactionTypes": [
        "ECommerce"
      ],
      "eCommerceSolutions": {
        "eCommerceType": "WebPaymentPage",
        "websiteURL": "www.example.com",
        "webPaymentPageInformation": {
          "sellerEmail": "johndoe@domain.com",
          "sellerPhone": "+123/4567890",
          "logoAttachment": {
            "file": "string",
            "fileName": "string"
          }
        }
      },
      "recurring": false,
      "descriptionOfProductsAndServices": "string",
      "acceptedPaymentCardsInPast": false
    }
  ],
  "bankAccount": {
    "bankName": "Nombre de Banco",
    "accountNumber": "123241234",
    "bankAddress": {
      "street": "Oxfordstreet 12",
      "postalCode": "HFJ220",
      "city": "London",
      "countryCode": "is"
    },
    "iban": "NWBK60161331926819",
    "ownerNationalIdNumber": "2501992323",
    "swiftNumber": "CITIDE55",
    "sortCode": "12-34-56",
    "bankAccountConfirmationAttachment": {
      "file": "string",
      "fileName": "string"
    },
    "bankAccountConfirmed": true
  },
  "fees": {
    "merchantServiceChargeFees": [
      {
        "name": "VisaCredit",
        "fixedValue": 0.1,
        "percentageValue": 0.1
      }
    ]
  },
  "additionalAttachments": [
    {
      "file": "string",
      "fileName": "string"
    }
  ]
}
'

{
  "success": false,
  "statusCode": 400,
  "message": "Bad request",
  "data": {
    "property": "error message"
  }
}

401 Unauthorized

curl -X POST
https://boarding.valitor.com/isoapi/soletrader
-H 'ApiKey: my-ApiKey'
-H 'Content-Type: application/json'
-d '{
  "applicant": {
    "firstName": "Robert",
    "middleName": "Thor",
    "lastName": "Leifsson",
    "ssn": "010101-2340",
    "address": {
      "street": "Oxfordstreet 12",
      "postalCode": "HFJ220",
      "city": "London",
      "countryCode": "is"
    },
    "phone": "+123/4567890",
    "email": "email@email.com",
    "dateOfBirth": "1978-10-07",
    "identificationAttachment": {
      "file": "string",
      "fileName": "string"
    },
    "invoiceStatementOnMerchantLevel": false
  },
  "stores": [
    {
      "name": "My Awesome Store",
      "merchantCategoryCode": 1234,
      "acceptedCardTypes": [
        "VISA"
      ],
      "address": {
        "street": "Oxfordstreet 12",
        "postalCode": "HFJ220",
        "city": "London",
        "countryCode": "is"
      },
      "transactionInformation": {
        "expectedAverageTransactionAmount": 10000,
        "expectedMaximumTransactionAmount": 10000,
        "averageTimeBetweenPurchaseAndDeliveryInDays": 1,
        "averageMonthlyVolume": 1000
      },
      "acceptedTransactionTypes": [
        "ECommerce"
      ],
      "eCommerceSolutions": {
        "eCommerceType": "WebPaymentPage",
        "websiteURL": "www.example.com",
        "webPaymentPageInformation": {
          "sellerEmail": "johndoe@domain.com",
          "sellerPhone": "+123/4567890",
          "logoAttachment": {
            "file": "string",
            "fileName": "string"
          }
        }
      },
      "recurring": false,
      "descriptionOfProductsAndServices": "string",
      "acceptedPaymentCardsInPast": false
    }
  ],
  "bankAccount": {
    "bankName": "Nombre de Banco",
    "accountNumber": "123241234",
    "bankAddress": {
      "street": "Oxfordstreet 12",
      "postalCode": "HFJ220",
      "city": "London",
      "countryCode": "is"
    },
    "iban": "NWBK60161331926819",
    "ownerNationalIdNumber": "2501992323",
    "swiftNumber": "CITIDE55",
    "sortCode": "12-34-56",
    "bankAccountConfirmationAttachment": {
      "file": "string",
      "fileName": "string"
    },
    "bankAccountConfirmed": true
  },
  "fees": {
    "merchantServiceChargeFees": [
      {
        "name": "VisaCredit",
        "fixedValue": 0.1,
        "percentageValue": 0.1
      }
    ]
  },
  "additionalAttachments": [
    {
      "file": "string",
      "fileName": "string"
    }
  ]
}
'

{
  "success": false,
  "statusCode": 401,
  "message": "Api Key was not provided",
  "data": null
}

404 Not Found

curl -X POST
https://boarding.valitor.com/isoapi/soletrader
-H 'ApiKey: my-ApiKey'
-H 'Content-Type: application/json'
-d '{
  "applicant": {
    "firstName": "Robert",
    "middleName": "Thor",
    "lastName": "Leifsson",
    "ssn": "010101-2340",
    "address": {
      "street": "Oxfordstreet 12",
      "postalCode": "HFJ220",
      "city": "London",
      "countryCode": "is"
    },
    "phone": "+123/4567890",
    "email": "email@email.com",
    "dateOfBirth": "1978-10-07",
    "identificationAttachment": {
      "file": "string",
      "fileName": "string"
    },
    "invoiceStatementOnMerchantLevel": false
  },
  "stores": [
    {
      "name": "My Awesome Store",
      "merchantCategoryCode": 1234,
      "acceptedCardTypes": [
        "VISA"
      ],
      "address": {
        "street": "Oxfordstreet 12",
        "postalCode": "HFJ220",
        "city": "London",
        "countryCode": "is"
      },
      "transactionInformation": {
        "expectedAverageTransactionAmount": 10000,
        "expectedMaximumTransactionAmount": 10000,
        "averageTimeBetweenPurchaseAndDeliveryInDays": 1,
        "averageMonthlyVolume": 1000
      },
      "acceptedTransactionTypes": [
        "ECommerce"
      ],
      "eCommerceSolutions": {
        "eCommerceType": "WebPaymentPage",
        "websiteURL": "www.example.com",
        "webPaymentPageInformation": {
          "sellerEmail": "johndoe@domain.com",
          "sellerPhone": "+123/4567890",
          "logoAttachment": {
            "file": "string",
            "fileName": "string"
          }
        }
      },
      "recurring": false,
      "descriptionOfProductsAndServices": "string",
      "acceptedPaymentCardsInPast": false
    }
  ],
  "bankAccount": {
    "bankName": "Nombre de Banco",
    "accountNumber": "123241234",
    "bankAddress": {
      "street": "Oxfordstreet 12",
      "postalCode": "HFJ220",
      "city": "London",
      "countryCode": "is"
    },
    "iban": "NWBK60161331926819",
    "ownerNationalIdNumber": "2501992323",
    "swiftNumber": "CITIDE55",
    "sortCode": "12-34-56",
    "bankAccountConfirmationAttachment": {
      "file": "string",
      "fileName": "string"
    },
    "bankAccountConfirmed": true
  },
  "fees": {
    "merchantServiceChargeFees": [
      {
        "name": "VisaCredit",
        "fixedValue": 0.1,
        "percentageValue": 0.1
      }
    ]
  },
  "additionalAttachments": [
    {
      "file": "string",
      "fileName": "string"
    }
  ]
}
'

{
  "success": false,
  "statusCode": 404,
  "message": "Not Found",
  "data": null
}

500 Internal Server Error

curl -X POST
https://boarding.valitor.com/isoapi/soletrader
-H 'ApiKey: my-ApiKey'
-H 'Content-Type: application/json'
-d '{
  "applicant": {
    "firstName": "Robert",
    "middleName": "Thor",
    "lastName": "Leifsson",
    "ssn": "010101-2340",
    "address": {
      "street": "Oxfordstreet 12",
      "postalCode": "HFJ220",
      "city": "London",
      "countryCode": "is"
    },
    "phone": "+123/4567890",
    "email": "email@email.com",
    "dateOfBirth": "1978-10-07",
    "identificationAttachment": {
      "file": "string",
      "fileName": "string"
    },
    "invoiceStatementOnMerchantLevel": false
  },
  "stores": [
    {
      "name": "My Awesome Store",
      "merchantCategoryCode": 1234,
      "acceptedCardTypes": [
        "VISA"
      ],
      "address": {
        "street": "Oxfordstreet 12",
        "postalCode": "HFJ220",
        "city": "London",
        "countryCode": "is"
      },
      "transactionInformation": {
        "expectedAverageTransactionAmount": 10000,
        "expectedMaximumTransactionAmount": 10000,
        "averageTimeBetweenPurchaseAndDeliveryInDays": 1,
        "averageMonthlyVolume": 1000
      },
      "acceptedTransactionTypes": [
        "ECommerce"
      ],
      "eCommerceSolutions": {
        "eCommerceType": "WebPaymentPage",
        "websiteURL": "www.example.com",
        "webPaymentPageInformation": {
          "sellerEmail": "johndoe@domain.com",
          "sellerPhone": "+123/4567890",
          "logoAttachment": {
            "file": "string",
            "fileName": "string"
          }
        }
      },
      "recurring": false,
      "descriptionOfProductsAndServices": "string",
      "acceptedPaymentCardsInPast": false
    }
  ],
  "bankAccount": {
    "bankName": "Nombre de Banco",
    "accountNumber": "123241234",
    "bankAddress": {
      "street": "Oxfordstreet 12",
      "postalCode": "HFJ220",
      "city": "London",
      "countryCode": "is"
    },
    "iban": "NWBK60161331926819",
    "ownerNationalIdNumber": "2501992323",
    "swiftNumber": "CITIDE55",
    "sortCode": "12-34-56",
    "bankAccountConfirmationAttachment": {
      "file": "string",
      "fileName": "string"
    },
    "bankAccountConfirmed": true
  },
  "fees": {
    "merchantServiceChargeFees": [
      {
        "name": "VisaCredit",
        "fixedValue": 0.1,
        "percentageValue": 0.1
      }
    ]
  },
  "additionalAttachments": [
    {
      "file": "string",
      "fileName": "string"
    }
  ]
}
'

{
  "success": false,
  "statusCode": 500,
  "message": "Unexpected error occured. Please contact support.",
  "data": null
}

En esta sección:

Documentación