Add Submerchant
Allows the Marketplace Operator to add a new Submerchant.
Access via SIBS API Market:
POST /sibs/v1/submerchant This feature requires sending parameters at the Request Level that have the following characteristics:
| Parameter | Meaning | Accepted values and their meaning | Format | Minimum length | Maximum length | Type |
|---|---|---|---|---|---|---|
| “submerchant” | ||||||
| “taxIdentificationNumber” | Taxpayer Identification Number or Legal Person Fiscal Number | – | String | 1 | 20 | Mnafatory |
| “name” | Nmae | – | String | 1 | 40 | Mandatory |
| “shortName” | Short Name; | – | String | 1 | 20 | Mandatory |
| “sic” | SIC – Standard Industrial Classification Code – (CAE: Classificação das Atividades Económicas) | – | Decimal | 1 | 5 | Mandatory |
| “socialObject” | Business Activity | – | String | 1 | 150 | Optional |
| “Settlement TypeCode” | Clearing type | “SPA” – Single Euro Payments Area | String | 3 | 3 | Mandatory |
| “refundMaxAmoun” | Daily maximum amount for Refunds | – | Decimal | 1 | 14.5 | Optional |
| “payoutTypeCode” | Payout type | “MAN” – Manual Payout “AUT” – Automatic Payout “SCH” – Scheduled | Char | 3 | 3 | Mandatory |
| “deferredAgreementDays” | Number of days after which the payout should be made | – | Number | 3 | 3 | Mandatory |
| “financial” | ||||||
| “IBAN” | International Bank Account Number | – | String | 3 | 34 | Mandatory |
| “BIC” | Bank International Code | – | String | 1 | 11 | Mandatory |
| “address” | ||||||
| “street” | Address | – | String | 1 | 40 | Optional |
| “postalCode” | Postal Code | – | String | 1 | 25 | Optional |
| “locality” | City | – | String | 1 | 20 | Optional |
| “postalLocality” | Postal Code locality | – | String | 1 | 10 | Optional |
| “country” | Country | Country ISO-3166 Numeric 3 | Numeric | 3 | 3 | Mandatory |
| “contact” | ||||||
| “email” | – | String | 1 | 55 | Optional | |
| “telephone” | Phone Number | – | String | 1 | 16 | Optional |
| “mobilePhone” | Mobile Phone Number | – | String | 1 | 16 | Optional |
Add Submerchant Agreement
Allows the Marketplace Operator to add or change an agreement per each Submerchant.
Access via SIBS API Market:
POST /sibs/v1/submerchant/{submerchant-id}/commission This feature requires sending parameters at the Request level that have the following characteristics:
| Parameter | Meaning | Accepted values and their meaning | Format | Minimum length | Maximum length | Type |
|---|---|---|---|---|---|---|
| “submerchant-code” | Submerchant Code | – | Numeric | 8 | 8 | Mandatory |
| “comission” | ||||||
| “feeFixedValue” | Fixed value | – | Decimal | 1 | 7.3 | Mandatory |
| “feePercentage” | Variable value | – | Decimal | 1 | 8.3 | Mandatory |
| “splitFeeMinAmount” | Minimum “Cap” | – | Decimal | 1 | 10.4 | Mandatory |
| “splitFeeMaxAmount” | Maximum “Cap” | – | Decimal | 1 | 10.4 | Mandatory |
Change Submerchant
Allows the Marketplace Operator to change the characteristics of the Submerchant.
Access via SIBS API Market:
PUT /sibs/v1/submerchant/{submerchant-id} 
This action implies the updating of all the information sent in the interface of this feature. In this sense, it is recommended to use the “Inquire Submerchant” feature beforehand, to avoid deleting relevant information.
The Submerchant TIN cannot be changed, as this requires the creation of a new player in the system. Thus, the User performing the change must take into consideration the coherence between the player’s TIN and country.
This feature requires sending parameters at the Request level that have the following characteristics:
| Parameter | Meaning | Accepted values and their meaning | Format | Minimum length | Maximum length | Type |
|---|---|---|---|---|---|---|
| “submerchant-code”9 | Submerchant Code | – | Numeric | 8 | 8 | Mandatory |
| “submerchant” | ||||||
| “taxIdentificationNumber” | Taxpayer Identification Number or Legal Person Fiscal Number | – | String | 1 | 20 | Mnafatory |
| “name” | Nmae | – | String | 1 | 40 | Mandatory |
| “shortName” | Short Name; | – | String | 1 | 20 | Mandatory |
| “sic” | SIC – Standard Industrial Classification Code – (CAE: Classificação das Atividades Económicas) | – | Decimal | 1 | 5 | Mandatory |
| “socialObject” | Business Activity | – | String | 1 | 150 | Optional |
| “Settlement TypeCode” | Clearing type | “SPA” – Single Euro Payments Area | String | 3 | 3 | Mandatory |
| “refundMaxAmoun” | Daily maximum amount for Refunds | – | Decimal | 1 | 14.5 | Optional |
| “payoutTypeCode” | Payout type | “MAN” – Manual Payout “AUT” – Automatic Payout “SCH” – Scheduled | Char | 3 | 3 | Mandatory |
| “deferredAgreementDays” | Number of days after which the payout should be made | – | Number | 3 | 3 | Mandatory |
| “financial” | ||||||
| “IBAN” | International Bank Account Number | – | String | 3 | 34 | Mandatory |
| “BIC” | Bank International Code | – | String | 1 | 11 | Mandatory |
| “address” | ||||||
| “street” | Address | – | String | 1 | 40 | Optional |
| “postalCode” | Postal Code | – | String | 1 | 25 | Optional |
| “locality” | City | – | String | 1 | 20 | Optional |
| “postalLocality” | Postal Code locality | – | String | 1 | 10 | Optional |
| “country” | Country | Country ISO-3166 Numeric 3 | Numeric | 3 | 3 | Mandatory |
| “contact” | ||||||
| “email” | – | String | 1 | 55 | Optional | |
| “telephone” | Phone Number | – | String | 1 | 16 | Optional |
| “mobilePhone” | Mobile Phone Number | – | String | 1 | 16 | Optional |
Change Submerchant Agreement
Allows the Marketplace Operator to change the parameters of the agreement between the Marketplace Operator and each Submerchant.
Access via SIBS API Market:
PUT /sibs/v1/submerchant/{submerchant-id}/commission This feature requires sending parameters at the Request level that have the following characteristics:
| Parameter | Meaning | Accepted values and their meaning | Format | Minimum length | Maximum length | Type |
|---|---|---|---|---|---|---|
| “submerchant-code” | Submerchant Code | – | Numeric | 8 | 8 | Mandatory |
| “comission” | ||||||
| “feeFixedValue” | Fixed value | – | Decimal | 1 | 7.3 | Mandatory |
| “feePercentage” | Variable value | – | Decimal | 1 | 8.3 | Mandatory |
| “splitFeeMinAmount” | Minimum “Cap” | – | Decimal | 1 | 10.4 | Mandatory |
| “splitFeeMaxAmount” | Maximum “Cap” | – | Decimal | 1 | 10.4 | Mandatory |
Change Submerchant Status
Submerchants Statuses
The following table provides the various possible statuses applicable to Submerchants, as well as a description of the permissions inherent to each status. The deadlines for moving from one status to the next are also provided.
|
Status |
Transaction |
Payout |
Detail |
Deadlines |
|
Active |
|
|
Standard status of a Submerchant, which is already validated by the Acquirer, if applicable. It can make sales as well as receive payouts. |
n.a. |
|
Pending |
|
|
This status only applies where KYC is performed by the Acquirer(s). The Submerchant will remain in this status until validation by the Acquirer(s). In this status, the Submerchant can make sales, but cannot receive payouts. |
30 days |
|
Suspended |
|
|
The Submerchant will remain in this status if it exceeds 30 days in the KYC process. In this status, the Submerchant cannot make sales, nor receive payouts. Within the first 30 days, the Submerchant can move to the ‘Active’ status if the KYC process is completed. After this deadline, the Submerchant moves to the ‘Deleted’ status. |
30 days |
|
Deleted |
|
|
The customer goes to the ‘Deleted’ status in the following situations: -When it exceeds 30 days in the ‘Suspended’ status; -When it is refused by the Acquirer; -When the Onboarding process is cancelled by one of the parties (Submerchant or Marketplace Operator); -When the Customer ceases to be part of the Marketplace. After being deleted, a Submerchant will again have to go through the onboarding process. |
n.a. |
Allows the Marketplace Operator to change the status of the Submerchant associated with the Marketplace Operator.
Access via SIBS API Market:
PUT /sibs/v1/submerchant/{submerchant-id} This feature requires sending parameters at the Request level that have the following characteristics:
| Parameter | Meaning | Accepted values and their meaning | Format | Minimum length | Maximum length | Type |
|---|---|---|---|---|---|---|
| “submerchant-code” | Submerchant Code | – | Numeric | 8 | 8 | Mandatory |
| “submerchant” | ||||||
| “statusCode” | Submerchant status | “ACT” – Active “PND” – Pending “SUS” – Suspended | Chart | 3 | 3 | Mandatory |
Inquire Submerchant
Allows to view of the Submerchant’s characterisation details.
Access via SIBS API Market:
GET /sibs/v1/submerchant/{submerchant-id} This feature requires sending parameters at the Request level that have the following characteristics:
| Parameter | Meaning | Accepted values and their meaning | Format | Minimum length | Maximum length | Type |
|---|---|---|---|---|---|---|
| “submerchant-code” | Submerchant Code | – | Numeric | 8 | 8 | Mandatory |
Inquire Submerchant Agreement
Allows the Marketplace Operator to inquire the agreement positioned for each Submerchant.
Access via SIBS API Market:
GET /sibs/v1/submerchant/{submerchant-id}/commission This feature requires sending parameters at the Request level that have the following characteristics:
| Parameter | Meaning | Accepted values and their meaning | Format | Minimum length | Maximum length | Type |
|---|---|---|---|---|---|---|
| “submerchant-code” | Submerchant Code | – | Numeric | 8 | 8 | Mandatory |
Delete Submerchant
Allows the Marketplace Operator to delete the Submerchant (by changing its status). This action is irreversible.
Access via SIBS API Market:
DELETE /sibs/v1/submerchant/{sub- merchant-id} This feature requires sending parameters at the Request level that have the following characteristics:
| Parameter | Meaning | Accepted values and their meaning | Format | Minimum length | Maximum length | Type |
|---|---|---|---|---|---|---|
| “submerchant-code” | Submerchant Code | – | Numeric | 8 | 8 | Mandatory |
List Submerchants
Allows listing all Submerchants, or only those whose validation is pending, by the Marketplace Operator.
Access via SIBS API Market:
GET /sibs/v1/submerchant This feature requires sending parameters at the Request level that have the following characteristics:
| Parameter | Meaning | Accepted values and their meaning | Format | Minimum length | Maximum length | Type |
|---|---|---|---|---|---|---|
| “Submerchant- Type” | Submerchant type per status | “ALL” – All Submerchant ‘SPV’ – Submerchant Pending Validation | String | 3 | 3 | Mandatory |
| “Submerchant-Last-ID” | No. of split from which to send the list of splits per Submerchant | – | String | 8 | 8 | Optional |