Popup Reference
This reference is here to help you find those hard-to-find bits of information all in one place to make your life easy.
Configuration options
Here's a complete list of Popup configuration options.
Parameter | Description |
---|---|
amountInCents integer | Amount you would like to charge the customer as part of this payment. This is a required field for creating a charge and the amount can not be increased once a token is created. |
currency string | An ISO 4217 currency code. We currently only support ZAR. |
callback function | After tokenizing a card, a card token is passed to this function. The function should send the token to your back-end to perform the charge. |
onCancel function | This function is called when the user cancels the payment by closing the popup window. |
name string | The name you would like to show in the popup header. Typically the name of your store or the product being sold. |
description string | A description of the product or service being purchased. |
image string | URL link that is pointing to an image that will be shown in the popup header. This is typically your logo or a product image. It will be displayed in a circle. |
metadata json | A map of key value pairs that allow you to store extra data related to this payment. We will save the data alongside the payment. Whenever you fetch the payment with our API, we’ll also include the metadata. You can use up to approximately 1kB. |
customer.email string | The email address of the end customer that you are billing. This will help the customer's bank verify that the transaction is legitimate |
customer.phone string | The phone number of the end customer you are billing. This will help the customer's bank verify that the transaction is legitimate |
customer.firstName string | The first name of the card holder you are billing. This will help the customer's bank verify that the transaction is legitimate |
customer.lastName string | The last name of the card holder you are billing. This will help the customer's bank verify that the transaction is legitimate. |