Skip to main content
GET
Get a fulfillment account
Retrieve a fulfillment account and its current status. Only ACTIVE accounts accept new redemptions. The response does not include credentials. Check status_reason when an account is rejected or needs to be reconnected. Re-enabling an account in the dashboard can leave that reason in place until you reconnect it, even when its status is ACTIVE.
See Gift-card setup for connecting and funding an account.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

id
string<uuid>
required

Fulfillment account ID

Response

OK

config
object

Fulfillment account settings

created_at
string<date-time>

When the fulfillment account was created

Example:

"2026-08-31T10:30:00Z"

credential_method
string

Authentication method used with the fulfillment vendor: API_KEY or OAUTH

Example:

"OAUTH"

credential_owner
string

Scope that owns the authorization: ORG or PLATFORM

Example:

"ORG"

environment
string

Credential environment: TEST or PROD

Example:

"TEST"

id
string<uuid>

Fulfillment account ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

last_validated_at
string<date-time>

When the authorization last validated successfully with the vendor

Example:

"2026-08-31T10:30:00Z"

onboarding_expires_at
string<date-time>

Expiry of onboarding_url (OAUTH creates only).

Example:

"2026-09-02T10:30:00Z"

onboarding_url
string

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

provider
string

Fulfillment vendor for this account

Example:

"TREMENDOUS"

provider_account_id
string

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

status
string

Fulfillment account status: ACTIVE, DISABLED, PENDING_ONBOARDING, PENDING_REVIEW, or REJECTED

Example:

"ACTIVE"

status_reason
string

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

Example:

"reauth_required"

updated_at
string<date-time>

When the fulfillment account was last modified

Example:

"2026-08-31T10:30:00Z"

webhook_registered
boolean

Whether the account webhook is registered with the fulfillment vendor

Example:

true