These docs are for v1.0.1. Click to read the latest docs for v2.1.0.

Deferred Settlement

The Settlement request is often also referred to as “Capture” or “Clearing”. It can be used for the settlement of previously authorized transactions. Set reqtype=NOA during authorization to defer the settlement. On the subsequent settlement request, the transaction id uppTransactionId is needed.

📘

Direct Debits

Transactions get directly settled during the authorization request using the Payment Page and reqtype=CAA (default behaviour). Please check out our API Reference for more details.

🚧

Please note

  • The authorized amount must usually not be exceeded.
  • Authorized transactions can usually only be settled once. However, some payment methods allow this. Please consult the according payment method documentation.
  • Partial settlement requests are not supported in most cases.
  • Deferred settlement is not supported by all payment methods. Verify first before applying.

Example

curl -v -X POST https://api.sandbox.datatrans.com/upp/jsp/XML_processor.jsp \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d @- << EOF
<?xml version="1.0" encoding="UTF-8" ?>
<paymentService version="2">
  <body merchantId="1000011011">
    <transaction refno="929787">
      <request>
        <amount>1000</amount>
        <currency>CHF</currency>
        <uppTransactionId>TRANSACTION-ID</uppTransactionId>
      </request>
    </transaction>
  </body>
</paymentService>
EOF
<paymentService version="2">
    <body merchantId="1000011011" status="accepted">
        <transaction refno="929787" trxStatus="response">
            <request>
                <amount>1000</amount>
                <currency>CHF</currency>
                <uppTransactionId>TRANSACTION-ID</uppTransactionId>
                <reqtype>COA</reqtype>
                <transtype>05</transtype>
            </request>
            <response>
                <responseCode>01</responseCode>
                <responseMessage>settlement succeeded</responseMessage>
            </response>
        </transaction>
    </body>
</paymentService>