Synctera API

Introduction
Response Codes
OpenAPI Spec
Environments
Authentication
Idempotency

Customers

Credit Scores

Accounts

Spend Controls (beta)
Plaid Core Exchange (beta)
Statements
Applications (beta)
Adverse Actions (beta)

Cards

Apple Pay
- Create an Apple Pay CSRpost
Bulk Issuance
Cards
External Cards
Digital Wallet Tokens

MONEY MOVEMENT

Rewards (beta)
Fees (beta)
Batch Payments
SyncteraPay (beta)

Transactions

Disputes
Transactions (beta)
- List Transactionsget
- Get a transaction by IDget

Platform

Webhooks

Simulations

Card Webhook Simulations (beta)
- Simulate Card Fulfillment Eventpost
Card Transaction Simulations (beta)
Dispute Simulations (Beta)
- Simulate a network dispute actionpost

Synctera API

Introduction
Response Codes
OpenAPI Spec
Environments
Authentication
Idempotency

Customers

Credit Scores

Accounts

Spend Controls (beta)
Plaid Core Exchange (beta)
Statements
Applications (beta)
Adverse Actions (beta)

Cards

Apple Pay
- Create an Apple Pay CSRpost
Bulk Issuance
Cards
External Cards
Digital Wallet Tokens

MONEY MOVEMENT

Rewards (beta)
Fees (beta)
Batch Payments
SyncteraPay (beta)

Transactions

Disputes
Transactions (beta)
- List Transactionsget
- Get a transaction by IDget

Platform

Webhooks

Simulations

Card Webhook Simulations (beta)
- Simulate Card Fulfillment Eventpost
Card Transaction Simulations (beta)
Dispute Simulations (Beta)
- Simulate a network dispute actionpost

Get an FDX token

get https://api.synctera.com/v1/fdx_tokens/{fdx_token_id}

🚧
Beta
This is a Beta endpoint. Feedback from the community is welcome. We may make breaking changes to this endpoint.

Get an FDX token

URL Expired

The URL for this request expired after 30 days.

Path Params

fdx_token_id

uuid

required

The unique identifier of an FDX token

Responses

Response body

object

business_id

string

The UUID of the business associated with the FDX token. One of customer_id or business_id must be provided.

creation_time

date-time

required

The date and time the token was created.

customer_id

string

The UUID of the customer associated with the FDX token. One of customer_id or business_id must be provided.

uuid

required

FDX token ID

last_updated_time

date-time

required

The date and time the token was last updated.

parent_token_id

string

If the token was created via refresh, this is the ID of the refreshing token.

status

string

required

The status of the FDX token.
When ENABLED, check token_expiry_time to determine if it has expired.
Refresh tokens automatically transition to USED when they are used to create a new token, and cannot be used again.

ENABLED REVOKED USED

tenant

string

required

The id of the tenant containing the resource.

token_expiry_time

date-time

required

The date and time the token expires.

token_hash

string

required

The non-secret hash of the FDX token.

token_type

string

required

The type of the FDX token.

ACCESS REFRESH

Response body

object

code

string

A machine-readable string that identifies the error for programmatic use.

detail

string

A human-readable string explaining this particular error.

status

integer

HTTP status code for this response

Response body

object

code

string

A machine-readable string that identifies the error for programmatic use.

detail

string

A human-readable string explaining this particular error.

status

integer

HTTP status code for this response

Response body

object

code

string

A machine-readable string that identifies the error for programmatic use.

detail

string

A human-readable string explaining this particular error.

status

integer

HTTP status code for this response

Response body

object

code

string

A machine-readable string that identifies the error for programmatic use.

detail

string

A human-readable string explaining this particular error.

status

integer

HTTP status code for this response

Updated over 1 year ago

List tokens

Statements

Did this page help you?

Language

Credentials

Bearer

api_key

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.synctera.com/v1/fdx_tokens/fdx_token_id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

List tokens

Statements

Did this page help you?

Synctera API
Introduction
Response Codes
OpenAPI Spec
Environments
Authentication
Idempotency

Customers
Credit Scores
Retrieve a credit scoreget
Create a credit score and associate it with a customerpost
List credit scoresget

Accounts
Spend Controls (beta)
Update Spend Controlpatch
Get Spend Controlget
Create Spend Controlpost
List Spend Controlsget
Plaid Core Exchange (beta)
Get an FDX tokenget
List tokensget
Grant an FDX authorization requestpost
Authorization Testget
List FDX authorization requestsget
Statements
Get a statement's transactionsget
Get a statementget
List statementsget
Applications (beta)
Modify an applicationpatch
Get an applicationget
Create an applicationpost
List applicationsget
Adverse Actions (beta)
Retrieve an adverse action noticeget
Create an adverse action noticepost
List adverse action noticesget

Cards
Apple Pay
Create an Apple Pay CSRpost
Bulk Issuance
Fulfill a bulk orderpost
Get bulk order configurationget
Create a bulk order configurationpost
List Bulk Order Configurationsget
Cards
Get a widget access tokenget
Reveal Card Detailsget
Set Card PINpost
Get a client tokenpost
Get Card Barcodeget
Update Cardpatch
Get Cardget
Update 3DS Decision Gatewaypatch
Get 3DS DecisionGatewayget
Create 3DS Decision Gatewaypost
List 3DS Decision Gatewaysget
List Card Productsget
Upload Card Imagepost
Get Card Image Dataget
Update Card Image Detailspatch
Get Card Image Detailsget
Create Card Imagepost
List Card Image Detailsget
Update Gatewaypatch
Get Gatewayget
Create Gatewaypost
List Gatewaysget
Get card widget URLget
Activate a cardpost
Issue a Cardpost
List Cardsget
External Cards
Update External Cardpatch
Get External Cardget
Delete External Carddelete
Create External Card Transfer Reversalpost
Get External Card Transferget
Create Google Pay External Card Transferpost
Create Apple Pay External Card Transferpost
Create External Card Transferpost
List External Transfersget
Create External Card from tokenpost
Lookup 3DSpost
Initialize 3DSpost
Authenticate 3DSpost
List External Cardsget
Digital Wallet Tokens
Create digital wallet token provision request for Google Paypost
Create digital wallet token provision request for Apple Paypost
Update Digital Wallet Token's life cycle statuspatch
Get Digital Wallet Tokenget
List Digital Wallet Tokensget

MONEY MOVEMENT
Rewards (beta)
Reverse a rewardpost
Get Rewardget
Create a rewardpost
List rewardsget
Patch Reward Templatepatch
Get a Reward templateget
Create a reward templatepost
List reward templatesget
Fees (beta)
Reverse a feepost
Get Feeget
Create a feepost
List feesget
Patch Fee Templatepatch
Get a Fee templateget
Create a fee templatepost
List fee templatesget
Batch Payments
Update Batch Paymentpatch
Get BatchPaymentget
Create Batch Paymentspost
Get Batch Paymentsget
Update Batch Payment Templatepatch
Get Batch Payment Templateget
Create Batch Payment Templatepost
Get Batch Payment Templatesget
SyncteraPay (beta)
Return a Synctera Pay Transferpost
Update Synctera Pay Transferpatch
Get Synctera Pay Transferget
Get a Synctera Pay vendorget
List Synctera Pay vendorsget
Get Synctera Pay Configurationget
Get Synctera Pay Configurationsget
Create Synctera Pay Transferpost
Get Synctera Pay Transfersget

Transactions
Disputes
Add a document to a disputepost
Create a dispute actionpost
Update a disputepatch
Get a Disputeget
Get dispute document contentsget
Dispute a transactionpost
List disputesget
Transactions (beta)
Get a transaction by IDget
List Transactionsget

Platform
Webhooks
Resend an eventpost
Get webhook eventget
List webhook eventsget
Update a webhookput
Get a webhookget
Delete a webhookdelete
Trigger an eventpost
Create a webhookpost
List webhooksget

Simulations
Card Webhook Simulations (beta)
Simulate Card Fulfillment Eventpost
Card Transaction Simulations (beta)
Simulate reversalpost
Simulate ATM withdrawalpost
Simulate OCTpost
Simulate balance inquirypost
Simulate financial advicepost
Simulate financialpost
Simulate L2l3post
Simulate clearing or refundpost
Simulate authorization advicepost
Simulate authorizationpost
Dispute Simulations (Beta)
Simulate a network dispute actionpost

Synctera API
Introduction
Response Codes
OpenAPI Spec
Environments
Authentication
Idempotency

Customers
Credit Scores
Retrieve a credit scoreget
Create a credit score and associate it with a customerpost
List credit scoresget

Accounts
Spend Controls (beta)
Update Spend Controlpatch
Get Spend Controlget
Create Spend Controlpost
List Spend Controlsget
Plaid Core Exchange (beta)
Get an FDX tokenget
List tokensget
Grant an FDX authorization requestpost
Authorization Testget
List FDX authorization requestsget
Statements
Get a statement's transactionsget
Get a statementget
List statementsget
Applications (beta)
Modify an applicationpatch
Get an applicationget
Create an applicationpost
List applicationsget
Adverse Actions (beta)
Retrieve an adverse action noticeget
Create an adverse action noticepost
List adverse action noticesget

Cards
Apple Pay
Create an Apple Pay CSRpost
Bulk Issuance
Fulfill a bulk orderpost
Get bulk order configurationget
Create a bulk order configurationpost
List Bulk Order Configurationsget
Cards
Get a widget access tokenget
Reveal Card Detailsget
Set Card PINpost
Get a client tokenpost
Get Card Barcodeget
Update Cardpatch
Get Cardget
Update 3DS Decision Gatewaypatch
Get 3DS DecisionGatewayget
Create 3DS Decision Gatewaypost
List 3DS Decision Gatewaysget
List Card Productsget
Upload Card Imagepost
Get Card Image Dataget
Update Card Image Detailspatch
Get Card Image Detailsget
Create Card Imagepost
List Card Image Detailsget
Update Gatewaypatch
Get Gatewayget
Create Gatewaypost
List Gatewaysget
Get card widget URLget
Activate a cardpost
Issue a Cardpost
List Cardsget
External Cards
Update External Cardpatch
Get External Cardget
Delete External Carddelete
Create External Card Transfer Reversalpost
Get External Card Transferget
Create Google Pay External Card Transferpost
Create Apple Pay External Card Transferpost
Create External Card Transferpost
List External Transfersget
Create External Card from tokenpost
Lookup 3DSpost
Initialize 3DSpost
Authenticate 3DSpost
List External Cardsget
Digital Wallet Tokens
Create digital wallet token provision request for Google Paypost
Create digital wallet token provision request for Apple Paypost
Update Digital Wallet Token's life cycle statuspatch
Get Digital Wallet Tokenget
List Digital Wallet Tokensget

MONEY MOVEMENT
Rewards (beta)
Reverse a rewardpost
Get Rewardget
Create a rewardpost
List rewardsget
Patch Reward Templatepatch
Get a Reward templateget
Create a reward templatepost
List reward templatesget
Fees (beta)
Reverse a feepost
Get Feeget
Create a feepost
List feesget
Patch Fee Templatepatch
Get a Fee templateget
Create a fee templatepost
List fee templatesget
Batch Payments
Update Batch Paymentpatch
Get BatchPaymentget
Create Batch Paymentspost
Get Batch Paymentsget
Update Batch Payment Templatepatch
Get Batch Payment Templateget
Create Batch Payment Templatepost
Get Batch Payment Templatesget
SyncteraPay (beta)
Return a Synctera Pay Transferpost
Update Synctera Pay Transferpatch
Get Synctera Pay Transferget
Get a Synctera Pay vendorget
List Synctera Pay vendorsget
Get Synctera Pay Configurationget
Get Synctera Pay Configurationsget
Create Synctera Pay Transferpost
Get Synctera Pay Transfersget

Transactions
Disputes
Add a document to a disputepost
Create a dispute actionpost
Update a disputepatch
Get a Disputeget
Get dispute document contentsget
Dispute a transactionpost
List disputesget
Transactions (beta)
Get a transaction by IDget
List Transactionsget

Platform
Webhooks
Resend an eventpost
Get webhook eventget
List webhook eventsget
Update a webhookput
Get a webhookget
Delete a webhookdelete
Trigger an eventpost
Create a webhookpost
List webhooksget

Simulations
Card Webhook Simulations (beta)
Simulate Card Fulfillment Eventpost
Card Transaction Simulations (beta)
Simulate reversalpost
Simulate ATM withdrawalpost
Simulate OCTpost
Simulate balance inquirypost
Simulate financial advicepost
Simulate financialpost
Simulate L2l3post
Simulate clearing or refundpost
Simulate authorization advicepost
Simulate authorizationpost
Dispute Simulations (Beta)
Simulate a network dispute actionpost

200FDX token

401Unauthorized

403Forbidden

404Resource not found

500Internal server error