--- agentTools: projectIndex: https://docs.quidpay.io/llms.txt --- # Quidpay Charge Parameters Describes all parameters that can be passed when charging cards or accounts using quidpay's APIs # Card Charge Parameters [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Required", "h-2": "Description", "0-0": "`PBFPubKey`", "0-1": "True", "0-2": "This is a unique key generated for each button created on Quidpay’s dashboard. It starts with a prefix `FLWPUBK` and ends with suffix `X`.", "1-0": "`cardno`", "1-2": "This is the number on the cardholders card. E.g. 5399 6701 2349 0229.", "1-1": "True", "2-0": "`cvv`", "2-1": "True", "2-2": "This is the 3-digit number at the back of the card.", "3-0": "`expirymonth`", "3-1": "True", "3-2": "This is the month of card expiration as written on a cardholder’s card. Format is ‘MM’.", "4-1": "True", "4-0": "`expiryyear`", "4-2": "This is the year of card expiration on as written on a cardholder’s card. Format is ‘YY’.", "5-0": "`currency`", "5-1": "False\n`(Defaults to NGN)`", "5-2": "This is the specified currency to charge the card in.", "6-0": "`country`", "6-1": "False\n`(Defaults to NG)`", "6-2": "This is the pair country for the transaction with respect to the currency. See a list of Multicurrency support here [Multicurrency Payments](https://docs.quidpay.io/docs/multicurrency-payments) ]", "7-0": "`pin`", "7-1": "False\n`(Used only for transactions that require PIN)`", "7-2": "This is the pin issued to the customer for his card.", "8-0": "`suggested_auth`", "8-1": "False\n`(Default value: PIN)`", "8-2": "this is an identifier to show that the suggested authentication model is being used.", "9-0": "`amount`", "9-1": "True", "9-2": "This is the amount to be charged from card it is passed as - (“amount”:10).", "10-0": "`email`", "10-1": "True", "10-2": "This is the email address of the customer.", "11-0": "`phonenumber`", "11-1": "True", "11-2": "This is the phone number of the customer.", "12-0": "`firstname`", "12-1": "True", "12-2": "This is the first name of the card holder or the customer.", "13-0": "`lastname`", "13-1": "True", "13-2": "This is the last name of the card holder or the customer.", "14-0": "`IP`", "14-1": "True", "14-2": "IP - Internet Protocol. This represents the current IP address of the customer carrying out the transaction.", "15-0": "`txRef`", "15-1": "True", "15-2": "This is the unique reference, unique to the particular transaction being carried out. It is generated by the merchant for every transaction", "16-0": "`device_fingerprint`", "16-1": "False", "16-2": "This is the fingerpringt for the device being used. It can be generated using a library on whatever platform is being used.", "17-0": "`charge_type`", "17-1": "False\n`(Used for preauthorised transactions)`", "17-2": "This identifies that you are making a `preauthorised` payment request call to the charge endpoint by passing the value preauth. It should be built with your payment request only when carrying out a preauthorised transaction." }, "cols": 3, "rows": 18 } [/block] # Account Charge Parameters [block:callout] { "type": "warning", "body": "This only applies to Nigeria", "title": "Account charge for Nigeria" } [/block] [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Required", "h-2": "Description", "0-0": "`PBFPubKey`", "0-1": "True", "0-2": "This is a unique key generated for each button created on Quidpay’s dashboard. It starts with a prefix `FLWPUBK` and ends with suffix `X`.", "1-0": "`accountnumber`", "1-1": "True", "1-2": "This is the account number of the customer associated with a valid bank account.", "2-0": "`accountbank`", "2-1": "True", "2-2": "This is a bank code that represents the bank account to be debited. To get a list of banks in Nigeria, call the [List of Banks](https://docs.quidpay.io/reference/list-of-banks) API", "3-0": "`currency`", "3-1": "False\n`(Defaults to NGN)`", "3-2": "This is the specified currency to charge the account in.", "4-0": "`country`", "4-1": "False\n`(Defaults to NG)`", "4-2": "This is the pair country for the transaction with respect to the currency. See a list of Multicurrency support here [Multicurrency Payments](https://docs.quidpay.io/docs/multicurrency-payments) ]", "5-0": "`amount`", "5-1": "False", "5-2": "This is the amount to be charged from the account it is passed as - (“amount”:10).", "6-0": "`email`", "6-2": "This is the email address of the customer.", "6-1": "True", "7-0": "`phonenumber`", "7-1": "True", "7-2": "This is the phone number of the customer.", "8-0": "`firstname`", "8-1": "false", "8-2": "This is the first name of the account holder or the customer.", "9-0": "`lastname`", "9-1": "false", "9-2": "This is the last name of the account holder or the customer.", "10-0": "`IP`", "10-1": "True", "10-2": "IP - Internet Protocol. This represents the current IP address of the customer carrying out the transaction.", "11-0": "`txRef`", "11-1": "True", "11-2": "This is the unique reference, unique to the particular transaction being carried out. It is generated by the merchant for every transaction.", "12-0": "`payment_type`", "12-1": "True\n`(Expected value: account)`", "12-2": "This specifies that the payment method being used is for account payments", "13-0": "`device_fingerprint`", "13-1": "False", "13-2": "This is the fingerpringt for the device being used. It can be generated using a library on whatever platform is being used." }, "cols": 3, "rows": 14 } [/block] # Recurring Billing Parameters [block:parameters] { "data": { "0-0": "`PBFPubKey`", "0-2": "This is a unique key generated for each button created on Quidpay’s dashboard. It starts with a prefix `FLWPUBK` and ends with suffix `X`.", "1-0": "`cardno`", "1-2": "This is the number on the cardholders card. E.g. 5399 6701 2349 0229.", "2-0": "`cvv`", "2-2": "This is the 3-digit number at the back of the card.", "3-0": "`expirymonth`", "3-2": "This is the month of card expiration as written on a cardholder’s card. Format is ‘MM’.", "4-0": "`expiryyear`", "4-2": "This is the year of card expiration on as written on a cardholder’s card. Format is ‘YY’.", "5-0": "`currency`", "5-2": "This is the specified currency to charge the card in.", "6-0": "`country`", "6-2": "This is the pair country for the transaction with respect to the currency. See a list of Multicurrency support here [Multicurrency Payments](https://docs.quidpay.io/docs/multicurrency-payments) ]", "7-0": "`pin`", "7-2": "This is the pin issued to the customer for his card.", "8-0": "`suggested_auth`", "8-2": "this is an identifier to show that the suggested authentication model is being used.", "9-0": "`amount`", "9-2": "This is the amount to be charged from card it is passed as - (“amount”:10).", "10-0": "`email`", "10-2": "This is the email address of the customer.", "11-0": "`phonenumber`", "11-2": "This is the phone number of the customer.", "12-0": "`firstname`", "13-0": "`lastname`", "14-0": "`IP`", "15-0": "`txRef`", "16-0": "`device_fingerprint`", "17-0": "`charge_type`", "18-0": "`payment_plan`", "18-2": "This is the payment plan ID to use for the recurring payment, you can see how to create payment plans [here](https://docs.quidpay.io/docs/recurring-billing)", "12-2": "This is the first name of the card holder or the customer.", "13-2": "This is the last name of the card holder or the customer.", "14-2": "IP - Internet Protocol. This represents the current IP address of the customer carrying out the transaction.", "15-2": "This is the unique reference, unique to the particular transaction being carried out. It is generated by the merchant for every transaction.", "16-2": "This is the fingerpringt for the device being used. It can be generated using a library on whatever platform is being used.", "17-2": "This helps identify the frequency of the recurring debit it can be set to the follow possible values:\n\n```\nrecurring-daily, recurring-weekly, recurring-monthly, recurring-quarterly, recurring-bianually, recurring-anually\n```", "0-1": "True", "1-1": "True", "2-1": "True", "3-1": "True", "4-1": "True", "5-1": "False\n`(Defaults to NGN)`", "6-1": "False\n`(Defaults to NG)`", "7-1": "False\n`(Used only for transactions that require PIN)`", "8-1": "False\n`(Default value: PIN)`", "9-1": "True", "10-1": "True", "11-1": "False", "12-1": "False", "13-1": "False", "14-1": "True", "15-1": "True", "16-1": "False", "17-1": "True", "18-1": "True", "h-0": "Parameter", "h-1": "Required", "h-2": "Description" }, "cols": 3, "rows": 19 } [/block]