Fulfillment Accounts

Get a fulfillment account

Fetch a fulfillment account by ID.

get/v1/fulfillment-accounts/{fulfillment_account_id}

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/fulfillment-accounts/{fulfillment_account_id}
  • Auth: HTTP bearer

Path parameters

fulfillment_account_idstring required

The fulfillment account's id.

Response

OK

created_atstring date-time

When the fulfillment account was created

credential_methodstring

Authentication method used with the fulfillment vendor: API_KEY or OAUTH

credential_ownerstring

Whether your organization (ORG) or Scrip (PLATFORM) holds the authorization for this account

currency_codestring

ISO 4217 funding currency the account was created with (Connect accounts only)

environmentstring

Whether the account is for testing (TEST) or live orders (PROD)

idstring uuid

The id of the fulfillment account. Use it in fulfillment_account_id fields and paths.

last_validated_atstring date-time

When the authorization last validated successfully with the vendor

member_emailstring

Work email of the onboarding member; the vendor sends the setup link and any compliance follow-ups there (Connect accounts only)

onboarding_expires_atstring date-time

Expiry of onboarding_url (OAUTH creates only).

onboarding_urlstring

A freshly minted onboarding session URL (OAUTH creates only); never stored, and appears here and on the session endpoint only.

providerstring

Fulfillment vendor for this account

provider_account_idstring

The vendor's identifier for this fulfillment account, once known

status'ACTIVE' | 'DISABLED' | 'PENDING_ONBOARDING' | 'PENDING_REVIEW' | 'REJECTED'

The fulfillment account's lifecycle state.

status_reasonstring

Machine-readable reason for REJECTED, or a DISABLED connection that needs reconnection (reauth_required)

updated_atstring date-time

When the fulfillment account was last modified

webhook_registeredboolean

Whether the account webhook is registered with the fulfillment vendor

Example response

{
  "config": {
    "awaiting_funds_window_hours": 24
  },
  "created_at": "2027-01-15T10:30:00Z",
  "credential_method": "OAUTH",
  "credential_owner": "ORG",
  "currency_code": "USD",
  "environment": "TEST",
  "id": "71f2a9d4-3b6e-4c8a-9f1d-5e2b8c7a0091",
  "last_validated_at": "2027-01-15T10:30:00Z",
  "member_email": "ops@example.com",
  "onboarding_expires_at": "2027-12-31T23:59:59Z",
  "provider": "TREMENDOUS",
  "status": "ACTIVE",
  "status_reason": "reauth_required",
  "updated_at": "2027-01-15T10:30:00Z",
  "webhook_registered": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.