Synctera

https://docs.synctera.com/
Admin
Synctera is a Banking-as-a-Service platform that enables developers to build FinTech applications...
Tokens:197,109
Snippets:1,016
Trust Score:8.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### Create Account Response Example

Source: https://docs.synctera.com/reference/createaccount

Example JSON response returned by the create account endpoint. Includes account details such as access status, balances, and account type. The response may vary based on the request.

```json
{
  "access_status": "ACTIVE",
  "access_status_last_updated_time": "2023-11-07T05:31:56Z",
  "account_closure": {
    "destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payment_method": "ACH",
    "reason": "BANK_REQUEST_REGULATORY_REASONS",
    "reason_details": "<string>",
    "cases": [
      {
        "case_id": "<string>",
        "case_reason": "<string>"
      }
    ],
    "validation_responses": [
      {
        "details": {},
        "message": "Cards decoupled from account",
        "name": "cards",
        "validated": true
      }
    ]
  },
  "account_number": "<string>",
  "account_number_masked": "123*****6789",
  "account_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_purpose": "This account for the account holder's salary deposit.",
  "account_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_title": "<string>",
  "account_type": "CHARGE_SECURED",
  "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "auto_payment_period": 20,
  "balance_ceiling": {
    "balance": 1,
    "linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "overflow_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "balance_floor": {
    "balance": 123,
    "linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "overdraft_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "balances": [
    {
      "balance": 2399,
      "type": "ACCOUNT_BALANCE"
    }
  ],
  "bank_account_id": "<string>",
  "bank_routing": "<string>",
  "billing_period": {
    "frequency": "ANNUALLY",
    "start_date": "2022-01-01T00:00:00Z"
  },
  "business_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
```

--------------------------------

### GET /v0/businesses/{BUSINESS_ID} - JSON response

Source: https://docs.synctera.com/docs/create-a-business

Example response from the GET request. Shows a business with verification_status ACCEPTED and other business details.

```json
{
  "id": "{BUSINESS_ID}",
  "status": "ACTIVE",
  "verification_status": "ACCEPTED",
  "verification_last_run": "2022-04-29T21:19:09.432601Z",
  "is_customer": true,
  "entity_name": "Acme Trap Company",
  "trade_names": ["Acme", "Acme Corp", "CorporationID#77231"],
  "formation_date": "2000-01-01",
  "formation_state": "NY",
  "structure": "CORPORATION",
  "phone_number": "+12124567890",
  "ein": "12-3456789",
  "legal_address": {
    "address_line_1": "50 Main St",
    "city": "New York",
    "state": "NY",
    "postal_code": "12345",
    "country_code": "US"
  },
  "creation_time": "2022-04-29T21:12:55.179008Z",
  "last_updated_time": "2022-04-29T21:19:09.521182Z"
}
```

--------------------------------

### Create Account Template with PHP cURL

Source: https://docs.synctera.com/reference/createaccounttemplate

Use this PHP example to create an account template by sending a POST request to the Synctera API endpoint using cURL. The request body includes the same template configuration fields as the JavaScript example. Replace the placeholder token and string values with actual data.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.synctera.com/v0/accounts/templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'is_enabled' => true,
    'name' => '<string>',
    'template' => [
        'bank_country' => 'US',
        'currency' => 'USD',
        'account_program_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'application_workflow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'auto_payment_period' => 20,
        'bank_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'fee_product_ids' => [
                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ],
        'grace_period' => 2,
        'interest_product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'is_ach_credit_enabled' => true,
        'is_ach_debit_enabled' => true,
        'is_ach_enabled' => true,
        'is_card_credit_enabled' => true,
        'is_card_debit_enabled' => true,
        'is_card_enabled' => true,
        'is_cash_credit_enabled' => true,
        'is_cash_debit_enabled' => true,
        'is_cash_enabled' => true,
        'is_check_credit_enabled' => true,
        'is_check_debit_enabled' => true,
        'is_check_enabled' => true,
        'is_eft_ca_credit_enabled' => true,
        'is_eft_ca_debit_enabled' => true,
        'is_eft_ca_enabled' => true,
        'is_external_card_credit_enabled' => true,
        'is_external_card_debit_enabled' => true,
        'is_external_card_enabled' => true,
        'is_fednow_credit_enabled' => true,
        'is_fednow_debit_enabled' => true,
        'is_fednow_enabled' => true,
        'is_sar_enabled' => true,
        'is_synctera_pay_credit_enabled' => true,
        'is_synctera_pay_debit_enabled' => true,
        'is_synctera_pay_enabled' => true,
        'is_wire_credit_enabled' => true,
        'is_wire_debit_enabled' => true,
        'is_wire_enabled' => true,
        'minimum_payment' => [
                'min_amount' => 123,
                'rate' => 123
        ],
        'overdraft_limit' => 1,
        'reward_product_ids' => [
                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ],
        'spend_control_ids' => [
                '7d943c51-e4ff-4e57-9558-08cab6b963c7'
        ]
    ],
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Sample success response for account creation

Source: https://docs.synctera.com/docs/create-accounts-guide

Example JSON response returned on successful account creation. Shows account details such as id, status, balances, and customer_ids.

```json
{
  "access_status": "ACTIVE",
  "access_status_last_updated_time": "2022-10-06T14:03:54.962704Z",
  "account_number": "790954299503",
  "account_number_masked": "790*****9503",
  "account_type": "SAVING",
  "balances": [
    {
      "balance": 0,
      "type": "ACCOUNT_BALANCE"
    },
    {
      "balance": 0,
      "type": "AVAILABLE_BALANCE"
    }
  ],
  "bank_routing": "112233445",
  "creation_time": "2022-10-06T14:03:54.963162Z",
  "currency": "USD",
  "customer_ids": [
    "110acc45-0b53-4d21-b624-29f88879c6a0"
  ],
  "customer_type": "PERSONAL",
  "id": "ce439ca4-8eb6-45e6-955c-46441af33770",
  "is_account_pool": false,
  "is_ach_enabled": false,
  "is_card_enabled": false,
  "is_p2p_enabled": false,
  "is_wire_enabled": false,
  "last_updated_time": "2022-10-06T14:03:54.963162Z",
  "status": "ACTIVE_OR_DISBURSED"
}
```

--------------------------------

### Get Pending Transaction response with AVS mismatch

Source: https://docs.synctera.com/docs/address-verification-service-avs

Example JSON response from the Get Pending Transaction API for a transaction declined due to AVS mismatch. Shows the `user_data.address_verification` object with on-file, request, and response details, and the decline reason `ADDRESS_VERIFICATION_FAILED`.

```json
{
  "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "account_no": "string",
  "created": "2024-06-20T14:06:34.970Z",
  "data": {
    "amount": 0,
    "...": "...",
    "history": [
      {
        "...": "..."
      }
    ],
    "idemkey": "3ae35b74-fa4c-472e-bd8d-a61b98c07d9e",
    "memo": "",
    "network": "marqeta",
    "operation": "hold_decline",
    "reason": "ADDRESS_VERIFICATION_FAILED",
    "req_amount": 0,
    "risk_info": null,
    "status": "DECLINED",
    "subtype": "pos_purchase",
    "total_amount": 1000,
    "transaction_time": "2024-06-17T20:18:20Z",
    "type": "card",
    "user_data": {
      "...": "...",
      "address_verification": {
        "on_file": {
          "postal_code": "233120",
          "street_address": "116"
        },
        "request": {
          "postal_code": "111101 ",
          "street_address": " "
        },
        "response": {
          "additional_information": "Failed using address 58dde53c-27bf-4848-be01-9f80f91102bb",
          "memo": "postal code NO_MATCH, street address NO_DATA"
        }
      }
    }
  }
}
```

--------------------------------

### Initialize marqeta.js with bootstrap

Source: https://docs.synctera.com/docs/card-widgets

Initializes marqeta.js with a client access token. Creates an iframe inside each div and allows styling via the showPan object.

```JavaScript
window.marqeta.bootstrap({
  clientAccessToken: clientAccessToken,
  integrationType: "custom",
  component: {
    showPan: {
      cardPan: { domId: "display-card-pan", format: true },
      cardExp: { domId: "display-card-exp", format: true },
      cardCvv: { domId: "display-card-cvv" },
    },
  },
  callbackEvents: {
    onSuccess: () => console.log("Widget loaded!"),
    onFailure: () => console.warn("Widget failed to load."),
  },
});
```

--------------------------------

### Marqeta.js window.marqeta.bootstrap

Source: https://docs.synctera.com/docs/card-widgets

The Marqeta.js library exposes a bootstrap method on the window.marqeta object. It accepts either MarqetaShowPanParams or MarqetaPinRevealParams to initialize the widget components.

```APIDOC
## window.marqeta.bootstrap(params)

### Description
The Marqeta.js library exposes a bootstrap method on the window.marqeta object. It accepts either MarqetaShowPanParams or MarqetaPinRevealParams to initialize the widget components.

### Method
bootstrap

### Parameters
- **params** (MarqetaShowPanParams | MarqetaPinRevealParams) - Required - The parameters for initializing the widget.

### Type Definitions
```typescript
interface MarqetaBaseParams {
  clientAccessToken: string;
  options?: {
    // Must be included if using PIN reveal
    cardholderVerificationMethod: 'OTHER';
  };
  integrationType: 'custom';
  callbackEvents?: {
    onSuccess?: () => void;
    onFailure: () => void;
  };
}

export interface MarqetaShowPanParams extends MarqetaBaseParams {
  component: {
    showPan: {
      cardPan?: MarqetaShowItem;
      cardExp?: MarqetaShowItem;
      cardCvv?: Omit<MarqetaShowItem, 'format'>;
    };
    pinReveal?: undefined;
  };
}

export interface MarqetaPinRevealParams extends MarqetaBaseParams {
  component: {
    showPan?: undefined;
    pinReveal: {
      cardPin: Omit<MarqetaShowItem, 'format'>;
      toggleCardPin?: {
        domId: string;
        mode: 'transparent';
        onRevealSuccess?: () => void;
        onHideSuccess?: () => void;
      };
      hidePinTimeout?: {
        domId: string;
        hideTimeout: 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15;
        styles: CSSProperties;
        onSuccess?: () => void;
        onFailure?: () => void;
      };
    };
  };
}

export interface MarqetaShowItem {
  domId: string;
  format?: boolean;
  styles?: {
    span?: CSSProperties;
    'span:hover'?: CSSProperties;
  };
  mode?: 'transparent';
  onCopySuccess?: () => void;
  onCopyFailure?: () => void;
}
```
```

--------------------------------

### Response from creating a business

Source: https://docs.synctera.com/docs/create-a-business

Example response from POST /v0/businesses. The id is used for future GET, PATCH, and DELETE requests and to link the business to disclosures and accounts.

```json
{
  "id": "{BUSINESS_ID}",
  "status": "PROSPECT",
  "verification_status": "UNVERIFIED",
  "is_customer": true,
  "entity_name": "Acme Trap Company",
  "trade_names": ["Acme", "Acme Corp", "CorporationID#77231"],
  "formation_date": "2000-01-01",
  "formation_state": "NY",
  "structure": "CORPORATION",
  "phone_number": "+12124567890",
  "ein": "12-3456789",
  "legal_address": {
    "address_line_1": "50 Main St",
    "city": "New York",
    "state": "NY",
    "postal_code": "12345",
    "country_code": "US"
  },
  "creation_time": "2022-04-29T21:12:55.179008Z",
  "last_updated_time": "2022-04-29T21:12:55.179008Z"
}
```

--------------------------------

### Payment Schedule Resource JSON Example

Source: https://docs.synctera.com/docs/payment-schedules

Shows the structure of a payment schedule resource with a schedule configuration and payment instruction for an internal transfer. The schedule uses a daily frequency with an interval of 2 and a count of 2, starting on 2022-04-26. The payment instruction specifies an INTERNAL_TRANSFER type with an ACCOUNT_TO_ACCOUNT request.

```JSON
{
  "description": "example schedule",
  "schedule": {
      "start_date": "2022-04-26",
      "frequency": "DAILY",
      "interval": 2,
      "count": 2
  },
  "payment_instruction": {
      "type": "INTERNAL_TRANSFER",
      "request": {
          "amount": 10,
          "currency": "USD",
          "originating_account_id": "{ACCOUNT_ID}",
          "receiving_account_id": "{ACCOUNT_ID}",
          "type": "ACCOUNT_TO_ACCOUNT"
      }
  }
}

```

--------------------------------

### Create Account with fetch (JavaScript)

Source: https://docs.synctera.com/reference/createaccount

Use this snippet to create an account via the Synctera API. It sends a POST request to https://api-sandbox.synctera.com/v0/accounts with a JSON body containing account details such as relationships, spending limits, and feature flags. Replace placeholder values like <token> and <string> with actual data.

```javascript
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    manual_account_number: '<string>',
    relationships: [
      {
        business_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        created_at: '2023-11-07T05:31:56Z',
        customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        deleted_at: '2023-11-07T05:31:56Z',
        legal_roles: [],
        ownership_percentage: 35.75,
        person_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        updated_at: '2023-11-07T05:31:56Z'
      }
    ],
    account_template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    fee_product_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    interest_product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    note: '<string>',
    overdraft_limit: 1,
    reward_product_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    spend_control_ids: ['7d943c51-e4ff-4e57-9558-08cab6b963c7'],
    spending_limits: {
      day: {amount: 1, transactions: 1},
      description: '<string>',
      lifetime: {amount: 1, transactions: 1},
      month: {amount: 1, transactions: 1},
      transaction: {amount: 1},
      week: {amount: 1, transactions: 1}
    },
    is_ach_credit_enabled: true,
    is_ach_debit_enabled: true,
    is_ach_enabled: true,
    is_card_credit_enabled: true,
    is_card_debit_enabled: true,
    is_card_enabled: true,
    is_cash_credit_enabled: true,
    is_cash_debit_enabled: true,
    is_cash_enabled: true,
    is_check_credit_enabled: true,
    is_check_debit_enabled: true,
    is_check_enabled: true,
    is_eft_ca_credit_enabled: true,
    is_eft_ca_debit_enabled: true,
    is_eft_ca_enabled: true,
    is_external_card_credit_enabled: true,
    is_external_card_debit_enabled: true,
    is_external_card_enabled: true,
    is_fednow_credit_enabled: true,
    is_fednow_debit_enabled: true,
    is_fednow_enabled: true,
    is_p2p_enabled: true,
    is_synctera_pay_credit_enabled: true,
    is_synctera_pay_debit_enabled: true,
    is_synctera_pay_enabled: true,
    is_wire_credit_enabled: true,
    is_wire_debit_enabled: true,
    is_wire_enabled: true,
    account_program_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    account_purpose: 'This account for the account holder\'s salary deposit.',
    account_title: '<string>',
    application_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    currency: 'USD',
    exchange_rate_type: 'M, INTERBANK, CUST',
    iban: '<string>',
    is_account_pool: true,
    is_custodial: true,
    is_escrow: true,
    is_trust: true,
    metadata: {},
    nickname: '<string>',
    swift_code: '<string>'
  })
};

fetch('https://api-sandbox.synctera.com/v0/accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Enhanced transaction metadata example

Source: https://docs.synctera.com/docs/card-transactions

Example of enhanced transaction data with cleanly formatted name and consistent category.

```JSON
{
  "category": "Hosting",
  "enhanced_description": "HostGator"
}
```

--------------------------------

### Create account with cURL

Source: https://docs.synctera.com/reference/createaccount

Use this cURL command to create an account in the Synctera sandbox. The request includes a JSON payload with account details such as relationships, account template, fee products, and spending limits. Replace the placeholder token and IDs with actual values.

```bash
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "manual_account_number": "<string>",
  "relationships": [
    {
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deleted_at": "2023-11-07T05:31:56Z",
      "legal_roles": [],
      "ownership_percentage": 35.75,
      "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "account_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fee_product_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "interest_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "note": "<string>",
  "overdraft_limit": 1,
  "reward_product_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "spend_control_ids": [
    "7d943c51-e4ff-4e57-9558-08cab6b963c7"
  ],
  "spending_limits": {
    "day": {
      "amount": 1,
      "transactions": 1
    },
    "description": "<string>",
    "lifetime": {
      "amount": 1,
      "transactions": 1
    },
    "month": {
      "amount": 1,
      "transactions": 1
    },
    "transaction": {
      "amount": 1
    },
    "week": {
      "amount": 1,
      "transactions": 1
    }
  },
  "is_ach_credit_enabled": true,
  "is_ach_debit_enabled": true,
  "is_ach_enabled": true,
  "is_card_credit_enabled": true,
  "is_card_debit_enabled": true,
  "is_card_enabled": true,
  "is_cash_credit_enabled": true,
  "is_cash_debit_enabled": true,
  "is_cash_enabled": true,
  "is_check_credit_enabled": true,
  "is_check_debit_enabled": true,
  "is_check_enabled": true,
  "is_eft_ca_credit_enabled": true,
  "is_eft_ca_debit_enabled": true,
  "is_eft_ca_enabled": true,
  "is_external_card_credit_enabled": true,
  "is_external_card_debit_enabled": true,
  "is_external_card_enabled": true,
  "is_fednow_credit_enabled": true,
  "is_fednow_debit_enabled": true,
  "is_fednow_enabled": true,
  "is_p2p_enabled": true,
  "is_synctera_pay_credit_enabled": true,
  "is_synctera_pay_debit_enabled": true,
  "is_synctera_pay_enabled": true,
  "is_wire_credit_enabled": true,
  "is_wire_debit_enabled": true,
  "is_wire_enabled": true,
  "account_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_purpose": "This account for the account holder's salary deposit.",
  "account_title": "<string>",
  "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "USD",
  "exchange_rate_type": "M, INTERBANK, CUST",
  "iban": "<string>",
  "is_account_pool": true,
  "is_custodial": true,
  "is_escrow": true,
  "is_trust": true,
  "metadata": {},
  "nickname": "<string>",
  "swift_code": "<string>"
}
EOF
```

--------------------------------

### Network-provided merchant metadata example

Source: https://docs.synctera.com/docs/card-transactions

Example of the network-provided merchant name and MCC found in the transaction data.user_data object.

```JSON
{
  "mcc": "4816",
  "name": "EIG*HOSTGATOR.COM"
}
```

--------------------------------

### Create Account Template with JavaScript fetch

Source: https://docs.synctera.com/reference/createaccounttemplate

Use this JavaScript example to create an account template by sending a POST request to the Synctera API endpoint. The request body includes template configuration fields such as bank_country, currency, and various enabled flags. Replace the placeholder token and string values with actual data.

```javascript
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    is_enabled: true,
    name: '<string>',
    template: {
      bank_country: 'US',
      currency: 'USD',
      account_program_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      application_workflow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      auto_payment_period: 20,
      bank_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      fee_product_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
      grace_period: 2,
      interest_product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      is_ach_credit_enabled: true,
      is_ach_debit_enabled: true,
      is_ach_enabled: true,
      is_card_credit_enabled: true,
      is_card_debit_enabled: true,
      is_card_enabled: true,
      is_cash_credit_enabled: true,
      is_cash_debit_enabled: true,
      is_cash_enabled: true,
      is_check_credit_enabled: true,
      is_check_debit_enabled: true,
      is_check_enabled: true,
      is_eft_ca_credit_enabled: true,
      is_eft_ca_debit_enabled: true,
      is_eft_ca_enabled: true,
      is_external_card_credit_enabled: true,
      is_external_card_debit_enabled: true,
      is_external_card_enabled: true,
      is_fednow_credit_enabled: true,
      is_fednow_debit_enabled: true,
      is_fednow_enabled: true,
      is_sar_enabled: true,
      is_synctera_pay_credit_enabled: true,
      is_synctera_pay_debit_enabled: true,
      is_synctera_pay_enabled: true,
      is_wire_credit_enabled: true,
      is_wire_debit_enabled: true,
      is_wire_enabled: true,
      minimum_payment: {min_amount: 123, rate: 123},
      overdraft_limit: 1,
      reward_product_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
      spend_control_ids: ['7d943c51-e4ff-4e57-9558-08cab6b963c7']
    },
    description: '<string>'
  })
};

fetch('https://api-sandbox.synctera.com/v0/accounts/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Successful Response Example

Source: https://docs.synctera.com/reference/uploadcardimagedata

Example of a successful response from the upload card image endpoint. Shows the card image object with status APPROVED.

```json
{
  "card_product_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "status": "APPROVED",
  "rejection_memo": "<string>",
  "rejection_reason": "BRANDED"
}

```

--------------------------------

### Customer-Device-Info header example

Source: https://docs.synctera.com/docs/create-accounts-guide

Example JSON payload for the Customer-Device-Info HTTP header, used for customer device fingerprinting on requests made on behalf of an end-customer.

```json
{
  "customer_id": "123e4567-e89b-12d3-a456-426614174000",
  "ip_address": "203.0.113.195",
  "device_type": "iOS",
  "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.0 Mobile/15E148 Safari/604.1"
}
```

--------------------------------

### Create Account Template with Go (net/http)

Source: https://docs.synctera.com/reference/createaccounttemplate

Sends a POST request to the Synctera API to create an account template. Requires a valid bearer token and a JSON body with template settings. The response body is printed to stdout.

```Go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.synctera.com/v0/accounts/templates"

	payload := strings.NewReader("{\n  \"is_enabled\": true,\n  \"name\": \"<string>\",\n  \"template\": {\n    \"bank_country\": \"US\",\n    \"currency\": \"USD\",\n    \"account_program_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"application_workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"auto_payment_period\": 20,\n    \"bank_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"fee_product_ids\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"grace_period\": 2,\n    \"interest_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"is_ach_credit_enabled\": true,\n    \"is_ach_debit_enabled\": true,\n    \"is_ach_enabled\": true,\n    \"is_card_credit_enabled\": true,\n    \"is_card_debit_enabled\": true,\n    \"is_card_enabled\": true,\n    \"is_cash_credit_enabled\": true,\n    \"is_cash_debit_enabled\": true,\n    \"is_cash_enabled\": true,\n    \"is_check_credit_enabled\": true,\n    \"is_check_debit_enabled\": true,\n    \"is_check_enabled\": true,\n    \"is_eft_ca_credit_enabled\": true,\n    \"is_eft_ca_debit_enabled\": true,\n    \"is_eft_ca_enabled\": true,\n    \"is_external_card_credit_enabled\": true,\n    \"is_external_card_debit_enabled\": true,\n    \"is_external_card_enabled\": true,\n    \"is_fednow_credit_enabled\": true,\n    \"is_fednow_debit_enabled\": true,\n    \"is_fednow_enabled\": true,\n    \"is_sar_enabled\": true,\n    \"is_synctera_pay_credit_enabled\": true,\n    \"is_synctera_pay_debit_enabled\": true,\n    \"is_synctera_pay_enabled\": true,\n    \"is_wire_credit_enabled\": true,\n    \"is_wire_debit_enabled\": true,\n    \"is_wire_enabled\": true,\n    \"minimum_payment\": {\n      \"min_amount\": 123,\n      \"rate\": 123\n    },\n    \"overdraft_limit\": 1,\n    \"reward_product_ids\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"spend_control_ids\": [\n      \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n    ]\n  },\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Create Gateway Configuration (curl)

Source: https://docs.synctera.com/docs/card-transactions

Shell command to create a new Gateway via the Synctera API. Requires a valid, publicly accessible URL and a list of Card Product IDs. Optional custom headers are included in authorization calls. If 'active' is not supplied, it defaults to true; a Card Product may not be on more than one active Gateway at a time.

```Shell
curl \
  -X POST \
  -H "Authorization: Bearer $apikey" \
  -H "Content-Type: application/json" \
  $baseurl/v0/cards/gateways \
  --data-binary '
  {
    "active": true,
    "url": "https://example.com",
    "custom_headers": {
      "key": "value"
    },
    "card_products": [
      "41e81dff-05d4-4421-b7f0-149e3a536979",
      "e8361f07-1e7d-440c-91bd-def3e18a907f"
    ]
  }'
```
Tokens:
Raw