API Reference

Full parameter and response details for every Settlement API operation. For connection and authentication instructions, see the introduction.

GetSettlementsByMerchant

Retrieves all settlements for a merchant within a specified date range. Use this operation to get a list of settlements for reconciliation or reporting purposes.

Parameters

merchantIdstringRequired
Merchant ID (MID)
dateFromdateRequired
Start date of the settlement date range (inclusive)
dateTodateRequired
End date of the settlement date range (inclusive)

Response

Returns an array of Settlement[] objects. Each settlement includes the settlement date, run number, amounts, deductions, and payment information.

MerchantIDstring
Merchant ID (MID)
SettlementDatedate
Date and time when the settlement was created
SettlementRunNumberstring
Unique settlement run number (also known as SettleCode)
Amountdecimal
Total gross amount of all transactions in the settlement
Deductiondecimal
Total amount of all deductions and fees applied
Commissiondecimal
Total commission amount deducted from the settlement
Paymentdecimal
Net amount paid to the merchant (Amount - Deduction)
JcbAmountdecimal
Total amount for JCB card transactions
AmexAmountdecimal
Total amount for American Express card transactions
MasterCardAmountdecimal
Total amount for MasterCard transactions
CupAmountdecimal
Total amount for China UnionPay transactions
VisaAmountdecimal
Total amount for Visa transactions
DinersAmountdecimal
Total amount for Diners Club transactions
CurrencyCodestring
Settlement currency (ISO 4217 currency code)
SlipCountint
Total number of transaction slips (receipts) in the settlement
DeductionItemsSettlementDeduction[]
Array of deduction items (fees and adjustments)
Request example
POST /settlement/creditcard.svc HTTP/1.1
Host: services.borgun.is
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://tempuri.org/ICreditCardService/GetSettlementsByMerchant"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSettlementsByMerchant xmlns="http://tempuri.org/">
      <merchantId>example</merchantId>
      <dateFrom>2024-01-15T00:00:00</dateFrom>
      <dateTo>2024-01-15T00:00:00</dateTo>
    </GetSettlementsByMerchant>
  </soap:Body>
</soap:Envelope>
200 Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSettlementsByMerchantResponse xmlns="http://tempuri.org/">
      <Result>
        <ResultCode>0</ResultCode>
        <ResultText>Success</ResultText>
        <ErrorMessage>NULL</ErrorMessage>
      </Result>
      <Data>
        <Item>
          <MerchantID>example</MerchantID>
          <SettlementDate>2024-01-15T00:00:00</SettlementDate>
          <SettlementRunNumber>SETTLE-2024-001</SettlementRunNumber>
          <Amount>1000.00</Amount>
          <Deduction>0</Deduction>
          <Commission>0</Commission>
          <Payment>1000.00</Payment>
          <JcbAmount>1000.00</JcbAmount>
        </Item>
      </Data>
    </GetSettlementsByMerchantResponse>
  </soap:Body>
</soap:Envelope>

GetSettlementByRunNumber

Retrieves a specific settlement by its settlement run number. Use this operation when you know the exact settlement you need to examine.

Parameters

merchantIdstringRequired
Merchant ID (MID)
runNumberstringRequired
Settlement run number (also known as SettleCode)

Response

Returns a single Settlement object. The settlement includes all associated batches and deduction items.

MerchantIDstring
Merchant ID (MID)
SettlementDatedate
Date and time when the settlement was created
SettlementRunNumberstring
Unique settlement run number (also known as SettleCode)
Amountdecimal
Total gross amount of all transactions in the settlement
Deductiondecimal
Total amount of all deductions and fees applied
Commissiondecimal
Total commission amount deducted from the settlement
Paymentdecimal
Net amount paid to the merchant (Amount - Deduction)
JcbAmountdecimal
Total amount for JCB card transactions
AmexAmountdecimal
Total amount for American Express card transactions
MasterCardAmountdecimal
Total amount for MasterCard transactions
CupAmountdecimal
Total amount for China UnionPay transactions
VisaAmountdecimal
Total amount for Visa transactions
DinersAmountdecimal
Total amount for Diners Club transactions
CurrencyCodestring
Settlement currency (ISO 4217 currency code)
SlipCountint
Total number of transaction slips (receipts) in the settlement
DeductionItemsSettlementDeduction[]
Array of deduction items (fees and adjustments)
Request example
POST /settlement/creditcard.svc HTTP/1.1
Host: services.borgun.is
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://tempuri.org/ICreditCardService/GetSettlementByRunNumber"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSettlementByRunNumber xmlns="http://tempuri.org/">
      <merchantId>example</merchantId>
      <runNumber>SETTLE-2024-001</runNumber>
    </GetSettlementByRunNumber>
  </soap:Body>
</soap:Envelope>
200 Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSettlementByRunNumberResponse xmlns="http://tempuri.org/">
      <Result>
        <ResultCode>0</ResultCode>
        <ResultText>Success</ResultText>
        <ErrorMessage>NULL</ErrorMessage>
      </Result>
      <Data>
        <MerchantID>example</MerchantID>
        <SettlementDate>2024-01-15T00:00:00</SettlementDate>
        <SettlementRunNumber>SETTLE-2024-001</SettlementRunNumber>
        <Amount>1000.00</Amount>
        <Deduction>0</Deduction>
        <Commission>0</Commission>
        <Payment>1000.00</Payment>
        <JcbAmount>1000.00</JcbAmount>
      </Data>
    </GetSettlementByRunNumberResponse>
  </soap:Body>
</soap:Envelope>

GetTransactionsByRunNumber

Retrieves all transactions included in a specific settlement. This operation provides the most detailed transaction information, including fee breakdowns at the transaction level.

Parameters

merchantIdstringRequired
Merchant ID (MID)
runNumberstringRequired
Settlement run number (also known as SettleCode)

Response

Returns an array of Transaction[] objects. Transactions returned by this operation include detailed fee information (card scheme fees, commission amounts, and interchange fees) that are not available when using GetTransactionsByBatch.

MerchantIDstring
Merchant ID (MID)
TransactionDatedate
Date and time when the transaction was processed
Amountdecimal
Transaction amount
CurrencyCodestring
Transaction currency (ISO 4217 currency code)
SlipNumberstring
Unique slip (receipt) identifier for this transaction
CardNumberstring
Masked card number (first 6 digits + last 4 digits)
CardBrandstring
Card brand name (e.g., "Visa", "MasterCard", "American Express")
OriginalAmountdecimal
Original transaction amount before currency conversion (if applicable)
OriginalCurrencyCodestring
Original currency code before conversion (if applicable)
SettlementRunNumberstring
Settlement run number this transaction belongs to
BatchNumberstring
Batch number this transaction belongs to
BatchDatedate
Date of the batch containing this transaction
AuthorizationCodestring
Authorization code from the card issuer
TransactionTypestring
Transaction type code (see Transaction Type Codes)
RRNstring
Retrieval Reference Number
IsCorporateboolean
Indicates whether the card used was a corporate card
TerminalIdstring
Card Machine identifier where the transaction was processed
CardholderCountrystring
ISO country code of the card issuer (if available)
ARNstring
Acquirer Reference Number
TransactionReferencestring
Merchant reference linking the device to settlement (up to 36 characters)
CardSchemeFeeAmountdecimal
Card scheme fee amount (returned by GetTransactionsByRunNumber only)
CardSchemeFeeCurrencystring
Currency of the card scheme fee
CardSchemeFeeDescriptionstring
Description of the card scheme fee
CommissionAmountdecimal
Commission amount for this transaction (returned by GetTransactionsByRunNumber only)
CommissionCurrencystring
Currency of the commission
CommissionDescriptionstring
Description of the commission
InterchangeFeeAmountdecimal
Interchange fee amount (returned by GetTransactionsByRunNumber only)
InterchangeFeeCurrencystring
Currency of the interchange fee
Request example
POST /settlement/creditcard.svc HTTP/1.1
Host: services.borgun.is
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://tempuri.org/ICreditCardService/GetTransactionsByRunNumber"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetTransactionsByRunNumber xmlns="http://tempuri.org/">
      <merchantId>example</merchantId>
      <runNumber>SETTLE-2024-001</runNumber>
    </GetTransactionsByRunNumber>
  </soap:Body>
</soap:Envelope>
200 Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetTransactionsByRunNumberResponse xmlns="http://tempuri.org/">
      <Result>
        <ResultCode>0</ResultCode>
        <ResultText>Success</ResultText>
        <ErrorMessage>NULL</ErrorMessage>
      </Result>
      <Data>
        <Item>
          <MerchantID>example</MerchantID>
          <TransactionDate>2024-01-15T00:00:00</TransactionDate>
          <Amount>1000.00</Amount>
          <CurrencyCode>SETTLE-2024-001</CurrencyCode>
          <SlipNumber>SETTLE-2024-001</SlipNumber>
          <CardNumber>SETTLE-2024-001</CardNumber>
          <CardBrand>example</CardBrand>
          <OriginalAmount>1000.00</OriginalAmount>
        </Item>
      </Data>
    </GetTransactionsByRunNumberResponse>
  </soap:Body>
</soap:Envelope>

GetSettlementDeductionItems

Retrieves all deduction items (fees and adjustments) applied to a specific settlement. Use this to understand what fees and charges were deducted from the settlement amount.

Parameters

merchantIdstringRequired
Merchant ID (MID)
runNumberstringRequired
Settlement run number (also known as SettleCode)

Response

Returns an array of SettlementDeduction[] objects. Each deduction item includes the fee code, amount, description, and the number of transactions it applies to.

MerchantIDstring
Merchant ID (MID)
SettlementRunNumberstring
Settlement run number this deduction applies to
Amountdecimal
Total deduction amount
Codestring
Deduction code indicating the type of fee or adjustment (see Deduction Codes Reference)
CurrencyCodestring
Currency of the deduction (ISO 4217)
Textstring
Human-readable description of the deduction
Feestring
Exact amount of a single fee or the fee percentage, depending on the type of fee
FeeCountdouble
Transaction count the fee applies to (if applicable)
InterchangeFeedecimal
Total interchange fee amount included in this deduction
Request example
POST /settlement/creditcard.svc HTTP/1.1
Host: services.borgun.is
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://tempuri.org/ICreditCardService/GetSettlementDeductionItems"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSettlementDeductionItems xmlns="http://tempuri.org/">
      <merchantId>example</merchantId>
      <runNumber>SETTLE-2024-001</runNumber>
    </GetSettlementDeductionItems>
  </soap:Body>
</soap:Envelope>
200 Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSettlementDeductionItemsResponse xmlns="http://tempuri.org/">
      <Result>
        <ResultCode>0</ResultCode>
        <ResultText>Success</ResultText>
        <ErrorMessage>NULL</ErrorMessage>
      </Result>
      <Data>
        <MerchantID>example</MerchantID>
        <SettlementRunNumber>SETTLE-2024-001</SettlementRunNumber>
        <Amount>1000.00</Amount>
        <Code>SETTLE-2024-001</Code>
        <CurrencyCode>SETTLE-2024-001</CurrencyCode>
        <Text>example</Text>
        <Fee>example</Fee>
        <FeeCount>null</FeeCount>
      </Data>
    </GetSettlementDeductionItemsResponse>
  </soap:Body>
</soap:Envelope>

Transaction Type Codes

Transaction type codes indicate the nature of a card transaction. These codes are returned in the TransactionType field of transaction objects.

Code Description
PAYMENT Retail sales
REFUND Credit transaction

Deduction Codes Reference

Each deduction item in a settlement includes a code that identifies the type of fee or adjustment being applied. The deduction code is returned in the Code field of SettlementDeduction objects.

The following table lists the deduction codes and their descriptions:

Code Description
MERCHANT_SERVICE_CHARGE Merchant service charge
INTERCHANGE_FEES Interchange fees
SCHEME_FEES Scheme fees
CHARGEBACK_FEES Chargeback Fees
ISO_FEES Iso fees
FEES Fees
REFUNDS Refunds
MEAL_CARDS Meal Cards
CHARGEBACK Chargebacks
REFUNDS Refunds
TEYA_CASH_ADVANCE Teya cash advance