Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation
Info

(warning) This feature is in still in progress and currently not supported

Therefore the credentialOnFile has been extended with type=installments and a few attributes describing the installment payment.

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.

(info)  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):

Code Block
languagexml
titleInitial installment
{
  "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:

Code Block
languagexml
titlesubsequent installment
{
  "type": {
    "installments": {
      "total": 3,
      "curIdx": 2,
      "purchaseAmount": 10000
    }
  },
  "initialPayment": false
}

Table of Contents


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameLink_EMV3DS
DisableCachingtrue
PageWithExcerptReuse API

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameLink_APIPlayground
DisableCachingtrue
PageWithExcerptReuse API


Request / Response installment.aspx

Request Elements

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

(info) PayID in request always refers to initial Payment created with PaySSL or PayNow

(info) PayID in response is the new payment process created for the subsequent installent payment created

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1657003420281_-1652834070
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamerequest_elements
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1657003420283_-439962406
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*
KeyFormatCNDDescriptionBeschreibung
Typea4MPaymethod for installment payment.
"CB2A" must be specified.

Zahlart für die Ratenzahlung.
Hier muss "CB2A" angegeben werden.

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

KeyFormatCNDDescriptionBeschreibung
credentialOnFileJSONMObject 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.
RefNran12O

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRefNr_Ctsf_Text
PageWithExcerptReuse API

Notes:

  • CB2A requires
    • fixed length of 12 characters, 
      Multiexcerpt include
      SpaceWithExcerptEN
      MultiExcerptNamePlatform-Kurz
      PageWithExcerptWording
      automatically align value to the right and add "0" (zero) to the left
    • only characters (A..Z, a..z) and digits (0..9) are allowed, no characters like underscore, minus, ...
    • RefNr is mandatory in case of "pre-authorization" by CB2A
      ((info) a MerchantID can be setup on
      Multiexcerpt include
      SpaceWithExcerptEN
      MultiExcerptNamePlatform-Kurz
      PageWithExcerptWording
      either to handle "authorization" or "pre-authorization")

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameRefNr_Ctsf_Text
PageWithExcerptDE:Reuse API

Anmerkungen:

  • CB2A erfordert
    • feste Länge von 12 Zeichen,
      Multiexcerpt include
      SpaceWithExcerptDE
      MultiExcerptNamePlatform-Kurz
      PageWithExcerptDE:Wording
      füllt automatisch rechtsbündig mit "0" (Ziffer Null) auf
    • erlaubt sind nur Buchstaben (A..Z, a..z) und Ziffern (0..9), keine Sonderzeichen
    • RefNr is verpflichtend für "pre-authorization" für CB2A
      ((info) die MerchantId kann auf Seiten
      Multiexcerpt include
      SpaceWithExcerptDE
      MultiExcerptNamePlatform-Kurz
      PageWithExcerptDE:Wording
      entweder für "authorization" oder "pre-authorization" konfiguriert werden

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameCapture
pageCapture
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage


Response Elements (installments)

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1657003717699_1009039229
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameresponse_elements
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1657003717701_1764074424
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

KeyFormatCNDDescriptionBeschreibung
refnr
OReference number as given in requestReferenznummer wie im Request angegeben

Status

a..20

M

Status of the transaction.

Values accepted:

  • AUTHORIZED
  • FAILED

Status der Transaktion.

Zulässige Werte:

  • AUTHORIZED

  • FAILED

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Analytics view of initial + subsequent payments → linked payments (PayId's)