List payment methods
Scope: sales:invoicing-settings.read https://api.alladdin.com/api/v2/payment-methods
Returns all payment methods configured for the account, including both manual methods (bank transfer, cash on delivery, cheque) and online connected providers (Stripe, PayPal, GoCardless, Square, Monei, Wallet). Use when the user asks which payment methods they have set up or how they collect payments from customers. Different from the payments endpoint which returns individual transactions — this returns the configured methods themselves.
Parameters
Query parameters
cursor string optional
Opaque cursor for pagination. Pass the value returned in the previous response to fetch the next page.
limit integer optional = 50
Maximum number of payment methods to return per page. Defaults to 50, maximum 200.
Request
import requests
url = "https://api.alladdin.com/api/v2/payment-methods?cursor=value&limit=50"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
response = requests.get(url, headers=headers)
print(response.json())Responses
Response
{
"items": [
{
"id": "507f1f77bcf86cd799439011",
"name": "string",
"type": "manual",
"status": "connected",
"isDefault": false,
"bankingAccountId": "507f1f77bcf86cd799439011",
"dueDays": 0,
"connectionId": "507f1f77bcf86cd799439011"
}
],
"cursor": "string",
"has_more": false
}Success responses
200 List of payment methods application/json object items[] object[] required id string required
Unique identifier of the payment method
name string required
Display name of the payment method
type string required
Discriminator for the payment method kind: 'manual' for manually created methods, or the provider slug for connected gateways (stripe, paypal, gocardless, square, monei, wallet)
Enum: manual stripe paypal gocardless square monei wallet status string required
Current status of the payment method: 'connected' means active and usable. Online gateways may also have disconnected, access_denied, verification_required, or verification_in_review.
Enum: connected disconnected access_denied verification_required verification_in_review isDefault boolean required
Whether this method is the account default for online payments
bankingAccountId string | null required
Associated banking account ID, if configured
dueDays integer | null required
Number of days until payment is due (manual methods only)
connectionId string | null required
Gateway connection identifier (online methods only)
cursor string | null optional has_more boolean required
Error responses
401 Invalid or missing API key application/json 403 Insufficient permissions application/json 429 Rate limit exceeded application/json