v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
External Cards

List External Card Transfers

Get a paginated list of External Card Transfers

get/external_cards/transfers

Query parameters

typeTransferType[]
[
  "PULL"
]
amountinteger[]
three_ds_idstring[]
originating_account_idstring[]
account_idstring[]
from_creation_timestring date-time
statusTransferStatus[]
originating_customer_idstring[]
from_last_updated_timestring date-time
from_amountinteger
to_last_updated_timestring date-time
to_amountinteger
tenantTenantId[]
[
  "abcdef_ghijkl"
]
page_tokenstring

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

Example:a8937a0d
external_card_idstring[]
transaction_idstring[]
limitinteger

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

Example:100
original_transfer_idstring[]
to_creation_timestring date-time
payment_account_referencestring
customer_idstring[]
idstring[]

Response

External Card Transfer list

next_page_tokenstring

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

Example response

{
  "external_transfers": [
    {
      "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "country_code": "US",
      "created_time": "2010-05-06T12:23:34.321Z",
      "currency": "USD",
      "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "external_card_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_modified_time": "2010-05-06T12:23:34.321Z",
      "merchant": {
        "address": {
          "address_line_1": "100 Main St.",
          "address_line_2": "Suite 99",
          "city": "New York",
          "country_code": "US",
          "postal_code": "49633",
          "state": "NY"
        },
        "email": "alice@example.com",
        "phone_number": "+14374570680"
      },
      "type": "PULL",
      "three_ds_id": "40e2de9e-4375-4fa1-9393-92da972a9338"
    }
  ],
  "next_page_token": "a8937a0d"
}