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,
"originating_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"apple_pay_payment": {
"token": {
"payment_data": {
"data": "<string>",
"header": {
"ephemeral_public_key": "<string>",
"public_key_hash": "<string>",
"transaction_id": "<string>",
"application_data": "<string>"
},
"signature": "<string>"
},
"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>"
},
"transaction_identifier": "<string>"
},
"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>"
}
},
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"tenant": "abcdef_ghijkl"
}
'import requests
url = "https://api.synctera.com/v1/external_cards/transfers/applepay"
payload = {
"amount": 2,
"originating_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"apple_pay_payment": {
"token": {
"payment_data": {
"data": "<string>",
"header": {
"ephemeral_public_key": "<string>",
"public_key_hash": "<string>",
"transaction_id": "<string>",
"application_data": "<string>"
},
"signature": "<string>"
},
"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>"
},
"transaction_identifier": "<string>"
},
"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>"
}
},
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"tenant": "abcdef_ghijkl"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 2,
originating_account_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
apple_pay_payment: {
token: {
payment_data: {
data: '<string>',
header: {
ephemeral_public_key: '<string>',
public_key_hash: '<string>',
transaction_id: '<string>',
application_data: '<string>'
},
signature: '<string>'
},
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>'
},
transaction_identifier: '<string>'
},
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>'
}
},
customer_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
tenant: 'abcdef_ghijkl'
})
};
fetch('https://api.synctera.com/v1/external_cards/transfers/applepay', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.synctera.com/v1/external_cards/transfers/applepay",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 2,
'originating_account_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'apple_pay_payment' => [
'token' => [
'payment_data' => [
'data' => '<string>',
'header' => [
'ephemeral_public_key' => '<string>',
'public_key_hash' => '<string>',
'transaction_id' => '<string>',
'application_data' => '<string>'
],
'signature' => '<string>'
],
'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>'
],
'transaction_identifier' => '<string>'
],
'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>'
]
],
'customer_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'tenant' => 'abcdef_ghijkl'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.synctera.com/v1/external_cards/transfers/applepay"
payload := strings.NewReader("{\n \"amount\": 2,\n \"originating_account_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"apple_pay_payment\": {\n \"token\": {\n \"payment_data\": {\n \"data\": \"<string>\",\n \"header\": {\n \"ephemeral_public_key\": \"<string>\",\n \"public_key_hash\": \"<string>\",\n \"transaction_id\": \"<string>\",\n \"application_data\": \"<string>\"\n },\n \"signature\": \"<string>\"\n },\n \"payment_method\": {\n \"billing_address\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n },\n \"display_name\": \"<string>\",\n \"network\": \"<string>\"\n },\n \"transaction_identifier\": \"<string>\"\n },\n \"billing_contact\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n },\n \"shipping_contact\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n }\n },\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"tenant\": \"abcdef_ghijkl\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.synctera.com/v1/external_cards/transfers/applepay")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 2,\n \"originating_account_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"apple_pay_payment\": {\n \"token\": {\n \"payment_data\": {\n \"data\": \"<string>\",\n \"header\": {\n \"ephemeral_public_key\": \"<string>\",\n \"public_key_hash\": \"<string>\",\n \"transaction_id\": \"<string>\",\n \"application_data\": \"<string>\"\n },\n \"signature\": \"<string>\"\n },\n \"payment_method\": {\n \"billing_address\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n },\n \"display_name\": \"<string>\",\n \"network\": \"<string>\"\n },\n \"transaction_identifier\": \"<string>\"\n },\n \"billing_contact\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n },\n \"shipping_contact\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n }\n },\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"tenant\": \"abcdef_ghijkl\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v1/external_cards/transfers/applepay")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 2,\n \"originating_account_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"apple_pay_payment\": {\n \"token\": {\n \"payment_data\": {\n \"data\": \"<string>\",\n \"header\": {\n \"ephemeral_public_key\": \"<string>\",\n \"public_key_hash\": \"<string>\",\n \"transaction_id\": \"<string>\",\n \"application_data\": \"<string>\"\n },\n \"signature\": \"<string>\"\n },\n \"payment_method\": {\n \"billing_address\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n },\n \"display_name\": \"<string>\",\n \"network\": \"<string>\"\n },\n \"transaction_identifier\": \"<string>\"\n },\n \"billing_contact\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n },\n \"shipping_contact\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n }\n },\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"tenant\": \"abcdef_ghijkl\"\n}"
response = http.request(request)
puts response.read_body{
"card_details": {
"pull_details": {
"country": "US",
"currency": "USD",
"network": "<string>",
"regulated": true
},
"pull_enabled": true,
"push_details": {
"country": "US",
"currency": "USD",
"network": "<string>",
"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.",
"city": "New York",
"country_code": "US",
"postal_code": "49633",
"state": "NY",
"address_line_2": "Suite 99"
},
"name": "<string>",
"email": "alice@example.com",
"phone_number": "+14374570680"
},
"tenant": "abcdef_ghijkl",
"network_decline_details": "<string>",
"reason": "<string>",
"transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}External Cards
Create Apple Pay External Card Transfer
🚧 Alpha Apple Pay transfers is currently in Alpha release and spec is subject to change.
Create External Card Transfer using an Apple Pay card
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,
"originating_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"apple_pay_payment": {
"token": {
"payment_data": {
"data": "<string>",
"header": {
"ephemeral_public_key": "<string>",
"public_key_hash": "<string>",
"transaction_id": "<string>",
"application_data": "<string>"
},
"signature": "<string>"
},
"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>"
},
"transaction_identifier": "<string>"
},
"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>"
}
},
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"tenant": "abcdef_ghijkl"
}
'import requests
url = "https://api.synctera.com/v1/external_cards/transfers/applepay"
payload = {
"amount": 2,
"originating_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"apple_pay_payment": {
"token": {
"payment_data": {
"data": "<string>",
"header": {
"ephemeral_public_key": "<string>",
"public_key_hash": "<string>",
"transaction_id": "<string>",
"application_data": "<string>"
},
"signature": "<string>"
},
"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>"
},
"transaction_identifier": "<string>"
},
"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>"
}
},
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"tenant": "abcdef_ghijkl"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 2,
originating_account_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
apple_pay_payment: {
token: {
payment_data: {
data: '<string>',
header: {
ephemeral_public_key: '<string>',
public_key_hash: '<string>',
transaction_id: '<string>',
application_data: '<string>'
},
signature: '<string>'
},
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>'
},
transaction_identifier: '<string>'
},
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>'
}
},
customer_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
tenant: 'abcdef_ghijkl'
})
};
fetch('https://api.synctera.com/v1/external_cards/transfers/applepay', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.synctera.com/v1/external_cards/transfers/applepay",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 2,
'originating_account_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'apple_pay_payment' => [
'token' => [
'payment_data' => [
'data' => '<string>',
'header' => [
'ephemeral_public_key' => '<string>',
'public_key_hash' => '<string>',
'transaction_id' => '<string>',
'application_data' => '<string>'
],
'signature' => '<string>'
],
'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>'
],
'transaction_identifier' => '<string>'
],
'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>'
]
],
'customer_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'tenant' => 'abcdef_ghijkl'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.synctera.com/v1/external_cards/transfers/applepay"
payload := strings.NewReader("{\n \"amount\": 2,\n \"originating_account_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"apple_pay_payment\": {\n \"token\": {\n \"payment_data\": {\n \"data\": \"<string>\",\n \"header\": {\n \"ephemeral_public_key\": \"<string>\",\n \"public_key_hash\": \"<string>\",\n \"transaction_id\": \"<string>\",\n \"application_data\": \"<string>\"\n },\n \"signature\": \"<string>\"\n },\n \"payment_method\": {\n \"billing_address\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n },\n \"display_name\": \"<string>\",\n \"network\": \"<string>\"\n },\n \"transaction_identifier\": \"<string>\"\n },\n \"billing_contact\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n },\n \"shipping_contact\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n }\n },\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"tenant\": \"abcdef_ghijkl\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.synctera.com/v1/external_cards/transfers/applepay")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 2,\n \"originating_account_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"apple_pay_payment\": {\n \"token\": {\n \"payment_data\": {\n \"data\": \"<string>\",\n \"header\": {\n \"ephemeral_public_key\": \"<string>\",\n \"public_key_hash\": \"<string>\",\n \"transaction_id\": \"<string>\",\n \"application_data\": \"<string>\"\n },\n \"signature\": \"<string>\"\n },\n \"payment_method\": {\n \"billing_address\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n },\n \"display_name\": \"<string>\",\n \"network\": \"<string>\"\n },\n \"transaction_identifier\": \"<string>\"\n },\n \"billing_contact\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n },\n \"shipping_contact\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n }\n },\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"tenant\": \"abcdef_ghijkl\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v1/external_cards/transfers/applepay")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 2,\n \"originating_account_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"apple_pay_payment\": {\n \"token\": {\n \"payment_data\": {\n \"data\": \"<string>\",\n \"header\": {\n \"ephemeral_public_key\": \"<string>\",\n \"public_key_hash\": \"<string>\",\n \"transaction_id\": \"<string>\",\n \"application_data\": \"<string>\"\n },\n \"signature\": \"<string>\"\n },\n \"payment_method\": {\n \"billing_address\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n },\n \"display_name\": \"<string>\",\n \"network\": \"<string>\"\n },\n \"transaction_identifier\": \"<string>\"\n },\n \"billing_contact\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n },\n \"shipping_contact\": {\n \"address_lines\": [\n \"<string>\"\n ],\n \"administrative_area\": \"<string>\",\n \"country\": \"<string>\",\n \"country_code\": \"US\",\n \"email_address\": \"<string>\",\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"locality\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phonetic_family_name\": \"<string>\",\n \"phonetic_given_name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"sub_administrative_area\": \"<string>\",\n \"sub_locality\": \"<string>\"\n }\n },\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"tenant\": \"abcdef_ghijkl\"\n}"
response = http.request(request)
puts response.read_body{
"card_details": {
"pull_details": {
"country": "US",
"currency": "USD",
"network": "<string>",
"regulated": true
},
"pull_enabled": true,
"push_details": {
"country": "US",
"currency": "USD",
"network": "<string>",
"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.",
"city": "New York",
"country_code": "US",
"postal_code": "49633",
"state": "NY",
"address_line_2": "Suite 99"
},
"name": "<string>",
"email": "alice@example.com",
"phone_number": "+14374570680"
},
"tenant": "abcdef_ghijkl",
"network_decline_details": "<string>",
"reason": "<string>",
"transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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 of the transfer in cents (USD)
Required range:
x >= 1The ID of the account to which the transfer will be initiated/received
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Payload containing payment information, obtained from Apple following payment authorization
Show child attributes
Show child attributes
The customer_id of the cardholder
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Merchant descriptor information that will be shown on statement and transaction details. If not provided, FinTech information will be used.
Show child attributes
Show child attributes
The id of the tenant containing the resource.
Example:
"abcdef_ghijkl"
Response
Apple Pay External Card Transfer created
Show child attributes
Show child attributes
Type of transfer operation
Available options:
APPLE_PAY_PULL The ID of the Synctera account into which or from which funds were moved
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Amount of the transfer in cents
Example:
"2010-05-06T12:23:34.321Z"
ISO 4217 Alpha-3 currency code
Required string length:
3Example:
"USD"
The customer_id of the cardholder
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
The ID of the transfer
Example:
"2010-05-06T12:23:34.321Z"
Merchant descriptor information that will be shown on statement and transaction details. If not provided, FinTech information will be used.
Show child attributes
Show child attributes
The status of the transfer
Available options:
CANCELED, DECLINED, PENDING, SUCCEEDED, UNKNOWN The id of the tenant containing the resource.
Example:
"abcdef_ghijkl"
If available, a human readable string indicating why a transfer was declined downstream of our system
The reason for the status, e.g. INSUFFICIENT_FUNDS, SUSPECTED_FRAUD, NETWORK_DECLINED
The transaction ID
Was this page helpful?
⌘I