POST
/
external_cards
/
transfers
Create External Card Transfer
curl --request POST \
  --url https://api.synctera.com/v1/external_cards/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 2,
  "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",
    "name": "<string>",
    "phone_number": "+14374570680"
  },
  "originating_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "tenant": "abcdef_ghijkl",
  "external_card_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "originating_customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "type": "PULL"
}'
{
  "external_card_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "originating_customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "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.",
      "address_line_2": "Suite 99",
      "city": "New York",
      "country_code": "US",
      "postal_code": "49633",
      "state": "NY"
    },
    "email": "alice@example.com",
    "name": "<string>",
    "phone_number": "+14374570680"
  },
  "network_decline_details": "<string>",
  "reason": "<string>",
  "status": "CANCELED",
  "tenant": "abcdef_ghijkl",
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Details of the External Card Transfer to create

Push/pull funds to/from an External Card

​
amount
integer
required

Amount of the transfer in cents (USD)

Required range: x >= 1
​
originating_account_id
string<uuid>
required

The ID of the account to which the transfer will be initiated/received

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
external_card_id
string<uuid>
required

The ID of the External Card associated with the operation

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
type
enum<string>
required

Type of transfer operation.

TypeDescription
PUSHPush funds to an External Card from an Account
PULLPull funds from an External Card to an Account
Available options:
PULL,
PUSH
Example:

"PULL"

​
merchant
object

Merchant descriptor information that will be shown on statement and transaction details. If not provided, FinTech information will be used.

​
tenant
string

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

​
originating_customer_id
string<uuid>

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"

Response

External Card Transfer created

​
external_card_id
string<uuid>
required

The ID of the External Card associated with the operation

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
type
enum<string>
required

Type of transfer operation.

TypeDescription
PUSHPush funds to an External Card from an Account
PULLPull funds from an External Card to an Account
Available options:
PULL,
PUSH
Example:

"PULL"

​
account_id
string<uuid>
required

The ID of the Synctera account into which or from which funds were moved

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
amount
integer
required

Amount of the transfer in cents

​
creation_time
string<date-time>
required
Example:

"2010-05-06T12:23:34.321Z"

​
currency
string
required

ISO 4217 Alpha-3 currency code

Required string length: 3
Example:

"USD"

​
customer_id
string<uuid>
required

The customer_id of the cardholder

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
id
string
required

The ID of the transfer

​
last_updated_time
string<date-time>
required
Example:

"2010-05-06T12:23:34.321Z"

​
merchant
object
required

Merchant descriptor information that will be shown on statement and transaction details. If not provided, FinTech information will be used.

​
status
enum<string>
required

The status of the transfer

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

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

​
originating_customer_id
string<uuid>

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"

​
network_decline_details
string

If available, a human readable string indicating why a transfer was declined downstream of our system

​
reason
string

The reason for the status, e.g. INSUFFICIENT_FUNDS, SUSPECTED_FRAUD, NETWORK_DECLINED

​
transaction_id
string<uuid>

The transaction ID