Split initiation: Post Split and Payout Information
Allows the Marketplace Operator to post (send) splits and payouts of a purchase.
Access via SIBS API Market:
POST /sibs/v1/split/{split-type}
If the User does not receive a response to this API, they should call the API “Inquire Split” function to validate that the information has been posted successfully.
Only after this validation, and in case there has been an error at the split communication level, should the User make a new call to this API.
This process will prevent the communication of information from splits that could cause errors.
This feature requires sending parameters at the Request level that have the following characteristics:
Parameters of “Post Split and Payout Information”
| Parameter | Meaning | Accepted values and their meaning | Format | Minimum lenght | Maximum length | Type |
|---|---|---|---|---|---|---|
| “split-type” | Split Type | “Purchase” “Refund” | String | – | – | Mandatory |
| “submerchant” | ||||||
| “code” | Submerchant Code | – | Numeric | 8 | 8 | “submerchant” |
| “externalTransactionId” | Transaction external ID | – | String | 1 | 32 | |
| “originalSplitTransactionId” | split original ID | – | String | 1 | 14 | |
| “split” – “amount” | Split Amount | – | Numeric | 12.6 | 12.6 | “split” |
| “split” – “currency” | Currency Code | “968” – EURO | Numeric | 3 | ||
| “splitFee” – “amount” | MO free amount | – | Numeric | 12.6 | ||
| “splitFee” – “currency” | MO free currency | “968” – EURO | Numeric | 3 | ||
| “SplitSchedulingDate” | PayoutDate | – | Date | – | – |
Change Payout Scheduling
Allows the Marketplace Operator to change the payout date of a split.
Access via SIBS API Market:
PUT /sibs/v1/splitThis feature requires sending parameters at the Request level that have the following characteristics:
Parameters of the “Change Payout Scheduling” feature
| Parameters | Meaning | Accepted values and their meaning | Format | Minimum lenght | Maximum lenght | Type |
|---|---|---|---|---|---|---|
| “submerchant” | ||||||
| “code” | Submerchant Code | – | Numeric | 8 | 8 | Mandatory |
| “externalTransactionId” | Transaction external ID | – | String | 1 | 32 | Mandatory |
| “payoutReschedulingDate” | Payout Date | – | Date | – | – | Mandatory |
List transaction by Submerchant
Allows to view the split list and payout scheduling for a particular Submerchant.
Access via SIBS API Market:
GET /sibs/v1/split/transactions| Parameter | Meaning | Accepted values and their meaning | Format | Minimum lenght | Maximum lenght | Type |
|---|---|---|---|---|---|---|
| “Submerchant-Code” | Submerchant Code | – | String | 8 | 8 | Mandatory |
| “Split-Transaction-Last-ID” | No. of split from which to send the list of splits per Submerchant | – | String | 1 | 14 | Optional |
Inquire Split
Allows the Marketplace Operator to inquire a particular split.
Access via SIBS API Market:
GET /sibs/v1/spli/transactionThis feature requires sending parameters at the Request level that have the following characteristics:
Parameters of the “Inquire Split” feature
| Parameter | Meaning | Accepted values and their meaning | Format | Minimum lenght | Maximum lenght | Type |
|---|---|---|---|---|---|---|
| “Split-Transaction-ID” | Split Identifier | – | String | 1 | 14 | Mandatory |