Quidpay Charge Parameters

Describes all parameters that can be passed when charging cards or accounts using quidpay's APIs

Card Charge Parameters

ParameterRequiredDescription
PBFPubKeyTrueThis is a unique key generated for each button created on Quidpay’s dashboard. It starts with a prefix FLWPUBK and ends with suffix X.
cardnoTrueThis is the number on the cardholders card. E.g. 5399 6701 2349 0229.
cvvTrueThis is the 3-digit number at the back of the card.
expirymonthTrueThis is the month of card expiration as written on a cardholder’s card. Format is ‘MM’.
expiryyearTrueThis is the year of card expiration on as written on a cardholder’s card. Format is ‘YY’.
currencyFalse
(Defaults to NGN)
This is the specified currency to charge the card in.
countryFalse
(Defaults to NG)
This is the pair country for the transaction with respect to the currency. See a list of Multicurrency support here Multicurrency Payments ]
pinFalse
(Used only for transactions that require PIN)
This is the pin issued to the customer for his card.
suggested_authFalse
(Default value: PIN)
this is an identifier to show that the suggested authentication model is being used.
amountTrueThis is the amount to be charged from card it is passed as - (“amount”:10).
emailTrueThis is the email address of the customer.
phonenumberTrueThis is the phone number of the customer.
firstnameTrueThis is the first name of the card holder or the customer.
lastnameTrueThis is the last name of the card holder or the customer.
IPTrueIP - Internet Protocol. This represents the current IP address of the customer carrying out the transaction.
txRefTrueThis is the unique reference, unique to the particular transaction being carried out. It is generated by the merchant for every transaction
device_fingerprintFalseThis is the fingerpringt for the device being used. It can be generated using a library on whatever platform is being used.
charge_typeFalse
(Used for preauthorised transactions)
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.

Account Charge Parameters

🚧

Account charge for Nigeria

This only applies to Nigeria

ParameterRequiredDescription
PBFPubKeyTrueThis is a unique key generated for each button created on Quidpay’s dashboard. It starts with a prefix FLWPUBK and ends with suffix X.
accountnumberTrueThis is the account number of the customer associated with a valid bank account.
accountbankTrueThis 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 API
currencyFalse
(Defaults to NGN)
This is the specified currency to charge the account in.
countryFalse
(Defaults to NG)
This is the pair country for the transaction with respect to the currency. See a list of Multicurrency support here Multicurrency Payments ]
amountFalseThis is the amount to be charged from the account it is passed as - (“amount”:10).
emailTrueThis is the email address of the customer.
phonenumberTrueThis is the phone number of the customer.
firstnamefalseThis is the first name of the account holder or the customer.
lastnamefalseThis is the last name of the account holder or the customer.
IPTrueIP - Internet Protocol. This represents the current IP address of the customer carrying out the transaction.
txRefTrueThis is the unique reference, unique to the particular transaction being carried out. It is generated by the merchant for every transaction.
payment_typeTrue
(Expected value: account)
This specifies that the payment method being used is for account payments
device_fingerprintFalseThis is the fingerpringt for the device being used. It can be generated using a library on whatever platform is being used.

Recurring Billing Parameters

ParameterRequiredDescription
PBFPubKeyTrueThis is a unique key generated for each button created on Quidpay’s dashboard. It starts with a prefix FLWPUBK and ends with suffix X.
cardnoTrueThis is the number on the cardholders card. E.g. 5399 6701 2349 0229.
cvvTrueThis is the 3-digit number at the back of the card.
expirymonthTrueThis is the month of card expiration as written on a cardholder’s card. Format is ‘MM’.
expiryyearTrueThis is the year of card expiration on as written on a cardholder’s card. Format is ‘YY’.
currencyFalse
(Defaults to NGN)
This is the specified currency to charge the card in.
countryFalse
(Defaults to NG)
This is the pair country for the transaction with respect to the currency. See a list of Multicurrency support here Multicurrency Payments ]
pinFalse
(Used only for transactions that require PIN)
This is the pin issued to the customer for his card.
suggested_authFalse
(Default value: PIN)
this is an identifier to show that the suggested authentication model is being used.
amountTrueThis is the amount to be charged from card it is passed as - (“amount”:10).
emailTrueThis is the email address of the customer.
phonenumberFalseThis is the phone number of the customer.
firstnameFalseThis is the first name of the card holder or the customer.
lastnameFalseThis is the last name of the card holder or the customer.
IPTrueIP - Internet Protocol. This represents the current IP address of the customer carrying out the transaction.
txRefTrueThis is the unique reference, unique to the particular transaction being carried out. It is generated by the merchant for every transaction.
device_fingerprintFalseThis is the fingerpringt for the device being used. It can be generated using a library on whatever platform is being used.
charge_typeTrueThis helps identify the frequency of the recurring debit it can be set to the follow possible values:

recurring-daily, recurring-weekly, recurring-monthly, recurring-quarterly, recurring-bianually, recurring-anually
payment_planTrueThis is the payment plan ID to use for the recurring payment, you can see how to create payment plans here