Payment-methods
Check saved payment method status
Check whether saved payment methods exist and a default is configured.
/api/v1/payment-methods/presence- Authentication
- OAuth 2.0 access token
- Required scopes
payment_methods.read- Idempotency key
- Not required
- Rate-limit cost
- 2 units
How to use this endpoint
Requires the separate payment_methods.read permission, current filer-management permission and access to all filers. Existing authorizations are not automatically expanded. Public registrations that predate this scope need a new registration and human consent; private integrations must obtain approval and consent for the added scope.
Returns up to 50 method kinds, active/archive states and default markers with a partial flag. No payment IDs, numbers, billing addresses or provider credentials are returned. This read cannot charge or change a method.
curl --request GET 'https://api.efilemagic.com/api/v1/payment-methods/presence' \
--header 'Authorization: Bearer <access-token>'Replace placeholders with your own values. Use the API resource origin provided for your environment.
Request fields
0 fieldsNo request fields are required.
Headers (1)
AuthorizationRequired- OAuth Bearer token with current resource authorization and the required scopes.
curl --request GET 'https://api.efilemagic.com/api/v1/payment-methods/presence' \
--header 'Authorization: Bearer <access-token>'Replace placeholders with your own values. Use the API resource origin provided for your environment.
On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.
Response fields
3 fieldsdefault_configuredAlways returnedboolean
Type: boolean.
methodsAlways returnedarray<object>
Maximum items: 50.
Nested fields (3)
kindAlways returnedstring
Allowed values: "credit_card", "bank_account_ach".
selected_defaultAlways returnedboolean
Type: boolean.
statusAlways returnedstring
Allowed values: "active", "archived".
partialAlways returnedboolean
Type: boolean.
{
"data": {
"default_configured": "boolean",
"methods": "array<object>",
"partial": "boolean"
},
"meta": {
"api_version": "v1",
"request_id": "string"
}
}Successful response structure. This outline shows field types, not a response to copy. Expand Response fields for nested properties and optional values.
Errors to handle
Errors use {error: {code, message}, meta}. Check the code and message before retrying. Authentication, validation and availability errors can occur before the operation runs.
- 400
invalid_request - Check required fields, selectors and supported values.
- 401
invalid_token - Obtain a valid OAuth token for this resource. Check its expiry and current authorization.
- 403
insufficient_scope - Request the listed scopes through the application's authorization flow.
- 403
forbidden - Check the connection's permissions and allowed filers. More scopes alone may not grant access.
- 404
not_found - Check the resource ID and its owning filer. Batch reads report missing IDs as documented.
- 422
validation_failed - Correct the reported validation issues before retrying.
- 429
rate_limited - Wait for Retry-After before retrying. Avoid concurrent retries.
- 500
internal_error - Retain request_id; retry with bounded backoff.
- 503
service_unavailable - Retry with bounded backoff.