Skip to main content
GET
/
external_cards
/
transfers
List External Transfers
curl --request GET \
  --url https://api.synctera.com/v1/external_cards/transfers \
  --header 'Authorization: Bearer <token>'
{
  "external_transfers": [
    {
      "card_details": {
        "pull_details": {
          "country": "US",
          "currency": "USD",
          "network": "<string>",
          "regulated": true
        },
        "pull_enabled": true,
        "push_details": {
          "country": "US",
          "currency": "USD",
          "network": "<string>",
          "regulated": true
        },
        "push_enabled": true,
        "bin": "<string>",
        "issuer": "<string>",
        "last_four": "1234",
        "payment_account_reference": "<string>"
      },
      "type": "PULL",
      "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "amount": 123,
      "creation_time": "2010-05-06T12:23:34.321Z",
      "currency": "USD",
      "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "id": "<string>",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "merchant": {
        "address": {
          "address_line_1": "100 Main St.",
          "city": "New York",
          "country_code": "US",
          "postal_code": "49633",
          "state": "NY",
          "address_line_2": "Suite 99"
        },
        "name": "<string>",
        "email": "alice@example.com",
        "phone_number": "+14374570680"
      },
      "tenant": "abcdef_ghijkl",
      "network_decline_details": "<string>",
      "reason": "<string>",
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "next_page_token": "a8937a0d"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
type
enum<string>[]

Type of transfer operation.

TypeDescription
PUSHFunds pushed to an External Card from an Account
PULLFunds pulled from an External Card to an Account
PULL_REVERSALFunds pushed back to an External Card from an Account
APPLE_PAY_PULLFunds pulled from an Apple Pay card to an Account
APPLE_PAY_PULL_REVERSALFunds returned to Apple Pay card from original recipient Account
GOOGLE_PAY_PULLPull funds from a Google Pay card to an Account
GOOGLE_PAY_PULL_REVERSALFunds returned to Google Pay card from original recipient Account
Available options:
APPLE_PAY_PULL,
APPLE_PAY_PULL_REVERSAL,
GOOGLE_PAY_PULL,
GOOGLE_PAY_PULL_REVERSAL,
PULL,
PULL_REVERSAL,
PUSH
​
amount
integer[]
​
three_ds_id
string<uuid>[]
​
originating_account_id
string<uuid>[]
​
account_id
string<uuid>[]
​
from_creation_time
string<date-time>
​
status
enum<string>[]

The status of the transfer

Available options:
CANCELED,
DECLINED,
PENDING,
SUCCEEDED,
UNKNOWN
​
originating_customer_id
string<uuid>[]
​
from_last_updated_time
string<date-time>
​
from_amount
integer
​
to_last_updated_time
string<date-time>
​
to_amount
integer
​
tenant
string[]

The id of the tenant containing the resource.

​
page_token
string

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

Example:

"a8937a0d"

​
external_card_id
string<uuid>[]
​
transaction_id
string<uuid>[]
​
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

​
original_transfer_id
string<uuid>[]
​
to_creation_time
string<date-time>
​
payment_account_reference
string
​
customer_id
string<uuid>[]
​
id
string<uuid>[]

Response

External Card Transfer list

​
external_transfers
(Token Response · object | Pull Response · object | Push Response · object)[]
required

Array of External transfer

​
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"