E-File Magic

Payment-methods

Check saved payment method status

Check whether saved payment methods exist and a default is configured.

GET
/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

On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.

Response fields

3 fields
default_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.

Complete response schema: ApiPaymentMethodPresence

Structure · HTTP 200
{
  "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.