Get Outgoing Synctera Pay Transfers

curl --request GET \
  --url https://api.synctera.com/v2/synctera_pay \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.synctera.com/v2/synctera_pay', 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/v2/synctera_pay",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synctera.com/v2/synctera_pay"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/synctera_pay")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "transfers": [
    {
      "amount": 10000,
      "currency": "USD",
      "dc_sign": "CREDIT",
      "direction": "OUTGOING",
      "subtype": "OUTGOING_INTERNATIONAL_REMITTANCE",
      "synctera_pay_network": "WISE",
      "effective_date": "2022-03-18",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_same_day": true,
      "status": "POSTED",
      "tenant_id": "abcdef_ghijkl",
      "configuration_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "exchange_details": {
        "rate": 1.30445,
        "source_amount": 10000,
        "source_currency": "USD",
        "target_amount": 10000,
        "target_currency": "GBP",
        "fees": [
          {
            "currency": "<string>",
            "fee_type": "FX",
            "amount": 2,
            "description": "<string>",
            "percentage": "<string>"
          }
        ]
      },
      "final_external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_data": {},
      "synctera_pay_vendor_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "customer_id": "46fec39e-e776-4571-bf90-d0e1d15172fe",
      "destination_account_id": "fccb4a46-1261-4e91-b622-73b5b946183d",
      "destination_account_owner_name": "<string>",
      "failed": false,
      "history": [
        {
          "data": {},
          "message": "<string>",
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "network_status": "POSTED",
      "original_reference_id": "<string>",
      "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "originating_account_owner_name": "<string>",
      "posting_date": "2022-03-18",
      "reference_id": "<string>",
      "suspended": false,
      "transaction_id": "45b5246f-ad97-4629-9aac-465b74a05505"
    }
  ],
  "next_page_token": "a8937a0d"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

GET

synctera_pay

Get Outgoing Synctera Pay Transfers

curl --request GET \
  --url https://api.synctera.com/v2/synctera_pay \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.synctera.com/v2/synctera_pay', 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/v2/synctera_pay",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synctera.com/v2/synctera_pay"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/synctera_pay")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "transfers": [
    {
      "amount": 10000,
      "currency": "USD",
      "dc_sign": "CREDIT",
      "direction": "OUTGOING",
      "subtype": "OUTGOING_INTERNATIONAL_REMITTANCE",
      "synctera_pay_network": "WISE",
      "effective_date": "2022-03-18",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_same_day": true,
      "status": "POSTED",
      "tenant_id": "abcdef_ghijkl",
      "configuration_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "exchange_details": {
        "rate": 1.30445,
        "source_amount": 10000,
        "source_currency": "USD",
        "target_amount": 10000,
        "target_currency": "GBP",
        "fees": [
          {
            "currency": "<string>",
            "fee_type": "FX",
            "amount": 2,
            "description": "<string>",
            "percentage": "<string>"
          }
        ]
      },
      "final_external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_data": {},
      "synctera_pay_vendor_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "customer_id": "46fec39e-e776-4571-bf90-d0e1d15172fe",
      "destination_account_id": "fccb4a46-1261-4e91-b622-73b5b946183d",
      "destination_account_owner_name": "<string>",
      "failed": false,
      "history": [
        {
          "data": {},
          "message": "<string>",
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "network_status": "POSTED",
      "original_reference_id": "<string>",
      "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "originating_account_owner_name": "<string>",
      "posting_date": "2022-03-18",
      "reference_id": "<string>",
      "suspended": false,
      "transaction_id": "45b5246f-ad97-4629-9aac-465b74a05505"
    }
  ],
  "next_page_token": "a8937a0d"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

string<uuid>

Synctera Pay Transfer ID

customer_id

string<uuid>

Customer ID of the transfer

originating_account_id

string<uuid>

Originating account ID

Example:

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

destination_account_id

string<uuid>

Destination account ID

Example:

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

originating_account_owner_name

string

Originating account owner name

destination_account_owner_name

string

Destination account owner name

Example:

"Jane Joe"

status

string

Status of the transfer

network_status

string

Network status of the transfer

subtype

string

Subtype of the transfer

dc_sign

string

DC sign of the transfer

effective_date

string

Effective date of the transfer

from_effective_date

string

From effective date of the transfer

to_effective_date

string

To effective date of the transfer

posting_date

string

Posting date of the transfer

from_posting_date

string

From posting date of the transfer

to_posting_date

string

To posting date of the transfer

amount

string

Query transfers with the exact amount in minor units (ie cents)

Example:

100

min_amount

integer

Query transfers with at least this amount in minor units (ie cents)

Required range: x >= 1

Example:

100

max_amount

integer

Query transfers with at most this amount in minor units (ie cents)

Required range: x >= 1

Example:

100

currency

string

Currency of the transfer

Example:

"USD"

reference_id

string

Reference ID of the transfer

is_same_day

boolean

Is same day transfer

Response

Retrieve all Outgoing Synctera Pay transfers

transfers

Outgoing Synctera Pay Transfer Response · object[]

required

Array of Outgoing Synctera Pay transfers.

Show child attributes

next_page_token

string

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"

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Get Outgoing Synctera Pay Transfers

Authorizations

Query Parameters

Response