Skip to main content
POST
/
cards
/
gateways
Create Gateway
curl --request POST \
  --url https://api.synctera.com/v2/cards/gateways \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "card_products": [
    "7d943c51-e4ff-4e57-9558-08cab6b963c7"
  ],
  "is_active": true,
  "url": "<string>",
  "custom_headers": {},
  "standin": {
    "enabled": true
  }
}
'
{
  "card_products": [
    "7d943c51-e4ff-4e57-9558-08cab6b963c7"
  ],
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "is_active": true,
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "tenant": "abcdef_ghijkl",
  "url": "<string>",
  "custom_headers": {},
  "standin": {
    "enabled": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

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.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Create a new Authorization Gateway Configuration

​
card_products
string<uuid>[]
required

List of Card Product unique identifiers that will utilize the Gateway

​
is_active
boolean
required

Current status of the Authorization gateway

​
url
string<uri>
required

URL of the Authorization gateway

Maximum string length: 1000
​
custom_headers
object

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.

​
standin
object

Callbacks

POST
{$request.body#/url}gateway_authorization

Body

application/json

Request sent to gateway for authorization.

​
account_id
string<uuid>
required

Unique identifier of the account.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
amount
object
required
​
balance
object
required
​
bin
object
required
​
card_format
enum<string>
required
Available options:
PHYSICAL,
VIRTUAL
​
card_id
string<uuid>
required

Unique identifier of the card.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
customer_id
string<uuid>
required

Unique identifier of the customer.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
last_four
string
required

Last four digits of the card PAN.

Example:

"1234"

​
merchant
object
required
​
network_fraud
object
required
​
processor
enum<string>
required
Available options:
MARQETA,
EPISODE_SIX
​
processor_data
object
required

An unstructured JSON blob containing raw transaction data from the processor.

​
settlement_date
string<date-time>
required
Example:

"2010-05-06T12:23:34.321Z"

​
subnetwork
string
required
​
transaction_id
string<uuid>
required

Unique identifier of the transaction.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
type
string
required
​
user
object
required
​
user_transaction_time
string<date-time>
required

The time when the transaction occurred.

Example:

"2010-05-06T12:23:34.321Z"

​
acquirer_reference_id
string
​
banknet_reference_id
string
​
card_category
string
​
dc_sign
string
​
digital_wallet_token_id
string<uuid>

Unique identifier of the digital wallet token.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
digital_wallet_token_reference_id
string
​
enhanced_transaction
object
​
fees
object
​
id
string<uuid>

Unique identifier assigned to each individual request.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
is_surcharge_free
boolean

Indicates if the transaction is surcharge free.

​
network
string
​
payment_channel
string
​
pos
object
​
three_ds_authentication_status
enum<string>
Available options:
AUTHENTICATED,
NOT_AUTHENTICATED,
EXEMPT,
ACQUIRER_EXEMPT
​
verification
object

Response

Approve the funding request.

Response

New Authorization Gateway Configuration created

​
card_products
string<uuid>[]
required

List of Card Product unique identifiers that will utilize the Gateway

​
creation_time
string<date-time>
required
read-only

The timestamp representing when the gateway config request was made

Example:

"2010-05-06T12:23:34.321Z"

​
id
string<uuid>
required

Gateway ID

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
is_active
boolean
required

Current status of the Authorization gateway

​
last_updated_time
string<date-time>
required
read-only

The timestamp representing when the gateway config was last modified at

Example:

"2010-05-06T12:23:34.321Z"

​
tenant
string
required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

​
url
string<uri>
required

URL of the Authorization gateway

Maximum string length: 1000
​
custom_headers
object

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.

​
standin
object