Capture

Use this endpoint to complete the spend transaction for a single user.

Preconditions

• You must know the Account Tenant FanID for the user's account, this value is a property of the ID Token returned in the SSO login process. It is possible to store and re-use this value for the user.

• This API requires either a server-to-server or user access auth token:

• You can generate a server-to-server token using the S2S Auth API

• User access tokens are returned from the Code Exchange step of the SSO auth process.

• Before calling this API, the FanCash Auth endpoint should be called first to get an auth transaction id. Do not confuse FanCash Auth transactions with Authentication/Authorization API Calls.

Required Scopes

fancash:capture

Request

URL

/v1/{account_tenant_fanid}/capture

Path Parameters

Name	Description
account_tenant_fanid	unique identifier representing the user in a non-Fanatics system as a proxy for their internal fanatics id. Each vendor will have their own account_tenant_fan_id for a user. This value is a property of the ID Token returned in the SSO login process.

Headers

Name	Description
Authorization	either a user Bearer token or a server-to-server Bearer token for accessing the API

Data

Request Object

Name	Required	Description
amount		dollar amount of FanCash written as a string NOT a number. supports fractional dollar amounts up to six decimal places
currency		ISO currency code for the FanCash issuance. Only USD is supported for now. Please pass USD only.
auth_transaction_id		unique identifier within the Fanatics system for the successful FanCash auth transaction preceding this capture.
country_code		country of the jurisdiction in which the FanCash is being earned written as a 3-character ISO 3166 country code.
subdivision		political subdivision of the country of jurisdiction in which the FanCash is being earned written as a 2-character abbreviation. Within the United States of America, this would be the 2 character abbreviation of the particular State. For example, NY for New York.
test_transaction		indicates whether this transaction is for testing purposes only. True for a test, False if a normal non-test transaction

Response

Normal Response Data

Name	Description
capture_transaction_id	unique identifier for the FanCash capture transaction within the Fanatics system.

Error Response Data

Error Response Wrapper

Property	Description
errors	array containing error response entries
rc	randomly generated identifier allowing call tracing within Fanatics. When reporting repeated errors or coordinating issue resolution with Fanatics, this value will assist in diagnosing any issues.
timestamp	processing timestamp in Zulu time of Fanatics API server using ISO 8601 format (https://datatracker.ietf.org/doc/html/rfc3339#section-5.6). Useful for issue resolution with Fanatics as log data is partitioned by date and time.

Error Response Wrapper -> Errors -> item

Property	Description
code	Fanatics error code for the specific error; this is generally not an http status code. Code values are generally stable for the API.
message	additional textual information describing the error. This is useful in debugging, but should not be checked programmatically

Full Spec

Fancash Fancash Capture

post

Fancash Fancash Capture. Requires the fancash:capture permission.

Path parameters

account_tenant_fanidstring · uuidRequired

Account Tenant Fan ID

Header parameters

AuthorizationstringRequired

User or server access Bearer token

Body

application/json

amountstring · numberOptionalExample: 10.00

auth_transaction_idstring · uuidOptionalExample: 56eeabe0-d6f0-11ec-b17e-d38c4cb36d49

country_codestringOptional

currencystring · iso4217OptionalExample: USD

sub_divisionstringOptional

test_transactionbooleanOptional

Responses

200

Fancash Capture Response

application/json

400

Bad request

application/json

401

Forbidden

application/json

404

Not Found

application/json

429

Rate Limited

application/json

500

Internal error

application/json

post

/v1/{account_tenant_fanid}/capture

HTTPcURLJavaScriptPython

POST /v1/{account_tenant_fanid}/capture HTTP/1.1
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "amount": "10.00",
  "auth_transaction_id": "56eeabe0-d6f0-11ec-b17e-d38c4cb36d49",
  "country_code": "text",
  "currency": "USD",
  "sub_division": "text",
  "test_transaction": true
}

{
  "capture_transaction_id": "af9035d0-8e7e-11ec-ac03-6f0d1b9d043d"
}