- Created by Admin, last modified by Peter Posse on 27. Feb 2024
Scenario – Installment Payments
You offer your customers payment by credit card based on installment payments
Customers agrees installment payment based on a total amount and a number of installment payments.
You use the pseudo card number to store and reuse the card data
IMPORTANT: The following initial payment is subject to the liability shift for you as a merchant. In the case of the subsequent payment, however, this expires, so that there is no liability shift.
 credentialOnFile has been extended with type=installments
and a few attributes describing the installment payment.
Credentials on File (CoF) – Initial Installment Payment
Applies to PaySSL.aspx + PayNow.aspx
3-D Secure is mandatory
Necessary adjustments:
Example:
JSON object credentialOnFile with JSON parameter installment (3 keys included)
JSON object credentialOnFile with JSON parameter initialPayment and the value "true"
- the amount used for the initial payment request is the amount authorized for 1st installment payment
Example Initial Subscription Payment for 3 installment payments with a total amount of 100,00 (EUR):
{ "type": { "installments": { "total": 3, "curIdx": 1, "purchaseAmount": 10000 } }, "initialPayment": true }
Credentials on File (CoF) – Subsequent Installment Payment
Applies to installment.aspx
3-D Secure is NOT mandatory
Necessary adjustments:
Example:
- The PayId from the initial payment is required for each subsequent installment payment.
- Please always send the schemereferenceID from the initial payment so that the downstream systems can link the two transactions accordingly.
JSON object credentialOnFile with JSON parameter recurring (3 keys included)
JSON object credentialOnFile with JSON parameter initialPayment and value "false"
- the total purchase amount (purchaseAmount) and total number of installment payments (total) remain the same, the current index increases with each authorization.
- the amount used for the subsequent payment request is the amount authorized for subsequent installment payment
Example Subsequent Subscription Payment:
{ "type": { "installments": { "total": 3, "curIdx": 2, "purchaseAmount": 10000 } }, "initialPayment": false }
Request / Response installment.aspx
Request Elements
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
PayID in request always refers to initial Payment created with PaySSL or PayNow
PayID in response is the new payment process created for the subsequent installment payment
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
Type | a4 | M | Paymethod for installment payment. "CB2A" must be specified. | Zahlart für die Ratenzahlung. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment | Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
ReqId | ans..32 | O | To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. | Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
credentialOnFile | JSON | M | Object specifying type and series of transactions using payment account credentials (e.g. account number or payment token) that is stored by a merchant to process future purchases for a customer. Required if applicable. | Objekt, dass Art und Reihe der Transaktionen angibt, die unter Verwendung von beim Händler hinterlegten Zahlungsdaten (z.B. Kontonummer oder Zahlungs-Token) zur Verarbeitung künftiger Käufe eines Kunden erfolgen. Erforderlich, falls zutreffend. |
RefNr | an12 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. Notes:
| Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden. Anmerkungen:
|
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle |
Key | Format | CND | Description | Beschreibung | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Capture | an..6 | OM | Determines the type and time of capture.
| Bestimmt Art und Zeitpunkt der Buchung (engl. Capture).
|
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: |
Response Elements (installments)
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | HändlerID, die von Computop vergeben wird |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment | Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
refnr | O | Reference number as given in request | Referenznummer wie im Request angegeben | |
Status | a..20 | M | Status of the transaction. Values accepted:
| Status der Transaktion. Zulässige Werte:
|
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus! |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
- No labels