UK Merchant Countries

To use the Create Merchant API request below, merchants must be based out of one of the following countries:

  • England
  • Northern Ireland
  • Scotland
  • Wales

Create the merchant account

When you have collected all your merchant information, use the Create Merchant API request to send to BlueSnap for review.

Create Merchant API Request

https://platform.bluesnap.com/services/2/merchants/application

Create Merchant API Parameters for UK Customers

Parameter Required Details
pfToken
No. Include if using Secure Customer Data Fields Secure Customer Data Fields token.
approvalTesting
No If you include this parameter, you are testing the customer-onboarding workflow; the customer account is NOT created but you will receive an IPN and an email as you would in an actual onboarding.
Refer to the testing section for details on how to use this parameter.
Type: string

Valid values:
  • APPROVED
  • RECOMMEND_APPROVE
  • RECOMMEND_DECLINE
  • DECLINE
defaultIPN
No Only use if you want to set up a different notification endpoint for each of your merchants. The endpoint URL you define with this parameter will receive transactional IPNs (Webhooks). The IPNs (Webhooks) you receive for your merchants will be determined during your account setup. Learn more.
businessName Yes Customer-facing name of the business
Type: string
Limits:
  • Maximum 60 characters
  • ASCII characters only, with special characters ",()./-"
legalName Yes Legal name of the business
Type: string
Limits:
  • Maximum 60 characters
  • ASCII characters only, with special characters ",()./-"
productAndServiceDesc Yes Provides a detailed description of the business including information about customers and the merchant's products, services, or both
Type: string
Limit: Maximum 1500 characters
phone Yes Company phone number
Type: string
  • Limit: Maximum 11 digits with no spaces, dashes, or any other characters
  • website Yes Main website for the merchant's business
    Type: string
    Limits:
    • Maximum 100 characters
    • At least 1 "." required
    • No "+" character allowed
    • Must have "@" char in string
    businessType Yes Type of business
    Valid values:
    • Limited Liability
    • Non-profit
    • Partnership
    • Private Corporation
    • Public Corporation
    • Sole Proprietorship
    businessCategory Yes

    Category of the business.

    Valid values:

    • Business Services
    • Educational Services
    • Charities/Donations
    • Miscellaneous Personal Services
    • Pharmacy
    • Miscellaneous Specialty Retail
    • Software
    • Travel Agencies & Tour Operators
    • Other

    taxId (VAT) Yes Merchant's tax ID number
    Do NOT include the 2-character country code in this field.
    Type: alphanumeric
    15 characters
    address Yes Merchant's business address. Must be a registered business address.
    Type: string
    Limit: Maximum 60 characters
    city Yes Merchant's business address city
    Type: string
    Limit: Maximum 60 characters
    zip Yes Merchant's business address zip/postal code
    Type: string
    Limits: Maximum 8 characters, spaces allowed
    country Yes Merchant's business address country
    Type: string
    Limit: 2-letter code
    Limit: GB (This should be used for all of Great Britain, including Wales, Northern Ireland & Scotland).
    email Yes The business email address provided by your merchant.
    Type: string
    Limits:
    • Minimum 7 characters
    • Maximum 100 characters
    • At least 1 "." required
    • No "+" character allowed
    • Must have "@" char in string

    Note: Once the application is approved, an access URL for your merchant's Chargeback Disputes Portal will be sent to this email address.

    salesVolume Yes Merchant's current annual sales volume (Must be in USD)
    Type: numeric
    Limit: Value must be greater than zero
    businessRegistrationNumber Yes The business's registration number
    Type: alphanumeric
    Limit: Maximum 8 characters
    minimalPayoutAmount Yes The minimum amount at which the customer will be paid. Until this value is reached, funds continue to accumulate.
    Type: string
    Limit:
    • This must be specified in the currency selected in payoutCurrency.
    • Minimum value is the equivalent of $35 USD.
    refundReserve Yes The amount of funds kept in the account to cover refunds.
    Type: string
    Limits:
    • This must be specified in the currency selected in payoutCurrency.
    • Minimum value is the equivalent of $100 USD
    sortOrder Yes Bank Identification Code (also known as a Sort Code, National Sort Code [NSC], SWIFT code)
    Type: string
    Limits:
    • Must be 6 characters
    • Numbers only
    accountNumber Yes Bank account number.
    Type: string
    Limits:
    • Must be 8 characters
    • Numbers only
    paymentReference No Reference text that appears on the customer's bank statement when they are paid out.
    Type: string
    Limit: Maximum 100 alphanumeric characters
    payoutMethod No

    Method or entity that facilitated the payout. When you omit this parameter, CHAPS is used as the payout method.

    If you send a request with both payoutMethod and paymentReference, paymentReference is ignored.

    Type: string
    Limit: Accepts only Fastbank as a value.

    Note: When Fastbank is the payout method, BlueSnap might be listed as the payment reference on the bank statement when your merchant is paid out.

    ownerFirstName Yes Business owner's first name
    Type: string
    Limits:
    • US: Maximum 40 characters
    • Other: Maximum 60 characters
    ownerLastName Yes Business owner's last name
    Type: string
    Limits:
    • US: Maximum 40 characters
    • Other: Maximum 60 characters
    ownerDateOfBirth Yes The business owner's date of birth.
    Type: numeric with "/"
    Limits:
    • Must be in the format of MM/DD/YYYY
    • Maximum 10 characters
    ownerGovID Yes Business owner's government ID number
    Type: numeric
    Limits:
    • No special characters
    • US: Last 4 digits of SSN, numbers only
    • Other: Maximum 50 characters
    ownerPhone Yes Business owner's personal phone number
    Type: string
    Limits:
    • No spaces, dashes, or any other characters
    • US/CA: 10 digits required
    • UK: Maximum 11 digits
    • Other: Maximum 15 digits
    address Yes Business owner's home street address
    Type: string
    Limits:
    • US: Maximum 40 characters
    • Other: Maximum 60 characters
    city Yes Business owner's home address city
    Type: string
    Limits:
    • US: Maximum 25 characters
    • Other: Maximum 60 characters
    state Only if companyRepCountry is US or CA Business owner's home address state/province/county/region
    Type: string
    Limit: 2-letter code. (For US or CA, refer to State and Province Codes.)
    zip Yes Business owner's home address zip/postal code
    Type: string
    Limits:
    • US: Must be 5 or 9 digits
    • CA: Maximum 7 characters, only 1 space allowed
    • AU: Maximum 4 characters
    • UK: Maximum 8 characters, spaces allowed
    • EU/ROW: Maximum 15 characters, spaces allowed
    country Yes Business owner's home address country
    Type: string
    Limit: 2-letter code
    For Great Britain, Wales, or Scotland, use GB. For all other countries, refer to Country Codes.
    companyRepFirstName Yes Company representative's first name
    Type: string
    Limit:
    • US: Maximum 40
    • Other: Maximum 60
    companyRepLastName Yes Company representative's last name
    Type: string
    Limit:
    • US: Maximum 40
    • Other: Maximum 60
    companyRepDateOfBirth Yes Company representative's date of birth.
    Type: numeric with "/"
    Limits:
    • Must be in the format of MM/DD/YYYY
    • Maximum 10 characters
    companyRepGovID Yes Company representative's government ID number
    Type: numeric
    Limits:
    • No special characters
    • US: Last 4 digits of SSN, numbers only
    • Other: Maximum 50 characters
    companyRepPhone Yes Company representative's personal phone number
    Type: number
    Limit:
    • No spaces, dashes, or any other characters
    • US/CA: 10 digits required
    • UK: Maximum 11 digits
    • Other: Maximum 15 digits
    companyRepAddress Yes Company representative's home street address
    Type: string
    Limit:
    • US: Maximum 40
    • Other: Maximum 60
    companyRepCity Yes Company representative's home address city
    Type: string
    Limit:
    • US: Maximum 25
    • Other: Maximum 60
    companyRepState Only if companyRepCountry is US or CA Company representative's home address state/province/county/region
    Type: string
    Limit: 2-letter code. (For US and CA, refer to State and Province Codes.)
    companyRepZip Yes Company representative's home address zip or postal code
    Type: string
    Limits:
    • US: Must be 5 or 9 digits
    • CA: Maximum 7 characters, only 1 space allowed
    • AU: Maximum 4 characters
    • UK: Maximum 8 characters, spaces allowed
    • EU/ROW: Maximum 15 characters, spaces allowed
    companyRepCountry Yes Company representative's home address country
    Type: string
    Limit: 2-letter code
    For Great Britain, Wales, or Scotland, use GB. For all other countries, refer to Country Codes.
    serviceAgreementDate Yes

    Date the merchant signed the merchant service agreement.

    You must present the merchant with a link to the BlueSnap Merchant Agreement (available here) and the merchant must sign it before they begin using BlueSnap.

    Type: string
    Must be in the format MM/DD/YYYY

    pricingAgreementDate Yes

    Date the merchant signed the pricing agreement.

    You must present the merchant with a link to the BlueSnap Pricing Agreement and the merchant must sign it before they begin using BlueSnap.

    Type: string
    Must be in the format MM/DD/YYYY

    merchantIp Yes Merchant's IP address
    Type: string
    Limit: Maximum 45 characters
    Format: IPv4 xxx.xxx.xxx.xxx
    IPv6 xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx

    Create Merchant API Request examples

    Here are some examples.
    Note: Before using Test mode, review the Customer Onboarding steps.

    curl -v -X POST https://platform.bluesnap.com/services/2/merchants/application \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \ 
    -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
    -d '
    {
        "approvalTesting": "APPROVED",
        "businessInfo": {
            "businessName": "Doing Business As Name GB",
            "legalName": "Legal Business Name GB",
            "productAndServiceDesc": "Products",
            "phone": "12757781072",
            "website": https://www.website.com,
            "businessType": "Public Corporation ",
            "businessCategory": "Software",
            "taxId": "876876876",
            "address": "555 Ken Rd",
            "city": "Clevedon",
            "zip": "BS21 6TH",
            "country": "GB",
            "email": [email protected],
            "salesVolume": "100000",
            "businessRegistrationNumber": "BR123456"
        },
        "bankingInfo": {
            "minimalPayoutAmount": "100",
            "refundReserve": "100",
            "accountNumber": "16623256",
            "sortOrder": "987967"
        },
        "ownershipInfoArr": [
            {
                "ownerFirstName": "Bertrand",
                "ownerLastName": "Russell",
                "ownerDateOfBirth": "01/06/1962",
                "ownerGovID": "654654-6545",
                "ownerPhone": "12757781072",
                "address": "1234 Oxford Street",
                "city": "Clevedon",
                "zip": "BS21 6TH",
                "country": "GB"
            },
            {
                "ownerFirstName": "Ludwig",
                "ownerLastName": "Wittgenstein",
                "ownerDateOfBirth": "03/11/1971",
                "ownerGovID": "654654-6545",
                "ownerPhone": "12757781072",
                "address": "1234 Livingston Street",
                "city": "Clevedon",
                "zip": "BS21 6TH",
                "country": "GB"
            }
        ],
        "companyRep": {
            "companyRepFirstName": "Mary",
            "companyRepLastName": "Wollstonecraft",
            "companyRepDateOfBirth": "12/13/1967",
            "companyRepGovID": "98798798798",
            "companyRepAddress": "123 Landon Street",
            "companyRepCity": "Clevedon",
            "companyRepZip": "BS21 6TH",
            "companyRepCountry": "GB",
            "companyRepPhone": "12757981072"
        },
        "merchantAgreementsSign": {
            "serviceAgreementDate": "01/01/2023",
            "pricingAgreementDate": "01/01/2023",
            "merchantIp": "192.168.20.15"
        }
    }
    '
    
    curl -v -X POST https://platform.bluesnap.com/services/2/merchants/application \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \ 
    -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
    -d '
    {
      "approvalTesting": "APPROVED",
      "pfToken": "5ad59e4389abba704ee2d61580d1d5cc1ba0ccf114470d404f771a198d99891b_"
    }'
    

    Response

    If your request is successful, you receive a 200 OK response from BlueSnap. When our automated review is complete, you receive an IPN explaining the status of your merchant approval process.

    { 
    "sandboxId": 1682291, 
    "message": "success" 
    }