Paywall.app API Documentation

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

URL: https://team.paywall.app/quickcheckout/YOUR-ACCOUNT-ID/

Parameters

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.

cancel_url

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.

Example POST Response

{
  "team_id": "1",
  "name": "John Smith",
  "email": "customer@example.com",
  "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"
  }
}