Creates a HelcimPay.js Checkout Session

Time	Status	User Agent
Retrieving recent requests…

paymentType

string

required

Payment Type. Valid payment types are purchase | preauth | verify

amount

number

required

The amount of the transaction to be processed.

currency

string

required

Currency abbreviation. CAD | USD

customerCode

string

This is the code of an existing customer in Helcim associated with this checkout.

invoiceNumber

string

This is the number of an existing invoice in Helcim associated with this checkout.

paymentMethod

string

This is the payment method (credit card, ACH) that customer can use to pay the amount. cc | ach | cc-ach

allowPartial

number

This is used to determine whether the partial payment UI will be displayed to the customer.

hasConvenienceFee

number

This is used to apply the convenience fee rate to credit card transaction should customer chooses this payment method.

taxAmount

number

This is used to enable level 2 processing lower rates. The value should be the dollar amount of the tax to 2 decimal places.

hideExistingPaymentDetails

number

This is used to hide the existing payment information of the customer.

setAsDefaultPaymentMethod

number

This is used to set the payment method of the transaction to default for that customer.

terminalId

number

This is used to process the card transaction on the specified terminal.

confirmationScreen

boolean

This is used to display transaction information such as the amount paid and invoice number to the user after a successful transaction.

If true, a confirmation screen will be displayed after a successful transaction.

If false, no confirmation screen will be displayed.

digitalWallet

string

This is used to enable digital wallets as payment methods, currently Google Pay is available.

If a given digital wallet is set to 1 it will be enabled, if it is set to 0 it will not be enabled.

By default, no digital wallets are enabled.

displayContactFields

number

This is used to add phone and email input fields to the modal, allowing customers to provide additional billing information.

Set the value to 1 to enable these fields, or 0 to keep them disabled.

Note that the contact fields cannot be used in combination with a customer code.

By default, display contact fields are disabled.

customStyling

object

Applies custom styling to the Helcim Pay instance.

customerRequest

object

This is used to create a new customer based on the given information.

invoiceRequest

object

This is used to create a new invoice based on the given information.

200Successful

defaultFailed