Get Outgoing Synctera Pay Configurations

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

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

fetch('https://api.synctera.com/v2/synctera_pay/configurations', 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/configurations",
  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/configurations"

	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/configurations")

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

[
  {
    "details": {
      "currency": "<string>",
      "external_payment_rail": "INTERAC",
      "settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "settlement_account_type": "INTERNAL_ACCOUNT",
      "subtypes": [
        "OUTGOING_INTERNATIONAL_REMITTANCE"
      ],
      "domestic": true
    },
    "name": "International Remittance",
    "rules": {
      "enforce_payee": true,
      "hold_time": 123,
      "payee_account_required": true,
      "peer_to_peer": true,
      "required_details": [
        "exchange_details"
      ]
    },
    "tenant": "abcdef_ghijkl",
    "description": "This configuration is used for international remittance",
    "enabled": true,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

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

configurations

Get Outgoing Synctera Pay Configurations

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

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

fetch('https://api.synctera.com/v2/synctera_pay/configurations', 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/configurations",
  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/configurations"

	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/configurations")

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

[
  {
    "details": {
      "currency": "<string>",
      "external_payment_rail": "INTERAC",
      "settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "settlement_account_type": "INTERNAL_ACCOUNT",
      "subtypes": [
        "OUTGOING_INTERNATIONAL_REMITTANCE"
      ],
      "domestic": true
    },
    "name": "International Remittance",
    "rules": {
      "enforce_payee": true,
      "hold_time": 123,
      "payee_account_required": true,
      "peer_to_peer": true,
      "required_details": [
        "exchange_details"
      ]
    },
    "tenant": "abcdef_ghijkl",
    "description": "This configuration is used for international remittance",
    "enabled": true,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

{
  "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.

Response

Retrieve all Outgoing Synctera Pay configurations

details

Outgoing Synctera Pay Configuration Details · object

required

The details of an outgoing Synctera Pay configuration. This is used to match the Synctera Pay configuration to a Synctera Pay transfer.

Show child attributes

name

string

required

Example:

"International Remittance"

rules

Outgoing Synctera Pay Configuration Rules · object

required

The rules of an outgoing Synctera Pay configuration. This is used when processing a Synctera Pay transfer.

Show child attributes

tenant

string

required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

description

string

Example:

"This configuration is used for international remittance"

enabled

boolean

Whether or not the configuration is enabled. If the configuration is not enabled, it will not be used when creating an Outgoing Synctera Pay transfer.

string<uuid>

read-only

The ID of the Outgoing Synctera Pay configuration

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Get Outgoing Synctera Pay Configurations

Authorizations

Response