Skip to content
Soljio Docs
Esc
↑↓navigate↵open⌘Jpreview

Get payment capabilities.

Get payment capabilities. An organization-scoped read using JSON filter arguments; requires payments.read. Pagination cursors must be reused only with the same organization, operation and filters.

POST/queries/get_payment_capabilities
Authorization
AuthorizationBearer token (soljio_sk_<secret>) · headerrequired

Organization-scoped service token created by an owner/admin. Scope requirements are in x-required-scopes; these are service-token grants, not OAuth scopes. Revoked, expired, unknown and suspended-organization credentials all return 401.

Request body
requiredapplication/json
object
Responses
200

Successful read.

dataobjectrequired
Show properties
charges_enabledbooleanrequired
connection_statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
disconnect_needs_retrybooleanrequired
last_synced_atstring<date-time>
onboarding_completedbooleanrequired
payouts_enabledbooleanrequired
required_actionsstring[]required
requirements_duenumberrequired
requires_attentionbooleanrequired
shows_dashboardbooleanrequired
transfers_applicablebooleanrequired
transfers_enabledbooleanrequired
request_idstring<uuid>required
400

invalid_request

errorobjectrequired
Show properties
codestringrequired
Allowed:invalid_request
messagestringrequired
request_idstring<uuid>required
401

unauthorized

errorobjectrequired
Show properties
codestringrequired
Allowed:unauthorized
messagestringrequired
request_idstring<uuid>required
403

forbidden

errorobjectrequired
Show properties
codestringrequired
Allowed:forbidden
messagestringrequired
request_idstring<uuid>required
404

not_found

errorobjectrequired
Show properties
codestringrequired
Allowed:not_found
messagestringrequired
request_idstring<uuid>required
405

method_not_allowed

errorobjectrequired
Show properties
codestringrequired
Allowed:method_not_allowed
messagestringrequired
request_idstring<uuid>required
409

conflict, idempotency_conflict

errorobjectrequired
Show properties
codestringrequired
Allowed:conflictidempotency_conflict
messagestringrequired
request_idstring<uuid>required
413

payload_too_large

errorobjectrequired
Show properties
codestringrequired
Allowed:payload_too_large
messagestringrequired
request_idstring<uuid>required
415

unsupported_media_type

errorobjectrequired
Show properties
codestringrequired
Allowed:unsupported_media_type
messagestringrequired
request_idstring<uuid>required
429

rate_limited

errorobjectrequired
Show properties
codestringrequired
Allowed:rate_limited
messagestringrequired
request_idstring<uuid>required
500

internal_error

errorobjectrequired
Show properties
codestringrequired
Allowed:internal_error
messagestringrequired
request_idstring<uuid>required
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST 'https://api.soljio.com/v0/queries/get_payment_capabilities' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{}'
Response
{
  "data": {
    "charges_enabled": true,
    "connection_status": "not_connected",
    "disconnect_needs_retry": true,
    "last_synced_at": "2019-08-24T14:15:22Z",
    "onboarding_completed": true,
    "payouts_enabled": true,
    "required_actions": [
      "string"
    ],
    "requirements_due": 0,
    "requires_attention": true,
    "shows_dashboard": true,
    "transfers_applicable": true,
    "transfers_enabled": true
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}