Skip to main content
POST
/
external_cards
/
transfers
/
applepay
Create Apple Pay External Card Transfer
curl --request POST \
  --url https://api.synctera.com/v1/external_cards/transfers/applepay \
  --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",
  "apple_pay_payment": {
    "billing_contact": {
      "address_lines": [
        "<string>"
      ],
      "administrative_area": "<string>",
      "country": "<string>",
      "country_code": "US",
      "email_address": "<string>",
      "family_name": "<string>",
      "given_name": "<string>",
      "locality": "<string>",
      "phone_number": "<string>",
      "phonetic_family_name": "<string>",
      "phonetic_given_name": "<string>",
      "postal_code": "<string>",
      "sub_administrative_area": "<string>",
      "sub_locality": "<string>"
    },
    "shipping_contact": {
      "address_lines": [
        "<string>"
      ],
      "administrative_area": "<string>",
      "country": "<string>",
      "country_code": "US",
      "email_address": "<string>",
      "family_name": "<string>",
      "given_name": "<string>",
      "locality": "<string>",
      "phone_number": "<string>",
      "phonetic_family_name": "<string>",
      "phonetic_given_name": "<string>",
      "postal_code": "<string>",
      "sub_administrative_area": "<string>",
      "sub_locality": "<string>"
    },
    "token": {
      "payment_data": {
        "data": "<string>",
        "header": {
          "application_data": "<string>",
          "ephemeral_public_key": "<string>",
          "public_key_hash": "<string>",
          "transaction_id": "<string>"
        },
        "signature": "<string>",
        "version": "EC_v1"
      },
      "payment_method": {
        "billing_address": {
          "address_lines": [
            "<string>"
          ],
          "administrative_area": "<string>",
          "country": "<string>",
          "country_code": "US",
          "email_address": "<string>",
          "family_name": "<string>",
          "given_name": "<string>",
          "locality": "<string>",
          "phone_number": "<string>",
          "phonetic_family_name": "<string>",
          "phonetic_given_name": "<string>",
          "postal_code": "<string>",
          "sub_administrative_area": "<string>",
          "sub_locality": "<string>"
        },
        "display_name": "<string>",
        "network": "<string>",
        "secure_element_pass": {
          "device_account_identifier": "<string>",
          "device_account_number_suffix": "<string>",
          "device_pass_identifier": "<string>",
          "paired_terminal_identifier": "<string>",
          "pass_activation_state": "activated",
          "primary_account_identifier": "<string>",
          "primary_account_number_suffix": "<string>"
        },
        "type": "credit"
      },
      "transaction_identifier": "<string>"
    }
  },
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}'
{
  "card_details": {
    "address_verification_result": "ADDRESS_AND_ZIP_MISMATCH",
    "cvv2_result": "CVV_MISMATCH",
    "name_verification_result": "NAME_MISMATCH",
    "pull_details": {
      "country": "US",
      "currency": "USD",
      "network": "<string>",
      "product_type": "CREDIT",
      "regulated": true
    },
    "pull_enabled": true,
    "push_details": {
      "country": "US",
      "currency": "USD",
      "funds_availability": "FEW",
      "network": "<string>",
      "product_type": "CREDIT",
      "regulated": true
    },
    "push_enabled": true,
    "bin": "<string>",
    "issuer": "<string>",
    "last_four": "1234",
    "payment_account_reference": "<string>"
  },
  "type": "APPLE_PAY_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 Apple Pay External Card Transfer to create

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

​
apple_pay_payment
object
required

Payload containing payment information, obtained from Apple following payment authorization

​
customer_id
string<uuid>
required

The customer_id of the cardholder

Example:

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

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

Response

Apple Pay External Card Transfer created

​
card_details
object
required
​
type
enum<string>
required

Type of transfer operation

Available options:
APPLE_PAY_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"

​
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