Quidpay Charge Parameters

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

Card Charge Parameters

Parameter	Required	Description
`PBFPubKey`	True	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`.
`cardno`	True	This is the number on the cardholders card. E.g. 5399 6701 2349 0229.
`cvv`	True	This is the 3-digit number at the back of the card.
`expirymonth`	True	This is the month of card expiration as written on a cardholder’s card. Format is ‘MM’.
`expiryyear`	True	This is the year of card expiration on as written on a cardholder’s card. Format is ‘YY’.
`currency`	False `(Defaults to NGN)`	This is the specified currency to charge the card in.
`country`	False `(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 ]
`pin`	False `(Used only for transactions that require PIN)`	This is the pin issued to the customer for his card.
`suggested_auth`	False `(Default value: PIN)`	this is an identifier to show that the suggested authentication model is being used.
`amount`	True	This is the amount to be charged from card it is passed as - (“amount”:10).
`email`	True	This is the email address of the customer.
`phonenumber`	True	This is the phone number of the customer.
`firstname`	True	This is the first name of the card holder or the customer.
`lastname`	True	This is the last name of the card holder or the customer.
`IP`	True	IP - Internet Protocol. This represents the current IP address of the customer carrying out the transaction.
`txRef`	True	This is the unique reference, unique to the particular transaction being carried out. It is generated by the merchant for every transaction
`device_fingerprint`	False	This is the fingerpringt for the device being used. It can be generated using a library on whatever platform is being used.
`charge_type`	False `(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

Parameter	Required	Description
`PBFPubKey`	True	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`.
`accountnumber`	True	This is the account number of the customer associated with a valid bank account.
`accountbank`	True	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 API
`currency`	False `(Defaults to NGN)`	This is the specified currency to charge the account in.
`country`	False `(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 ]
`amount`	False	This is the amount to be charged from the account it is passed as - (“amount”:10).
`email`	True	This is the email address of the customer.
`phonenumber`	True	This is the phone number of the customer.
`firstname`	false	This is the first name of the account holder or the customer.
`lastname`	false	This is the last name of the account holder or the customer.
`IP`	True	IP - Internet Protocol. This represents the current IP address of the customer carrying out the transaction.
`txRef`	True	This is the unique reference, unique to the particular transaction being carried out. It is generated by the merchant for every transaction.
`payment_type`	True `(Expected value: account)`	This specifies that the payment method being used is for account payments
`device_fingerprint`	False	This is the fingerpringt for the device being used. It can be generated using a library on whatever platform is being used.

Recurring Billing Parameters

Parameter	Required	Description
`PBFPubKey`	True	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`.
`cardno`	True	This is the number on the cardholders card. E.g. 5399 6701 2349 0229.
`cvv`	True	This is the 3-digit number at the back of the card.
`expirymonth`	True	This is the month of card expiration as written on a cardholder’s card. Format is ‘MM’.
`expiryyear`	True	This is the year of card expiration on as written on a cardholder’s card. Format is ‘YY’.
`currency`	False `(Defaults to NGN)`	This is the specified currency to charge the card in.
`country`	False `(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 ]
`pin`	False `(Used only for transactions that require PIN)`	This is the pin issued to the customer for his card.
`suggested_auth`	False `(Default value: PIN)`	this is an identifier to show that the suggested authentication model is being used.
`amount`	True	This is the amount to be charged from card it is passed as - (“amount”:10).
`email`	True	This is the email address of the customer.
`phonenumber`	False	This is the phone number of the customer.
`firstname`	False	This is the first name of the card holder or the customer.
`lastname`	False	This is the last name of the card holder or the customer.
`IP`	True	IP - Internet Protocol. This represents the current IP address of the customer carrying out the transaction.
`txRef`	True	This is the unique reference, unique to the particular transaction being carried out. It is generated by the merchant for every transaction.
`device_fingerprint`	False	This is the fingerpringt for the device being used. It can be generated using a library on whatever platform is being used.
`charge_type`	True	This 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_plan`	True	This is the payment plan ID to use for the recurring payment, you can see how to create payment plans here

Updated less than a minute ago