Rave Parameter Definition
This page describes the parameters that can be passed in your inline JS function
The paramters to be passed are listed here, required and optional parameters are listed and described.
Rave Inline Script Parameter reference
Parameter Reference
| Parameter | Required | Description |
|---|---|---|
| PBFPubKey | true | Your merchant public key provided when you create a button. |
| integrity_hash | false | This is a sha256 hash of your getpaidSetup values, it is used for passing secured values to the payment gateway. |
| txref | true | Unique transaction reference provided by you. |
| payment_options | false | This allows you select the payment option you want for your users, see Choose Payment Methods for more info. |
| payment_plan | false | This is the payment plan ID used for Recurring billing ]. |
| subaccounts | false | This is an array of objects containing the subaccount IDs to split the payment into. |
| amount | true | Amount to charge. |
| currency | false | currency to charge in. Defaults to NGN |
| country | false | route country. Defaults to NG |
| customer_email | true | Email of the customer. |
| customer_phone | true | phone number of the customer. |
| customer_firstname | false | firstname of the customer. |
| customer_lastname | false | lastname of the customer. |
| pay_button_text | false | Text to be displayed on the Rave Checkout Button. |
| custom_title | false | Text to be displayed as the title of the payment modal. |
| custom_description | false | Text to be displayed as a short modal description. |
| redirect_url | false | URL to redirect to when transaction is completed. |
| custom_logo | false | Link to the Logo image. |
| onclose: function() | false | A function to be called when the pay modal is closed. |
| callback: function(b) | false | A function to be called on successful card charge. Users can always be redirected to a successful or failed page supplied by the merchant here based on the response. |
| meta:[{metaname:‘flightid’,metavalue:‘93849-MK5000’}] | false | Any other custom data you wish to pass. |
Rave Embed Code Parameter reference
Parameter Reference
| Parameter | Required | Description |
|---|---|---|
| data-PBFPubKey | true | Your merchant public key provided when you create a button. |
| data-integrity_hash | true | This is a Sha256 hash of your getpaidSetup values, it is used for passing secure values to the payment gateway. |
| data-txref | true | Unique transaction reference provided by the merchant. |
| data-payment_options | false | This allows you select the payment option you want for your users, possible values are card, account or both. |
| data-payment_plan | false | This is the payment plan ID used for Recurring billing ]. |
| data-subaccounts | false | This is an array of objects containing the subaccount IDs to split the payment into. |
| data-amount | true | Amount to charge. |
| data-currency | false | defaults to NGN currency to charge the card in. |
| data-country | false | defaults to NG route country. |
| data-customer_email | true | Email of the customer. |
| data-customer_phonenumber | true | phone number of the customer. |
| data-customer_firstname | false | firstname of the customer. |
| data-customer_lastname | false | lastname of the customer. |
| data-pay_button_text | false | Text to the on the Rave Checkout Button. |
| data-custom_title | false | Text to be displayed as the title of the payment modal. |
| data-custom_description | false | Text to be displayed as a short modal description. |
| data-redirect_url | false | URL to redirect to when the transaction is completed. |
| data-custom_logo | false | Link to the Logo image. |
| data-meta-[custom_param] | false | Any other custom data you wish to pass. |
Updated over 6 years ago
Next Steps