get
https://connect.agendapro.com/v3/payment_methods
Lists the payment methods you can use to record an external payment with POST /v3/carts/{id}/transactions. Send the id and type of an element as payment_method.
Important Notes
- Requires
payment_methods:readscope. - Each element has the same shape as
payment_methodinGET /v3/sales/{id}. - General methods (
type: PaymentMethod) come first, in this order: cash, credit card, debit card, check, wire transfer, other. - The company's own active payment methods (
type: CompanyPaymentMethod) follow, ordered by name. - Ids differ between companies and between environments (staging and production). Read them from this endpoint; never write them into your code.
- The list is not paginated.
Errors Dictionary
| Status | Error | Detail | Description |
|---|---|---|---|
| 401 | unauthorized | invalid_api_key | Missing or invalid Bearer token. |
| 401 | unauthorized | api_config_inactive | API access is inactive for this company. |
| 403 | forbidden | scope_denied | API key lacks payment_methods:read scope. |
| 429 | rate_limited | burst_limit_exceeded | Per-minute request limit exceeded. |
| 429 | rate_limited | daily_quota_exceeded | Daily request quota exceeded. |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…