Skip to content

Onboarding API

In order to streamline the onboarding process for sponsored merchants on your platform, you can create a tailored user interface (UI) to collect merchants’ data and subsequently submits it to our API.

Within this guide, you will find an explanation of the entire process of onboarding a sponsored merchant.

Please check below the available environment endpoints:

Environment

URL

Operation Method & Endpoint

Operation Description

PROD

api.sibsgateway.com

POST  api/onboarding/version-id/ sponsored-merchant

Performs a request to create the sponsored merchant record

CER

stargate-cer.qly.site1.sibs.pt

POST api/onboarding/version-id/ sponsored-merchant

Performs a request to create the sponsored merchant record

Sandbox

sandbox.sibsgateway.com

POST api/onboarding/version-id/ sponsored-merchant

Performs a request to create  the sponsored merchant record

Before you start

Ensure that during the onboarding process your Account Manager shared with you the necessary credentials:

  • Client ID
  • Client Secret

Once you have these, you will be able to initiate the onboarding process via the API.

msg_warn

Keep your credentials confidential to maintain security of your transactions.

Onboard Sponsored Merchants

The API-based onboarding process eliminates the need for manual onboarding by automatically generating sponsored merchants, their establishments, pricelists, terminals, and their corresponding credentials.

To initiate this process, you are required to perform a POST request with the following data:

Here is an example of a successful onboarding response:

"transactionStatus": "ACT",
    "returnStatus": {
      "statusCode": "000" 
      "statusMsg": "Success",
      "statusDescription": "string"
    }
  }
  
msg_info

KYC

Note that your sponsored merchants will be subject to thorough onboarding evaluations, encompassing KYC verifications, unless specific agreements have been made during your own onboarding.

If they are not required to undergo KYC at this stage, the onboarding process via API will proceed without any interruptions, and the Sponsored Merchants will be generated.

If the sponsored merchants are required to undergo KYC diligences, we will conduct asynchronous diligences and provide you with the results via webhook.

Error Handling

If a rejection occurs on the onboarding process, a synchronous response will be received that include a transactionstatus with the value RJCT (rejected) and a 999 StatusCode.

This response will contain error code and message fields that can assist you in identifying and resolving the issue.

Rejected onboarding response example:

 "transactionStatus": "RJCT",
   "returnStatus": {
      "statusCode": "999",
      "statusMsg": "Internal Server Error",
      "statusDescription": "When invoiceIndicator is Sponsored Merchant invoiceEmail and payout object are mandatory."
    }
  }
  

Below you can find the range of Status Codes and Messages with additional asynchronous messages that you can receive via webhooks as well:

Status Code

Message

Processing Mode

000

Success

Syncronous

001

Sponsored Merchant already exists.

Asyncronous

002

PKD is invalid

Asyncronous

003

MCC code is invalid

Asyncronous

004

NIP is invalid

Asyncronous

005

IBAN is invalid

Asyncronous

006

Product list doesn’t comply with Payment Facilitator agreement

Asyncronous

007

Product code {} is invalid

Asyncronous

008

Payment Facilitator is invalid

Asyncronous

009

Product {} is not compatible with product {}

Asyncronous

010

Invoice indicator is invalid for this Sponsored Merchant

Asyncronous

011

This Product of Establishment has already been added as an Establishment Product.

Asyncronous

012

Required field {} missing

Asyncronous

013

The Country of the Establishment doesn’t match the Company Country

Asyncronous

014

Sponsored Merchant Country does not match the Payment Facilitator Country

Asyncronous

999

Unexpected Error

Syncronous/Asyncronous