Skip to main content

Create a Merchant [POST]

Requirements​

ℹ️ Before creating a Merchant, you need to validate the credential is working, you can test it for example in Staging, with the endpoint: https://staging.sylq.io/api/test, here is an example of a curl request:

curl "https://staging.sylq.io/api/test" \
     -H 'Authorization: Bearer YOUR_API_TOKEN'

Create a Merchant​

Create a new add merchant request by sending simply the merchant_name (Required), merchant_address_1, businessCity, merchant_city (Required), merchant_country_code (ISO-3166)(Required), merchant_zip_code (Required), individual_name (Required), individual_mobile_number (Required), individual_mobile_number_country_code (Required), individualEmail (Required), iban (Required), settlement_frequency (Optional) and vat_number (Optional).

The “type” is to determine the model of relationship with Sylq, contact with us when you desire to have activated the “direct model” (without KYB, only for Partners).

Endpoints​

Staging environment

  • Staging URL: https://staging.sylq.io/api/v1/merchants

Production/Live environment

  • Production/Live URL: https://app.sylq.io/api/v1/merchants

Schema​

{
  "iban": "string",
  "individual_email": "user@example.com",
  "individual_locale": "en",
  "individual_mobile_number": "string",
  "individual_mobile_number_country_code": "string",
  "individual_name": "string",
  "merchant_address_1": "string",
  "merchant_address_2": "string",
  "merchant_city": "string",
  "merchant_country_code": "string",
  "merchant_name": "string",
  "merchant_zip_code": "string",
  "settlement_frequency": "daily",
  "vat_number": "string"
}

Examples of returns​

Success response (201)​

{
  "id": 1,
  "name": "Leffler-Aufderhar",
  "reference": "LEFFLERA",
  "created_at": "2022-12-01T12:40:27Z"
}

🎉 Congratulations!!! Now, you can create payments and associate them with your new Merchant (merchant_id).

Error response (422)​

{
  "errors": {
    "iban": [
      "is required"
    ],
    "individual_email": [
      "is required"
    ],
    "individual_mobile_number": [
      "is required"
    ],
    "individual_mobile_number_country_code": [
      "is required"
    ],
    "individual_name": [
      "is required"
    ],
    "merchant_address_1": [
      "is required"
    ],
    "merchant_city": [
      "is required"
    ],
    "merchant_country_code": [
      "is required"
    ],
    "merchant_name": [
      "is required"
    ],
    "merchant_zip_code": [
      "is required"
    ],
    "settlement_frequency": [
      "is required"
    ],
    "vat_number": [
      "is required"
    ]
  }
}

Retrieves a Merchant [GET]​

Endpoints​

Staging environment

  • Staging URL: https://staging.sylq.io/api/v1/merchants/{id}

Production/Live environment

  • Production/Live URL: https://app.sylq.io/api/v1/merchants/{id}

Examples of returns​

Success response (201)​

https://staging.sylq.io/api/v1/merchants/1

{
  "id": 1,
  "name": "Jerde, Schimmel and Anderson",
  "reference": "JERDESCH",
  "created_at": "2022-12-01T12:40:29Z"
}

Error response (422)​

{
  "errors": "Not found"
}