Overview

Sources represent payment methods stored for customers. They can be credit cards, bank accounts, or other payment types supported by your payment gateway. Sources are used to charge customers for subscriptions and one-time purchases.

How It Works

Collect payment details - Customer enters card information via your checkout
Tokenize securely - Payment details are tokenized by the payment gateway
Create source - The token is saved as a source attached to the customer
Charge the source - Future payments use the stored source

Example: A customer enters their Visa card during checkout. The card is tokenized by Stripe, stored as a source, and used to pay for their monthly subscription automatically.

API Endpoints

Method	Endpoint	Description
`GET`	`/api/v1/core/sources`	List all sources
`POST`	`/api/v1/core/sources`	Create a source
`GET`	`/api/v1/core/sources/{id}`	Get a source
`DELETE`	`/api/v1/core/sources/{id}`	Delete a source

Source Statuses

Status	Description
`chargeable`	Source can be used for payments
`pending`	Source is being verified
`consumed`	Source has been used (for single-use sources)
`canceled`	Source has been canceled
`failed`	Source verification failed

Note: Only sources with chargeable status can process payments.

Supported Gateways

Gateway	Description
`Stripe`	Primary payment processor
`Tap`	Middle East payment gateway
`Vantiv`	Enterprise payment processing
`PayPal`	PayPal payments

Source Object

Attribute	Type	Description
`id`	integer	Unique identifier for the source
`object_gateway`	string	Payment gateway (stripe, tap, vantiv, etc.)
`object_id`	string	Payment gateway's token/source ID
`brand`	string	Card brand (Visa, Mastercard, Amex, etc.)
`last4`	string	Last 4 digits of the card
`exp_month`	integer	Card expiration month (1-12)
`exp_year`	integer	Card expiration year (4-digit)
`cvc_check`	string	CVC verification result
`address_zip_check`	string	Postal code verification result
`address_line1_check`	string	Address line 1 verification result
`funding`	string	Card funding type: `credit`, `debit`, `prepaid`
`country`	string	Two-letter ISO country code of card issuer
`fingerprint`	string	Unique card fingerprint for duplicate detection
`three_d_secure`	string	3D Secure status
`name`	string	Cardholder name
`tokenization_method`	string	How card was tokenized (apple_pay, google_pay, etc.)
`dynamic_last4`	string	Dynamic last 4 digits (for mobile wallets)
`user`	object	Customer object (expandable)

Related Endpoints

Customers - Customers who own sources
Charges - Payments made using sources
Subscriptions - Subscriptions charged to sources