APIs for Working as an Aggregator with Cardcom

To work as an aggregator with Cardcom, follow these processes: 

1. Open a merchant account and obtain a supplier number
2. Check the merchant's status
3. Reconciliation 
4. CHB notification

1. Opening a Merchant Account and Obtaining a Supplier Number (Beneficiary Number)

Merchant onboarding is performed using the following API:   Add Company for Meaged

Several important points should be noted:

1. IsValidationOnly should be submitted only when you want to verify that the code is valid.
2. Supplier User Name and Supplier Secret will be provided by Support.
3. Under CompnayInfo, submit the merchant's details. Please note that to obtain city and street codes, additional requests must be made to Cardcom: for cities, use Get cities; for streets, use Get streets. *If you want to retrieve city and street codes independently, you can do so at -->
4. Under PeopleInfo, enter the details of the authorized signatories. Finally, in the KycInfo section, enter information such as the merchant's website, maximum number of installments, and MCC.
5. To obtain the MCC, make two requests: first for the main MCC using Get Main MCCs, and then for the specific MCC using Get Sub MCCs. Submit the SUB MCC in the MCC field.

At this stage, you will have received a supplier number and its status. If the status is not Approved, you can proactively check the supplier's status. (Continue to Section 2.)

A WEBHOOK will also be received whenever the supplier number's status changes. The WEBHOOK URL must be configured with Support. If a Rejected status is received, do not process transactions using this supplier number; the funds will not be transferred.

0-UnderTest (under re-evaluation)

1-InProcess (in process)

2-Approved (approved)

3-Blocked (blocked)

4-Error (error)

2. Checking the Merchant's Status

Use Get sapak information for Company. You can search in two ways:

A. Enter the company registration number to receive the complete list of supplier numbers associated with that company registration number.

B. Enter a specific supplier number.

For examples of the responses received, see: SAPAK WEBHOOK.

3. Reconciliation

3.1. Transactions 

To perform reconciliation, use the following API: Finacial tranzaction

Several important points should be noted:

1. Page should contain the page number you want to display with the data, while Page_size should contain the number of records for that page (up to 2,000 records).

2. ActionCode indicates the action type. For information about action types, see: ActionCode

3. Calculate the transaction amount, OrigTransactionAmount, after deducting the IfPct fee (%) and VatPrc VAT (%). 

4. IndexLinkType indicates whether the amount is linked to the price index (8), the US dollar (4), or is not linked at all (1).

5. TxnType indicates the transaction type. For the response codes and their meanings, see: TXNTYPE

6. UID is the identifier of the transaction performed on the terminal.

7. SapakMutavNumber is the supplier number of the recipient of the funds (the merchant).

*If you want to reconcile against the source transaction report, retrieve the transaction details on the day after the transactions are performed

using the CreditCard Transactions request.

3.2. Bank

To obtain bank deposit details, use the Bank Deposites API.

3.3 CHB

To obtain the complete CHB list, use the Special Transactions API.

3.4. Clearing Invoice 

To obtain clearing invoice details, use the Get billing report for account API.