COconfirmo
Settlement

Get Settlement detail

Retrieves detailed information about a specific Settlement by its ID.

get/v3/settlements/{id}

Request

  • Base URL
    https://confirmo.net/api
  • URL
    https://confirmo.net/api/v3/settlements/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The Settlement ID.

Response

OK

accountstring

The IBAN or crypto address

amountnumber

The amount to be paid out.

balanceFromPreviousPeriodnumber

The balance that has been transferred from the previous Settlement.

balanceToNextPeriodnumber

The balance to be transferred to the next Settlement.

correctionTransactionIdsstring[]

The Settlement's correction transactions IDs.

correctionTransactionSumnumber

The sum of correction transactions made by admin.

createdAtinteger

The timestamp when the Settlement was created.

cryptoWithdrawalAmountSumnumber

The sum of the Settlement's Crypto Withdrawal amounts.

cryptoWithdrawalFeeSumnumber

The sum of the Settlement's Crypto Withdrawal fees.

cryptoWithdrawalIdsstring[]

The Settlement's Crypto Withdrawal IDs.

currency'BTC' | 'CZK' | 'ETH' | 'EUR' | 'GBP' | 'HUF' | 'LTC' | 'PLN' | 'POL' | 'SOL' | 'TRX' | 'USD' | 'USDC' | 'USDT'

The currency in which the Settlement will be paid out. Merchant gets paid in this currency, when it is assigned to an invoice as settlement currency

feenumber

The Settlement fee.

idstring

The Settlement ID.

invoiceAmountSumnumber

The sum of Settlement's Invoices amounts.

invoiceFeeSumnumber

The sum of Settlement's Invoice fees.

invoiceIdsstring[]

The Settlement's Invoices IDs.

keepMinBalancenumber

The minimum account balance after Settlement.

osTransactionAmountSumnumber

The sum of transactions created via Payout API.

osTransactionFeeSumnumber

The sum of fees of transactions created via Payout API.

overpaymentAmountSumnumber

The sum of Settlement's accepted invoice overpayments.

overpaymentFeeSumnumber

The sum of fees of Settlement's accepted invoice overpayments.

payoutIdsstring[]

The Settlement's Payouts IDs.

status'blocked_overlimit' | 'pending' | 'on_hold' | 'sending' | 'sent' | 'failed' | 'canceled'

The Settlement status.

statusReasonstring

The reason why the Settlement sending failed.

substatusstring

Example response

{
  "account": "CZ65 0800 0000 192 5399 0014",
  "createdAt": 1506079172,
  "cryptoWithdrawalAmountSum": 100,
  "currency": "EUR",
  "id": "set748ep4e5x",
  "osTransactionAmountSum": 100,
  "overpaymentAmountSum": 100,
  "substatus": "SCREENING_IN_PROGRESS"
}

Changes

No recorded changes to this operation across all 1 revision of this API.