> ## Documentation Index > Fetch the complete documentation index at: https://docs.synctera.com/llms.txt > Use this file to discover all available pages before exploring further. # List External Card Transfers > Get a paginated list of External Card Transfers ## OpenAPI ````yaml openapi.json get /external_cards/transfers openapi: 3.0.3 info: description: >- This is the official reference documentation for Synctera APIs. If you need something specific or have a question, contact us.

license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: 0.208.0 servers: - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v0 - description: Production url: https://api.synctera.com/v0 security: - bearerAuth: [] tags: - description: Lookup merchant information name: Merchants - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Requests to link and manage External Cards name: External Cards - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Request to create and manage users name: Users - description: See balance history name: BalanceHistory - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: Requests to create and manage webhooks name: Webhooks - description: Create and manage documents. name: Documents - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: Requests for transaction risk detection name: Transaction risk - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to manage addresses name: Addresses - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to create and manage customers name: Customers - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Create and manage spending controls name: Spend Controls - description: Retrieve user identity information name: Identity - description: Requests to manage banks name: Banks - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: Create and manage wire transfers name: Wires - description: Requests to issue and manage Cards name: Cards - description: Request to create and manage edd name: Trust - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Transaction lines API name: transactions - description: Request to create and manage accounts name: Accounts - description: Requests to create and manage notes name: Notes - description: Account Template name: Account Templates - description: API for effective balances name: effective_balances - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: > A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business. name: Persons - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: Request to create and manage payment_schedules name: Cronut - description: Requests to manage partners name: Partners - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: Requests to create and manage API keys name: API Keys - description: Requests to create and manage ban rules name: Ban Rules - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: Request to create and manage exclusions name: Stately - description: Request to create and manage partner configurations name: Quickstart - description: Manage contacts for bank and fintech partners name: Contacts - description: Create and manage transactions name: Transactions - description: Request to create and manage rdc configurations name: RDC Config - description: Create and manage holds name: Hold - description: Requests to create and manage roles name: Roles - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: Requests to create licenses name: Licenses - description: Requests to Admins to grant permissions to user name: Request Permissions - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Create and manage payments name: ACH - description: Requests to calculate and manage CRR name: CRR - description: Requests to search financial institutions name: Institutions (Beta) - description: Create and manage tenant configurations name: Tenant Configs - description: Create and manage sweep configurations name: Configs - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: Create and manage transactions name: Transactions (internal) - description: History name: History - description: Create and manage EFT Canada transfers name: EFT Canada (Beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Requests to initiate customer verification. name: KYC/KYB Verifications paths: /external_cards/transfers: get: tags: - External Cards summary: List External Card Transfers description: | Get a paginated list of External Card Transfers operationId: listExternalCardTransfers parameters: - explode: false in: query name: type schema: items: $ref: '#/components/schemas/transfer_type' type: array style: form - explode: false in: query name: amount schema: items: type: integer type: array style: form - explode: false in: query name: three_ds_id schema: items: format: uuid type: string type: array style: form - explode: false in: query name: originating_account_id schema: items: format: uuid type: string type: array style: form - explode: false in: query name: account_id schema: items: format: uuid type: string type: array style: form - in: query name: from_creation_time schema: format: date-time type: string - explode: false in: query name: status schema: items: $ref: '#/components/schemas/transfer_status' type: array style: form - explode: false in: query name: originating_customer_id schema: items: format: uuid type: string type: array style: form - in: query name: from_last_updated_time schema: format: date-time type: string - in: query name: from_amount schema: type: integer - in: query name: to_last_updated_time schema: format: date-time type: string - in: query name: to_amount schema: type: integer - explode: false in: query name: tenant schema: items: $ref: '#/components/schemas/tenant_id' type: array style: form - $ref: '#/components/parameters/page_token' - explode: false in: query name: external_card_id schema: items: format: uuid type: string type: array style: form - explode: false in: query name: transaction_id schema: items: format: uuid type: string type: array style: form - $ref: '#/components/parameters/limit' - explode: false in: query name: original_transfer_id schema: items: format: uuid type: string type: array style: form - in: query name: to_creation_time schema: format: date-time type: string - in: query name: payment_account_reference schema: type: string - explode: false in: query name: customer_id schema: items: format: uuid type: string type: array style: form - explode: false in: query name: id schema: items: format: uuid type: string type: array style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/transfer_list_response' description: External Card Transfer list '400': $ref: '#/components/responses/bad_request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessable_entity' '500': $ref: '#/components/responses/internal_server_error' components: schemas: transfer_type: description: | Type of operation for transfer. Type | Description --- | --- PUSH | Push fund to the external card from the account_id PULL | Pull funds from the external card to the account_id PULL_REVERSAL | Reversed pull funds transfer from an external card enum: - PULL - PULL_REVERSAL - PUSH example: PULL type: string transfer_status: description: The status of the transfer enum: - CANCELED - DECLINED - PENDING - SUCCEEDED - UNKNOWN type: string tenant_id: description: > The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces. example: abcdef_ghijkl type: string transfer_list_response: allOf: - properties: external_transfers: description: Array of External transfer items: $ref: '#/components/schemas/transfer_response' type: array required: - external_transfers type: object - $ref: '#/components/schemas/paginated_response' transfer_response: discriminator: mapping: PULL: $ref: '#/components/schemas/transfer_response_pull' PULL_REVERSAL: $ref: '#/components/schemas/transfer_response_pull' PUSH: $ref: '#/components/schemas/transfer_response_push' propertyName: type oneOf: - $ref: '#/components/schemas/transfer_response_pull' - $ref: '#/components/schemas/transfer_response_push' type: object paginated_response: properties: next_page_token: description: >- 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 type: string title: Paginated List response type: object error: description: >- Synctera error responses in API v0 follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807). Following that standard, the field for a machine-readable "error code" in API v0 is `type`. In our future API v1, we are phasing out RFC 7807 and adopting a custom error format. That format will be documented in our API v1 spec. But you may see some v0 error responses with a machine-readable `code` field while we are making the transition from v0 to v1. properties: code: description: >- An optional “sneak preview” of our future API v1 error responses. This is provided to give integrators a chance to work with our future error codes. Error codes for the same error may change between v0 and v1. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'missing required fields: first_name, dob' type: string status: description: the HTTP status code for this response example: 400 type: integer title: description: > A human-readable string for this general category of error, which corresponds 1-to-1 with error types (`title` is the human-readable version of `type`). There can be multiple distinct titles for the same HTTP status code, and the same `title` can result in many different `detail` strings. This field will be removed in API v1. example: Bad Request Body type: string type: description: > A machine-readable string that identifies the error for programmatic use. This is a URI, i.e. a globally unique identifier. It is _not_ necessarily a URL, so do not expect it to resolve to a web page. You can use this whole string as an error code, or just everything after the last slash. This field will be removed in API v1. example: https://dev.synctera.com/errors/bad-request-body type: string title: Standard error response (RFC 7807 problem report) type: object transfer_response_pull: allOf: - $ref: '#/components/schemas/transfer_response_base' - properties: three_ds_id: description: >- Unique identifier of an External Card Transfer 3-D Secure Authorization - conditionally required according to your program's 3DS policy example: 40e2de9e-4375-4fa1-9393-92da972a9338 format: uuid type: string type: object description: Pull funds from an External Card title: Pull Response type: object transfer_response_push: allOf: - properties: originating_customer_id: description: >- For person-to-person PUSH transactions, this is the `customer_id` of the sender who must have privileges to access funds in the originating account in order to send funds to the recipient cardholder example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string type: object - $ref: '#/components/schemas/transfer_response_base' description: Push funds to an External Card title: Push Response type: object transfer_response_base: properties: account_id: description: The ID of the account to which the card will be linked example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string amount: description: Amount of the transfer in cents type: integer country_code: description: ISO-3166-1 Alpha-2 country code example: US type: string created_time: example: '2010-05-06T12:23:34.321Z' format: date-time type: string currency: $ref: '#/components/schemas/currency_code' customer_id: description: The ID of the customer to whom the card belongs example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string external_card_id: description: >- The ID of the external card from/to which the transfer was initiated/received example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string id: description: The ID of the transfer type: string last_modified_time: example: '2010-05-06T12:23:34.321Z' format: date-time type: string merchant: $ref: '#/components/schemas/merchant' network_decline_details: description: >- If available, a human readable string indicating why a transfer was declined downstream of our system type: string reason: description: >- The reason for the status, e.g. INSUFFICIENT_FUNDS, SUSPECTED_FRAUD, NETWORK_DECLINED type: string status: $ref: '#/components/schemas/transfer_status' transaction_id: description: The transaction ID format: uuid type: string type: $ref: '#/components/schemas/transfer_type' required: - account_id - amount - country_code - created_time - currency - customer_id - external_card_id - id - last_modified_time - merchant - status - type type: object currency_code: description: ISO 4217 Alpha-3 currency code example: USD maxLength: 3 minLength: 3 type: string merchant: description: >- Merchant descriptor information that will be shown on statement and transaction details. If not provided, FinTech information will be used. properties: address: $ref: '#/components/schemas/address1' email: description: Merchant's email example: alice@example.com type: string name: description: Merchant's name type: string phone_number: description: >- Merchant's phone number with country code in E.164 format. Must have a valid country code. Area code and local phone number are not validated. example: '+14374570680' pattern: ^\+[1-9]\d{1,14}$ type: string required: - address - name type: object address1: properties: address_line_1: description: Street address line 1 example: 100 Main St. maxLength: 100 type: string address_line_2: description: Street address line 2 example: Suite 99 maxLength: 100 type: string city: description: City example: New York type: string country_code: description: ISO-3166-1 Alpha-2 country code example: US type: string postal_code: description: Postal code example: '49633' type: string state: description: State, region, province, or prefecture example: NY type: string required: - address_line_1 - city - country_code - postal_code - state type: object parameters: page_token: in: query name: page_token schema: description: >- Optional pagination token to be provided to retrieve subsequent pages, returned from previous get example: a8937a0d type: string limit: in: query name: limit schema: default: 100 description: > Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100. example: 100 minimum: 1 type: integer responses: bad_request: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: BadRequest unauthorized: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Forbidden error unprocessable_entity: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unprocessable entity request response internal_server_error: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````