Retrieve Application API

📘

Note

This endpoint only returns the data that was submitted during the initial application. If there were changes made to the merchant application after the initial submission, the updated data is not returned from this endpoint.

Retrieves merchant application data submitted in the initial application. Common use cases include the following:

  • A merchant submitted inaccurate data, and you need to confirm which data the customer needs to resubmit.
  • You used Secure Customer Data Fields to collect merchant data, so you did not store the data on your servers. You can retrieve the submitted application data with this endpoint.

Endpoint

https://platform.bluesnap.com/services/2/merchants/{sandboxId}

Request Content

Path Parameters

ParameterRequiredDescription
{sandboxId}requiredUnique identifier for the merchant's test account. This is the value sent in the sandbox_id parameter in the APPLICATION_DOCUMENT_REQUEST IPN.

Response

PropertyTypeDescription
sandboxIdstringValue sent as {sandboxId} path parameter in the request.
businessInfoobjectDetails about the business, such as legal name, location, and product offerings.
Refer to New Application API for the applicable country or region.
bankingInfoobjectMerchant bank account and refund details.
Refer to New Application API for the applicable country or region.
ownershipInfoArrarrayPersonal information about the business owner.
Refer to New Application API for the applicable country or region.
companyRepobjectPersonal information about a person that oversees the business, such as the CEO.
Refer to New Application API for the applicable country or region.
merchantAgreementSignobjectIP and timing details about merchant agreements.
Refer to New Application API for the applicable country or region.
onBehalfOfConsoleAccessstringAn internal reference attribute used for webhook workflows that can be safely ignored.

Examples

Requests

curl -v -X GET https://platform.bluesnap.com/services/2/merchants/1107131 \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json' \ 
     -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Responses

{
    "sandboxId": 1107131,
    "businessInfo": {
        "businessName": "My Business",
        "legalName": "My Business",
        "productAndServiceDesc": "Description of products and/or services",
        "phone": "5555555555",
        "website": "https://www.website.com",
        "businessType": "CORP_PUBLICLY_TRADED",
        "businessCategory": "SOFTWARE",
        "taxId": "770770770",
        "address": "1234 Main Street",
        "city": "City",
        "state": "FL",
        "zip": "12345",
        "country": "us",
        "email": "[email protected]",
        "salesVolume": "100000"
    },
    "bankingInfo": {
        "routingNumber": "123456789",
        "accountNumber": "123456",
        "bankState": "FL",
        "accountType": "CHECKING",
        "swiftOrBICCode": "123456789",
        "accountNumberOrIBAN": "123456",
        "payoutCurrency": "USD",
        "minimalPayoutAmount": "100",
        "refundReserve": "100"
    },
    "ownershipInfoArr": [
        {
            "ownerFirstName": "Chris",
            "ownerLastName": "Jones",
            "ownerDateOfBirth": "01/01/2000",
            "ownerGovID": "1111",
            "ownerPhone": "5551234567",
            "address": "1234 Main Street",
            "city": "Waltham",
            "state": "FL",
            "zip": "02453",
            "country": "us"
        },
        {
            "ownerFirstName": "Jamie",
            "ownerLastName": "Doe",
            "ownerDateOfBirth": "02/01/2000",
            "ownerGovID": "2222",
            "ownerPhone": "5551234567",
            "address": "200 Broadway",
            "city": "Happy",
            "state": "FL",
            "zip": "12345",
            "country": "us"
        }
    ],
    "companyRep": {
        "companyRepFirstName": "Jesse",
        "companyRepLastName": "Smith",
        "companyRepDateOfBirth": "12/13/1967",
        "companyRepGovID": "1234",
        "companyRepAddress": "123 South Street",
        "companyRepCity": "Happy",
        "companyRepState": "FL",
        "companyRepZip": "12345",
        "companyRepCountry": "us",
        "companyRepPhone": "9555123456"
    },
    "merchantAgreementsSign": {
        "serviceAgreementDate": "01/01/2019",
        "pricingAgreementDate": "01/01/2019",
        "merchantIp": "192.168.20.15"
    },
    "onBehalfOfConsoleAccess": "N"
}