List External Cards

curl --request GET \
  --url https://api-sandbox.synctera.com/v0/external_cards \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.synctera.com/v0/external_cards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.synctera.com/v0/external_cards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "external_cards": [
    {
      "currency": "USD",
      "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "expiration_month": "06",
      "expiration_year": "25",
      "id": "<string>",
      "last_four": "1234",
      "name": "Jean Valjean",
      "status": "ACTIVE",
      "bin": "<string>",
      "created_time": "2010-05-06T12:23:34.321Z",
      "deletion_time": "2010-05-06T12:23:34.321Z",
      "issuer": "<string>",
      "last_modified_time": "2010-05-06T12:23:34.321Z",
      "verifications": {
        "address_verification_result": "ADDRESS_AND_ZIP_MISMATCH",
        "cvv2_result": "CVV_MISMATCH",
        "name_verification_result": "NAME_MISMATCH",
        "pull_enabled": true,
        "push_enabled": true,
        "state": "FAILED",
        "pull_details": {
          "country": "US",
          "currency": "USD",
          "network": "<string>",
          "product_type": "CREDIT",
          "regulated": true
        },
        "push_details": {
          "country": "US",
          "currency": "USD",
          "funds_availability": "FEW",
          "network": "<string>",
          "product_type": "CREDIT",
          "regulated": true
        }
      }
    }
  ],
  "next_page_token": "a8937a0d"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

GET

external_cards

List External Cards

curl --request GET \
  --url https://api-sandbox.synctera.com/v0/external_cards \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.synctera.com/v0/external_cards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.synctera.com/v0/external_cards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "external_cards": [
    {
      "currency": "USD",
      "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "expiration_month": "06",
      "expiration_year": "25",
      "id": "<string>",
      "last_four": "1234",
      "name": "Jean Valjean",
      "status": "ACTIVE",
      "bin": "<string>",
      "created_time": "2010-05-06T12:23:34.321Z",
      "deletion_time": "2010-05-06T12:23:34.321Z",
      "issuer": "<string>",
      "last_modified_time": "2010-05-06T12:23:34.321Z",
      "verifications": {
        "address_verification_result": "ADDRESS_AND_ZIP_MISMATCH",
        "cvv2_result": "CVV_MISMATCH",
        "name_verification_result": "NAME_MISMATCH",
        "pull_enabled": true,
        "push_enabled": true,
        "state": "FAILED",
        "pull_details": {
          "country": "US",
          "currency": "USD",
          "network": "<string>",
          "product_type": "CREDIT",
          "regulated": true
        },
        "push_details": {
          "country": "US",
          "currency": "USD",
          "funds_availability": "FEW",
          "network": "<string>",
          "product_type": "CREDIT",
          "regulated": true
        }
      }
    }
  ],
  "next_page_token": "a8937a0d"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

business_id

string<uuid>[]

payment_account_reference

string[]

name

string[]

name_like

string

Case sensitive wildcard search for name, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.

from_creation_time

string<date-time>

status_neq

enum<string>

Status of an External Card

Available options:

ACTIVE,

DELETED,

SUSPENDED

status

enum<string>[]

Status of an External Card

Available options:

ACTIVE,

DELETED,

SUSPENDED

from_last_updated_time

string<date-time>

from_deletion_time

string<date-time>

last_four

string[]

to_last_updated_time

string<date-time>

tenant

string[]

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

page_token

string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

limit

integer

default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1

Example:

100

to_deletion_time

string<date-time>

to_creation_time

string<date-time>

customer_id

string<uuid>[]

Response

External Card list

external_cards

object[]

required

Array of External Cards

Show child attributes

next_page_token

string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Deprecated

List External Cards

Authorizations

Query Parameters

Response