Skip to main content
GET
/
external_cards
/
transfers
List External Transfers
curl --request GET \
  --url https://api.synctera.com/v2/external_cards/transfers
{
  "external_transfers": [
    {
      "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": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "country_code": "<string>",
          "postal_code": "<string>",
          "state": "<string>"
        },
        "name": "<string>",
        "email": "[email protected]",
        "phone_number": "+14374570680"
      },
      "status": "SUCCEEDED",
      "tenant": "abcdef_ghijkl",
      "external_card_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "type": "PULL",
      "network_decline_details": "<string>",
      "reason": "<string>",
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "three_ds_id": "40e2de9e-4375-4fa1-9393-92da972a9338"
    }
  ],
  "next_page_token": "a8937a0d"
}

Query Parameters

​
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

​
page_token
string

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

Example:

"a8937a0d"

​
account_id
string<uuid>[]
​
amount
integer[]
​
customer_id
string<uuid>[]
​
external_card_id
string<uuid>[]
​
from_amount
integer
​
from_creation_time
string<date-time>
​
from_last_updated_time
string<date-time>
​
id
string<uuid>[]
​
original_transfer_id
string<uuid>[]
​
originating_account_id
string<uuid>[]
​
originating_customer_id
string<uuid>[]
​
payment_account_reference
string
​
status
enum<string>[]

The status of the transfer

Available options:
SUCCEEDED,
PENDING,
DECLINED,
CANCELED,
UNKNOWN
​
tenant
string[]

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

​
three_ds_id
string<uuid>[]
​
to_amount
integer
​
to_creation_time
string<date-time>
​
to_last_updated_time
string<date-time>
​
transaction_id
string<uuid>[]
​
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:
PUSH,
PULL,
PULL_REVERSAL,
APPLE_PAY_PULL,
APPLE_PAY_PULL_REVERSAL,
GOOGLE_PAY_PULL,
GOOGLE_PAY_PULL_REVERSAL

Response

External Card Transfer list

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

Array of External transfer

Pull funds from an External Card

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