Skip to main content
GET
Get Cooperative Payment Settings

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Cooperative payment settings

cooperativePaymentSettingsId
string<uuid>
required

Settings identifier

Example:

"0197a817-1cc7-7d9c-9d74-8149674d0ef2"

organizationId
string<uuid>
required

Organization identifier

Example:

"0197a7f7-7291-7a43-96db-2c8580b80c5d"

cooperativeId
string<uuid>
required

Cooperative identifier

Example:

"0197a800-24e6-76a2-90ed-ff0f6fba7b0c"

externalProvider
string
required

External billing provider

Example:

"billing_interface"

externalAccountId
string
required

External account identifier

Example:

"acct_2c9f81b0"

status
enum<string>
required

Cooperative payment settings status

Available options:
PENDING,
ACTIVE,
REJECTED,
DISABLED
Example:

"ACTIVE"

hasExternalApiKey
boolean
required

External API key configured

Example:

true

createdAt
string<date-time>
required

Created at

Example:

"2026-07-03T14:30:00.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2026-07-03T14:30:00.000Z"

externalWalletId
string | null

External wallet identifier

Example:

"wallet_42d8a19f"

createdBy
string<uuid> | null

Created by

Example:

null

updatedBy
string<uuid> | null

Updated by

Example:

null