Factory for the payer of the purchase
The amount of the purchase
The URL to the API endpoint receiving POST requests on transaction activity related to the payment order.
The URL to redirect the payer to if the payment is cancelled, either by the payer or by the merchant trough an abort request of the payment or paymentorder.
The URL that Swedbank Pay will redirect back to when the payer has completed his or her interactions with the payment.
This does not indicate a successful payment, only that it has reached a final (complete) state.
A GET request needs to be performed on the payment order to inspect it further. See completeUrl for details.
The currency of the purchase
The description of the purchase
The description of the payment order.
Set to true if you want to generate an recurrenceToken for future recurring purchases.
Set to true if you want to generate an recurrenceToken for future recurring purchases.
The array of URLs valid for embedding of Swedbank Pay Hosted Views.
The instrument to use for this purchace (must be enabled in Swedbank Pay) By default it will present all available instruments to the customer
The language of the purchase
The operation of the purchase
The array of URLs valid for embedding of Swedbank Pay Hosted Views.
Order reference string.
The name of the payee, usually the name of the merchant.
For our Seamless Views, the field called paymentUrl will be used when the payer is redirected out of the Seamless View (the iframe). The payer is redirected out of frame when selecting the payment instrument.
The URL should represent the page of where the Payment Order Seamless View was hosted originally, such as the checkout page, shopping cart page, or similar. Basically, paymentUrl should be set to the same URL as that of the page where the JavaScript for the Seamless View was added to in order to initiate the payment process.
Please note that the paymentUrl must be able to invoke the same JavaScript URL from the same Payment Order as the one that initiated the payment process originally, so it should include some sort of state identifier in the URL. The state identifier is the ID of the order, shopping cart or similar that has the URL of the Payment stored.
A product category or number sent in from the payee/merchant. This is not validated by Swedbank Pay, but will be passed through the payment process and may be used in the settlement process.
The created recurrenceToken, if operation: Verify, operation: Recur or generateRecurrenceToken: true was used.
A unique reference from the merchant system. It is set per operation to ensure an exactly-once delivery of a transactional operation.
See payeeReference for details.
In Invoice Payments payeeReference is used as an invoice/receipt number, if the receiptReference is not defined.
The subsite field can be used to perform split settlement on the payment. The subsites must be resolved with Swedbank Pay reconciliation before being used.
The URL to the terms of service document which the payer must accept in order to complete the payment. **HTTPS is a requirement.
The urls object, containing the URLs relevant for the payment order.
The user agent of the payer. Should typically be set to the value of the User-Agent header sent by the payer’s web browser.
The vat amount of the purchase
Adds a hostUrl to the hostUrls array.
The new hostUrls string
The purchase factory for chaining.
Adds a hostUrl to the hostUrls array.
The new hostUrls string
The purchase factory for chaining.
Serializes the purchase for Swedbank Pay and makes a request for the purchase to be created.
A live entity of the paymentorder.
The URL to the API endpoint receiving POST requests on transaction activity related to the payment order.
The new hostUrls array
The purchase factory for chaining.
The URL to redirect the payer to if the payment is cancelled, either by the payer or by the merchant trough an abort request of the payment or paymentorder.
The new hostUrls array
The purchase factory for chaining.
The URL that Swedbank Pay will redirect back to when the payer has completed his or her interactions with the payment.
This does not indicate a successful payment, only that it has reached a final (complete) state.
A GET request needs to be performed on the payment order to inspect it further. See completeUrl for details.
The new hostUrls array
The purchase factory for chaining.
Sets the currency of the purchase
The new currency
Sets The description of the payment order.
The new description
The purchase factory for chaining.
Set to true if you want to generate an PaymentToken for future recurring purchases.
The new value for generatePaymentToken
The purchase factory for chaining.
Set to true if you want to generate an recurrenceToken for future recurring purchases.
The new value for generateRecurrenceToken
The purchase factory for chaining.
The array of URLs valid for embedding of Swedbank Pay Hosted Views.
The new hostUrls array
The purchase factory for chaining.
Sets the instrument to use for this purchace (must be enabled in Swedbank Pay) By default it will present all available instruments to the customer
The new operation
The purchase factory for chaining.
Sets the language of the purchase
The new language
The purchase factory for chaining.
Sets the operation of the purchase
The new operation
The purchase factory for chaining.
The array of URLs valid for embedding of Swedbank Pay Hosted Views.
The new orderItems array
The purchase factory for chaining.
Order reference string.
the new reference string
The purchase factory for chaining.
The name of the payee, usually the name of the merchant.
the new subsite string
The purchase factory for chaining.
For our Seamless Views, the field called paymentUrl will be used when the payer is redirected out of the Seamless View (the iframe). The payer is redirected out of frame when selecting the payment instrument.
The URL should represent the page of where the Payment Order Seamless View was hosted originally, such as the checkout page, shopping cart page, or similar. Basically, paymentUrl should be set to the same URL as that of the page where the JavaScript for the Seamless View was added to in order to initiate the payment process.
Please note that the paymentUrl must be able to invoke the same JavaScript URL from the same Payment Order as the one that initiated the payment process originally, so it should include some sort of state identifier in the URL. The state identifier is the ID of the order, shopping cart or similar that has the URL of the Payment stored.
The new hostUrls array
The purchase factory for chaining.
A product category or number sent in from the payee/merchant. This is not validated by Swedbank Pay, but will be passed through the payment process and may be used in the settlement process.
the new product category string
The purchase factory for chaining.
The created recurrenceToken, if operation: Verify, operation: Recur or generateRecurrenceToken: true was used.
The new value for recurrenceToken
The purchase factory for chaining.
A unique reference from the merchant system. It is set per operation to ensure an exactly-once delivery of a transactional operation.
See payeeReference for details.
In Invoice Payments payeeReference is used as an invoice/receipt number, if the receiptReference is not defined.
the new reference string
The purchase factory for chaining.
The subsite field can be used to perform split settlement on the payment. The subsites must be resolved with Swedbank Pay reconciliation before being used.
the new subsite string
The purchase factory for chaining.
The URL to the terms of service document which the payer must accept in order to complete the payment. **HTTPS is a requirement.
The new hostUrls array
The purchase factory for chaining.
The user agent of the payer. Should typically be set to the value of the User-Agent header sent by the payer’s web browser.
the new userAgent string
The purchase factory for chaining.
Serializes the purchase to a JSON-encodeable object.
A serialized object able to trivially be converted to JSON
Generated using TypeDoc
The client