Paynote API — Quick-Start
Paynote makes it easy to move money with just three simple steps: create a customer, connect their bank account, and send or receive a payment. You can process ACH debits, credits, recurring payments, or just save bank info for later. Use our drop-in Checkout.js tool for a fast, all-in-one setup—or use our REST API for full control over the experience. You’ll get real-time updates via webhooks and a sandbox environment to test everything before going live.
Paynote API — Quick-Start
The three-step pattern: create a customer → add a funding source → move money.
Click any link to jump to the full reference.
1. Create a Customer
Call POST /customers
with the customer’s name, email, and phone.
The response returns a customer_id
you’ll reuse everywhere else.
curl -X POST https://api.paynote.io/v1/customers \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"name":"Acme Inc.","email":"[email protected]","phone":"555-123-4567"}'
2. Add a Funding Source
Choose the verification flow that fits your user experience:
Method | Best for | Reference |
---|---|---|
Plaid Instant Verification | Fastest conversion (user logs in with bank credentials) | add-via-plaid-instant-verification |
Automated Micro-Deposits | Plaid fallback; user confirms two micro-deposits | create-funding-source |
Plaid Processor Token | You already captured a Plaid token elsewhere | add-funding-source-via-processor-token |
Manual Routing & Account # | You handle your own KYC and just need tokenization | create-3rd-party-funding-source |
Each call returns a source_id
.
Using Checkout.js?
The drop-in Plaid modal inCheckout.js
creates both the customer and verified funding source in one step.
3. Move Money
All transfers use POST /payments
; set the type
field to control behavior:
Payment | type value | When to use | Reference |
---|---|---|---|
Direct Debit | ach_debit | Pull funds from the customer (checkout, invoice) | create-ach-direct-debit |
Direct Credit | ach_credit | Push funds to the customer (payouts, refunds) | create-ach-direct-credit |
RTP Credit | rtp_credit | Real-time payout to RTP-enabled banks | |
Subscription | subscription | Recurring charge on a schedule | create-subscription |
Authorization Only | authorization | Save bank details now, charge later |
curl -X POST https://api.paynote.io/v1/payments \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"customer_id":"cust_123",
"source_id":"src_456",
"type":"ach_debit",
"amount":"250.00",
"currency":"USD",
"description":"Order #9876"
}'
More payment tools
- Recurring invoices —
create-recurring-invoice
- Refunds —
create-a-refund
Webhook Events
Get real-time status updates with the Webhook guide.
Environment Setup
- Sandbox keys for testing
- Production keys for live traffic
For help email [email protected].
Updated 1 day ago