API Documentation

Welcome to the API documentation. Here you will find all the details you need to integrate and use our payment processing capabilities.

Quick Checkout API

The Quick Checkout API allows you to quickly integrate payment processing into your application. Below are the details for the API endpoints and their parameters.

API Endpoint



amount Required
Total Amount to be collected. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00).
currency Required
Three-letter ISO currency code, in lowercase. Must be a supported currency (e.g., usd or dop).
success_url Optional
The URL where you would like to redirect the user after a payment is successful.
success_post_url Optional
The endpoint on your application where you would like to receive a POST after a successful payment is completed.
The URL where you would like to redirect the user after a payment is canceled.
name Optional
Customer Name.
email Optional
Customer Email.
phone Optional
Customer Phone.
sub_total Optional
Sub Total Amount.
shipping_amount Optional
Shipping Amount.
tax_amount Optional
Tax Amount.
order_id Optional
The number or ID of your order.

Test Card Numbers

To simulate successful payments, use the test cards from the following list. The billing country for each test card is set to the United States.

BrandNumberCVCExpiry Date
Visa4242424242424242Any 3 digitsAny future date
Visa (debit)4000056655665556Any 3 digitsAny future date
Mastercard5555555555554444Any 3 digitsAny future date
American Express378282246310005Any 4 digitsAny future date

Example POST Response

  "team_id": "1",
  "name": "John Smith",
  "email": "",
  "phone": "13051234567",
  "order_id": "ABC1001",
  "token": "",
  "account_id": "acct_xxxxxxxxxxxxxxxx",
  "payment_intent": {
    "id": "pi_3MN60bITWiIE2bdDfrsghtFd",
    "object": "payment_intent",
    "amount": "10000", // Amount paid in cents
    "currency": "usd", // Currency code, usd, dop, cad, eur
    "description": "Quick Pay - Demo Company",
    "status": "succeeded"

Frequently asked questions

If you have any questions or concerns, please reach out to our support team for assistance.

    • Does PayWall handle VAT or taxes?

      No, PayWall does not handle VAT or taxes at this time. You will need to manage them on your own.

    • Does PayWall have a monthly fee?

      No, PayWall is free to use. You only pay a transaction fee when you receive a payment.

    • Can I have multiple PayWall accounts?

      Yes, you can have multiple PayWall accounts. You can use different PayWall accounts for different purposes or businesses.

    • What is the maximum amount I can charge using PayWall?

      The maximum amount you can charge per transaction is US$50,000.

    • When will I receive funds in my bank account?

      For US customers, we will transfer the funds to your bank account within 2 business days after the payment is completed. For international customers, transfers are made within 7 business days after the payment is completed.

    • What is the maximum amount I can charge per month?

      Regular accounts can charge up to US$500,000 monthly, while business accounts have no limitations.

    • What type of payment methods can I accept?

      Currently, PayWall supports Visa, MasterCard, American Express, Discover, Apple Pay, and Google Pay.

    • Can I integrate PayWall with my accounting software?

      If your application has an API, we can integrate PayWall with your accounting software. Please contact us to discuss further.

    • I lost my password. How can I access my account?

      You can reset your password by clicking on the “Forgot Password” link on the login page. Enter your email address, and we will send you an email with a link to reset your password.

    • Do I need a US bank account to use PayWall?

      PayWall is currently available in 47 countries. For the most recent list of supported countries, please contact us. If you do have a US bank account, you can still use PayWall regardless of your location.