post https://example.com/customerprofiles//initializeRegistration
The Initialize Registration service is used to verify (with 3DS) and save a card in a profile for future use in Paynovas system without processing any amount. You will receive an identifier (GUID) for the payment session.
When a payment session is successfully created, Paynova will POST-redirect the customer back to your server upon completion of the payment session using one of the URLs provided. For more information see
POST-redirect
.
Property | Type | Description |
---|---|---|
orderNumber required | string(4-50) | Your identifier for the order, most likely from your order management system. Example: "ORDER-123" |
currencyCode required | string(2-3) | The three-letter (alpha-3) ISO currency code or currency number as per ISO 4217. See the Currency Code page for more details. Example: "SEK" , "752" |
customer conditional | customer | Information about the customer. Conditions: > Required if a credit product is selected payment method. Example: { "customerId": "", "governmentId": "196006208133", "emailAddress": "[email protected]", "name": { "companyName": "", "firstName": "CHRISTOPHER", "lastName": "WILLIAMS" } } |
paymentMethods required | array | The id's for the payments methods to display on the hosted payment page. The full list of available payment methods are available here. Example: 99 (Show all available cards){ "id": "99" } |
paymentChannelId required | int | The id of the payment channel. See paymentChannelId page for possible values. If you wish to use the registration for future MOTO transactions, you must send in PaymentChannelId = 1 (Online) to trigger 3DS verification and have a respective acquiring agreement mapped to it, due to PSD2 requirements. Example: 1 |
interfaceOptions optional | interfaceoption | Interface options for the hosted payment page. Example: { "interfaceId":5, "layoutName":"Paynova_Responsive_2", "customerLanguageCode":"SWE", "urlRedirectSuccess":"http://myshop.com/success", "urlRedirectCancel":"http://myshop.com/cancel", "urlRedirectPending":"http://myshop.com/pending", "urlCallback":"https://postb.in/YourBinNumber" } |
Response Parameters
Status | status | API operation status. Example: { "isSuccess":true, "errorNumber":0, "statusKey":"SUCCESS "statusMessage":"The operation was successful." } |
SessionId | guid | The id of the payment session. Conditions: > This parameter is not returned in error situations. Example: "ce0a6ef0-63b3-4ae4-8001-a3b100b23ffe" |
Url | string | The url to which the user should be redirected to complete the payment. Conditions: > This parameter is not returned in error situations. Example: "https://paygate.paynova.com/Aero/Payment/2/ce0a6ef0-63b3-4ae4-8001-a3b100b23ffe" |