> ## Documentation Index > Fetch the complete documentation index at: https://docs.synctera.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Gateway > Create a new Authorization Gateway Configuration ## OpenAPI ````yaml openapi-v1.json post /cards/gateways openapi: 3.0.3 info: description: >- This is the official reference documentation for Synctera APIs. If you need something specific or have a question, contact us.

license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: 1.181.0 servers: - description: Production url: https://api.synctera.com/v1 - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v1 security: - bearerAuth: [] tags: - description: | Requests to create and manage Rewards name: Rewards (beta) - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Testing endpoints to simulate in-store cash deposits. Available in sandbox environments only. name: In-Store Cash Deposit Simulations - description: Create and manage spending controls name: Spend Controls (beta) - description: Rates name: Rates - description: Requests to create and manage webhooks name: Webhooks - description: Tenant Config name: Tenant Config - description: FDX authentication and data transfer using Plaid Core Exchange name: Plaid Core Exchange (beta) - description: Create and manage disputes name: Disputes - description: Requests to simulate card payments name: Card Simulations - description: | Manage fee products and fee configs for automated fee collection name: Fee Products - description: Apple Pay APIs name: Apple Pay - description: Lending Config name: Lending Config - description: Payments related to lending accounts name: Payments - description: Manage negative balance processes name: Negative Balance - description: Configuration for mapping LoanPro events to Payola transaction parameters name: LoanPro Transaction Event Config - description: Requests to generate simulated transactions name: Cash Transaction Simulations (alpha) - description: Create and manage transactions name: Transactions (beta) - description: Autopay payment records for billing periods name: Autopays - description: Create and manage accounts name: Accounts - description: | Requests to create and manage batch payments name: Batch Payments (alpha) - description: Billing rates name: Billing Rates - description: Bank Delinquency Configuration name: Bank Delinquency Configuration - description: >- Rules that map a posted payment transaction (bank/partner + transaction attributes) to a regulatory payment code. NULL match columns act as wildcards. name: Payment Code Configuration - description: Create and manage Synctera Pay templates name: SyncteraPay - description: | Manage reward products and reward configs for automated cashback rewards name: Reward Products - description: Requests to create and manage card disputes name: Card Disputes - description: >- Per bank/partner account-type mapping to FFIEC collateral codes used for regulatory call report furnishment. name: Collateral Code Configuration - description: Bulk card issuance name: Bulk Issuance - description: Autopay configuration management for lending accounts name: Autopay Configs - description: Request to create and manage exclusions name: Statements - description: Create and manage barcodes for in-store cash deposits name: In-Store Cash Deposits - description: Customer Service Details for disputes and billing inquiries name: Customer Service Details - description: Create a credit application. name: Applications (beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Billing period summaries name: Billing Period Summaries - description: Requests to issue and manage cards name: Cards - description: Push and pull from cards name: External Cards - description: | Requests to create and manage fees name: Fees (beta) paths: /cards/gateways: summary: Authorization Gateway Configuration description: | The Gateway object represents the Authorization gateway configuration. post: tags: - Cards summary: Create Gateway description: | Create a new Authorization Gateway Configuration operationId: createGateway parameters: - $ref: '#/components/parameters/idempotency_key' requestBody: content: application/json: schema: $ref: '#/components/schemas/create_gateway_request' description: Create a new Authorization Gateway Configuration required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/gateway_response' description: New Authorization Gateway Configuration created '400': $ref: '#/components/responses/bad_request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessable_entity' '500': $ref: '#/components/responses/internal_server_error' callbacks: gateway_authorization: '{$request.body#/url}': post: requestBody: content: application/json: schema: $ref: '#/components/schemas/gateway_authorization' required: true responses: '200': description: | Approve the funding request. '402': description: > Decline the funding request. *Note: while HTTP Code 402 is conventional, any code other than 200 will also be interpreted as a decline. method: post type: path path: '{$request.body#/url}' components: parameters: idempotency_key: description: >- An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry. in: header name: Idempotency-Key schema: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 type: string schemas: create_gateway_request: properties: card_products: description: >- List of Card Product unique identifiers that will utilize the Gateway items: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string type: array custom_headers: $ref: '#/components/schemas/gateway_custom_headers' is_active: description: Current status of the Authorization gateway type: boolean standin: $ref: '#/components/schemas/gateway_standin' url: description: URL of the Authorization gateway format: uri maxLength: 1000 type: string required: - card_products - is_active - url type: object gateway_response: properties: card_products: description: >- List of Card Product unique identifiers that will utilize the Gateway items: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string type: array creation_time: description: The timestamp representing when the gateway config request was made example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string custom_headers: $ref: '#/components/schemas/gateway_custom_headers' id: description: Gateway ID example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string is_active: description: Current status of the Authorization gateway type: boolean last_updated_time: description: >- The timestamp representing when the gateway config was last modified at example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string standin: $ref: '#/components/schemas/gateway_standin' tenant: $ref: '#/components/schemas/tenant_id' url: description: URL of the Authorization gateway format: uri maxLength: 1000 type: string required: - card_products - creation_time - id - is_active - last_updated_time - tenant - url type: object gateway_authorization: description: Request sent to gateway for authorization. properties: account_id: description: Unique identifier of the account. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string acquirer_reference_id: type: string amount: $ref: '#/components/schemas/gateway_authorization_amount' balance: $ref: '#/components/schemas/gateway_authorization_balance' banknet_reference_id: type: string bin: $ref: '#/components/schemas/gateway_authorization_bin' card_category: type: string card_format: $ref: '#/components/schemas/gateway_authorization_card_format' card_id: description: Unique identifier of the card. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string customer_id: description: Unique identifier of the customer. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string dc_sign: type: string digital_wallet_token_id: description: Unique identifier of the digital wallet token. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string digital_wallet_token_reference_id: type: string enhanced_transaction: $ref: '#/components/schemas/gateway_authorization_enhanced_transaction' fees: $ref: '#/components/schemas/gateway_authorization_fees' id: description: Unique identifier assigned to each individual request. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string is_surcharge_free: description: Indicates if the transaction is surcharge free. type: boolean last_four: description: Last four digits of the card PAN. example: '1234' type: string merchant: $ref: '#/components/schemas/gateway_authorization_merchant' network: type: string network_fraud: $ref: '#/components/schemas/gateway_authorization_network_fraud' payment_channel: type: string pos: $ref: '#/components/schemas/gateway_authorization_pos' processor: $ref: '#/components/schemas/gateway_authorization_processor' processor_data: description: >- An unstructured JSON blob containing raw transaction data from the processor. type: object settlement_date: example: '2010-05-06T12:23:34.321Z' format: date-time type: string subnetwork: type: string three_ds_authentication_status: enum: - ACQUIRER_EXEMPT - AUTHENTICATED - EXEMPT - NOT_AUTHENTICATED type: string transaction_id: description: Unique identifier of the transaction. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string type: type: string user: $ref: '#/components/schemas/gateway_authorization_user' user_transaction_time: description: The time when the transaction occurred. example: '2010-05-06T12:23:34.321Z' format: date-time type: string verification: $ref: '#/components/schemas/gateway_authorization_verification' required: - account_id - amount - balance - bin - card_format - card_id - customer_id - last_four - merchant - network_fraud - processor - processor_data - settlement_date - subnetwork - transaction_id - type - user - user_transaction_time type: object gateway_custom_headers: additionalProperties: type: string description: > These key-value pairs define custom HTTP headers that will be included in every HTTP request to the gateway. Note that when updating this field, all key-value pairs will be replaced. They are not merged with existing data. type: object gateway_standin: properties: enabled: type: boolean type: object tenant_id: description: | The id of the tenant containing the resource. example: abcdef_ghijkl type: string error: description: Synctera error responses in API v1 implement a custom error schema. properties: code: description: > A machine-readable string that identifies the error for programmatic use. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'Missing required fields: first_name, dob' type: string status: description: HTTP status code for this response example: 400 type: integer title: Synctera error response type: object gateway_authorization_amount: properties: amount: format: int64 type: integer approved_amount: format: int64 type: integer currency: type: string currency_conversion: $ref: '#/components/schemas/gateway_authorization_currency_conversion' total_pending_amount: format: int64 type: integer required: - amount - approved_amount - currency - currency_conversion - total_pending_amount type: object gateway_authorization_balance: properties: available_balance: format: int64 type: integer required: - available_balance type: object gateway_authorization_bin: properties: country_code: type: string id: format: uuid type: string required: - country_code - id type: object gateway_authorization_card_format: enum: - PHYSICAL - VIRTUAL type: string gateway_authorization_enhanced_transaction: properties: category: type: string enhanced_description: type: string enhanced_raw: items: $ref: >- #/components/schemas/gateway_authorization_enhanced_transaction_raw type: array required: - category - enhanced_description - enhanced_raw type: object gateway_authorization_fees: properties: acquirer_user_fee: format: int64 type: integer cross_border_issuer_fee: format: int64 type: integer currency_conversion_issuer_fee: format: int64 type: integer currency_conversion_user_fee: format: int64 type: integer interchange_fee: format: int64 type: integer issuer_fee: format: int64 type: integer network_fee: format: int64 type: integer pindebit_user_fee: format: int64 type: integer type: object gateway_authorization_merchant: properties: city: type: string country_code: type: string mcc: type: string mid: type: string name: type: string payment_facilitator_id: type: string postal_code: type: string state: type: string sub_merchant_id: type: string required: - city - country_code - mcc - mid - name - payment_facilitator_id - postal_code - state - sub_merchant_id type: object gateway_authorization_network_fraud: properties: transaction_risk_score: format: int32 type: integer type: object gateway_authorization_pos: properties: cardholder_verification_method: type: string cvv_presence: type: string pan_entry_mode: type: string pin_entry_mode: type: string pin_present: type: boolean terminal_capability: type: string terminal_id: type: string type: object gateway_authorization_processor: enum: - EPISODE_SIX - MARQETA type: string gateway_authorization_user: properties: metadata: additionalProperties: type: string type: object type: object gateway_authorization_verification: properties: online_security_transaction_code: type: string type: object gateway_authorization_currency_conversion: properties: conversion_rate: format: float type: number dynamic_currency_conversion: type: boolean original_amount: format: int64 type: integer original_currency_code: type: string original_currency_code_alpha: $ref: '#/components/schemas/currency_code' raw_original_amount: format: float type: number settlement_currency_conversion: $ref: >- #/components/schemas/gateway_authorization_settlement_currency_conversion type: object gateway_authorization_enhanced_transaction_raw: properties: amount: format: float nullable: true type: number categorized_by: format: int32 nullable: true type: integer category: nullable: true type: string category_guid: nullable: true type: string described_by: format: int32 nullable: true type: integer description: nullable: true type: string extended_transaction_type: nullable: true type: string id: nullable: true type: string is_bill_pay: nullable: true type: boolean is_direct_deposit: nullable: true type: boolean is_expense: nullable: true type: boolean is_fee: nullable: true type: boolean is_income: nullable: true type: boolean is_international: nullable: true type: boolean is_overdraft_fee: nullable: true type: boolean is_payroll_advance: nullable: true type: boolean is_subscription: nullable: true type: boolean memo: nullable: true type: string merchant_category_code: type: string merchant_guid: nullable: true type: string merchant_location_guid: nullable: true type: string original_description: nullable: true type: string type: nullable: true type: string type: object currency_code: description: ISO 4217 Alpha-3 currency code example: USD maxLength: 3 minLength: 3 type: string gateway_authorization_settlement_currency_conversion: properties: amount: format: int64 type: integer conversion_rate: format: float type: number currency_code: type: string currency_code_alpha: $ref: '#/components/schemas/currency_code' type: object responses: bad_request: content: application/json: schema: $ref: '#/components/schemas/error' description: Bad request unauthorized: content: application/json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/json: schema: $ref: '#/components/schemas/error' description: Forbidden unprocessable_entity: content: application/json: schema: $ref: '#/components/schemas/error' description: Unprocessable entity internal_server_error: content: application/json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````