Submit an advance settlement

Settlements consist of the hierarchical elements: Transactions, Annexes, and Parameters. This example defines a settlement with one transaction of type ADVANCE, which contains one annex of type EOS:Payment:Advance. This represents an advance payment of 372.00 defined in a priceContribution. See Generic Settlements for more information on the hierarchical structure.

When this settlement is cleared, the Clearing system will generate accounting entries. The transaction will be visible in the user interface and relevant financial reports:

Code
{
  "posRef": "EOS:Pos:ExternalPSP",
  "distributionChannelRef": "ENT:DistributionChannel:ExternalPSP",
  "settlementNo": 2,
  "settlementDate": "2025-11-26",
  "comments": [
    {"comment":"This is a comment"}
  ],
  "genericTransactions": [
    {
      "transactionType": "ADVANCE",
      "genericAnnexes": [
        {
          "annexRef": "EOS:Payment:Advance",
          "attributes": {
            "paymentType": "AgentVYG",
            "paymentTypeGroup": "AGENT"
          },
          "priceContribution": {
            "amount": "372.00"
          },
          "description": "A konto betaling for 3part VY-COIN"
        }
      ]
    }
  ]
}