Card Charge
Use the Charge API to initiate a new payment instead of using this method. Confirmation of the PaymentIntent creates the Charge object used to request payment, so this method is limited to legacy integrations.
Create A Charge
We recommend using our recommended payments integrations to perform the tokenization process client-side. This ensures that no sensitive card data touches your server and allows your integration to operate in a PCI-compliant way. By using client-side tokenization, you benefit from the following:
- You need to tokenize the charge object before sending it to Axxonpay's Charge API.
- You can refer to the tokenization page to handle the tokenization aspect by either using the Client Tokenization method or the Token API.
POST /v1/process/card-payment
const axios = require('axios');
const data = {
// Add your request body data here
token: tokenized,
};
const headers = {
signature: 'sig_<Your-Signature>',
authorization: 'key_<Your-Key>'
};
// Make the POST request
const response = await axios.post('https://<axxonpay-url-gateway>/v1/process/card-payment', data, { headers });
Parameters
Parameter | Required/Optional | Type | Description |
---|---|---|---|
amount | REQUIRED | Number | Amount intended to be collected by this Charge. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). |
currency | REQUIRED | String | Three-letter ISO currency code, in lowercase. Must be a supported currency. |
customer_id | OPTIONAL | String | ID of the Customer this Charge belongs to, if one exists. Payment methods attached to other Customers cannot be used with this Charge. If present in combination with setup_future_usage, this Charge's payment method will be attached to the Customer after the Charge has been confirmed and any required actions from the user are complete. |
description | OPTIONAL | String | An arbitrary string attached to the object. Often useful for displaying to users. |
return_url | REQUIRED | String | REQUIRED IN CASE 3DS IS REQUESTED |
cardNumber | REQUIRED | Number | Number of the card used for the charge. |
expMonth | REQUIRED | String | Expiration month of the card used for the charge. |
expYear | REQUIRED | String | Expiration year of the card used for the charge. |
cvc | REQUIRED | String | Card verification code used for the charge. |
line1 | REQUIRED | String | First line of the address associated with the card used for the charge. |
line2 | REQUIRED | String | Second line of the address associated with the card used for the charge. |
postal_code | REQUIRED | String | Postal code of the address associated with the card used for the charge. |
city | REQUIRED | String | City of the address associated with the card used for the charge. |
country | REQUIRED | String | Country of the address associated with the card used for the charge. |
REQUIRED | String | Email address of the customer associated with the charge. | |
name | REQUIRED | String | Name of the customer associated with the charge. |
state | REQUIRED | String | State of the address associated with the card used for the charge. |
remote_ip | REQUIRED | String | IP address of the customer making the charge. |
Testing Cards
You can mimic a successful or failed charge by first creating a token with one of the following test IBAN account numbers. Use the charge request to create a test charge that is either successful or failed.
BRAND | NUMBER | CVC | DATE |
---|---|---|---|
Visa | 4242424242424242 | Any 3 digits | Any future date |
Visa (debit) | 4000056655665556 | Any 3 digits | Any future date |
Mastercard | 5555555555554444 | Any 3 digits | Any future date |
Mastercard (2-series) | 2223003122003222 | Any 3 digits | Any future date |
Mastercard (debit) | 5200828282828210 | Any 3 digits | Any future date |
Mastercard (prepaid) | 5105105105105100 | Any 3 digits | Any future date |
American Express | 378282246310005 | Any 4 digits | Any future date |
American Express | 371449635398431 | Any 4 digits | Any future date |
Discover | 6011111111111117 | Any 3 digits | Any future date |
Discover | 6011000990139424 | Any 3 digits | Any future date |
Discover (debit) | 6011981111111113 | Any 3 digits | Any future date |
Diners Club | 3056930009020004 | Any 3 digits | Any future date |
Diners Club (14-digit card) | 36227206271667 | Any 3 digits | Any future date |
BCcard and DinaCard | 6555900000604105 | Any 3 digits | Any future date |
JCB | 3566002020360505 | Any 3 digits | Any future date |
UnionPay | 6200000000000005 | Any 3 digits | Any future date |
UnionPay (debit) | 6200000000000047 | Any 3 digits | Any future date |
UnionPay (19-digit card) | 6205500000000000004 | Any 3 digits | Any future date |