Payment page requirements
Your payment page must include all required information.
Requirements for credit card payment pages
For credit card payments, it’s important that you gather the appropriate cardholder details in your payment form. Cardholder details fall into one or more of the following categories:
- Required for successful transaction. These fields are required for every transaction. If you omit them, your transactions will fail.
- Required payment field for merchants. These fields are in the default list of required payment fields for merchants. Each merchant can customize their own list in the AffiniPay web application. To see the list of required payment fields for a merchant, send a GET request to the https://api.affinipay.com/api/v1/merchant endpoint.
- Required payment field for partners. These fields are in the default list of required payment fields for partners. When policies are enabled for a partner and a merchant makes a payment through the partner’s application, these required fields override the required fields set in the merchant’s account.
- Optional. This information makes it easier to contact a cardholder if there are transaction issues.
| Cardholder data | Why collect it? |
|---|---|
| card number | Required for successful transaction (On a hosted fields form, this must be a hosted field.) |
| card expiration | Required for successful transaction. |
| card CVV | Required payment field for merchants; required payment field for partners; not required when saving a card. (On a hosted fields form, this must be a hosted field.) Collecting CVV helps prevent fraud and reduce the probability of chargebacks. If you don’t collect CVV and the cardholder disputes a charge, the chargeback committee will likely rule in favor of the cardholder and return funds. |
| cardholder name | Optional. If you’re using an external system to manage customers, be sure to map the “name” field in that system to the name property on card objects in the AffiniPay system; otherwise, transactions will show up in the AffiniPay system without a name. |
| Optional | |
| address 1 | Required payment field for merchants. If you don’t submit this information, you may not get the best processing rate. |
| address 2 | Optional |
| city | Optional |
| state | Optional |
| postal code | Required payment field for merchants; required payment field for partners (for manually-keyed transactions). If you don’t submit this information, you may not get the best processing rate. |
| country | Optional |
| phone | Optional |
See the token object type for parameter names and descriptions of these fields.
Requirements for eCheck payment pages
Electronic check (eCheck) payments move funds electronically between banks using routing and account numbers.
Check whether the merchant can take eCheck payments
Before a merchant can take eCheck payments in your application, they must be eCheck-enabled. To verify that a merchant can take eCheck payments, send a GET request to the https://api.affinipay.com/api/v1/merchant endpoint.
- If the ach_accounts section contains one or more accounts, the merchant is enabled for eCheck.
- If the ach_accounts section does not contain any accounts, the merchant is not enabled for eCheck. Direct them to the appropriate web application, where the business owner can enable eCheck.
- For AffiniPay: https://secure.affinipay.com/login
- For ClientPay: https://secure.clientpay.com/login
- For CPACharge: https://secure.cpacharge.com/login
- For LawPay: https://secure.lawpay.com/login
Include all required information on the payment page
it’s important that you gather the appropriate cardholder details in your payment form.
| eCheck account holder data | Why collect it? |
|---|---|
| account holder type | Required for successful transaction (business or individual) |
| name | Required for successful transaction (for business account holder type only) |
| given name | Required for successful transaction (for individual account holder type only) |
| surname | Required (for individual account holder type only) |
| routing number | Required for successful transaction (On a hosted fields form, this must be a hosted field.) |
| account number | Required for successful transaction (On a hosted fields form, this must be a hosted field.) |
| account type | Required for successful transaction |
See the token object type for parameter names and descriptions of these fields.
In addition, you must include the following text (with <Merchant Name> replaced with the name of the Merchant) above the Submit button:
By clicking “Submit Payment”, I am authorizing <Merchant Name> to initiate a single or recurring ACH/electronic debit in the amount indicated from the bank account I designated above. I understand that this Authorization will remain in full force and effect until the transaction is cancelled by me by contacting <Merchant Name>, or the ACH/electronic debit is processed from the designated account. I certify that (1) I am authorized to debit the bank account above and (2) the ACH/electronic payment I am authorizing complies with all applicable laws.