GET
/
synctera_pay
/
configurations
/
{id}
Get Synctera Pay Configuration
curl --request GET \
  --url https://api.synctera.com/v1/synctera_pay/configurations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "description": "This configuration is used for international remittance",
  "details": {
    "currency": "<string>",
    "domestic": true,
    "external_payment_rail": "INTERAC",
    "settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "settlement_account_type": "ACCOUNT",
    "subtypes": [
      "OUTGOING_INTERNATIONAL_REMITTANCE"
    ]
  },
  "enabled": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "International Remittance",
  "rules": {
    "hold_time": 123,
    "required_details": [
      "exchange_details"
    ]
  },
  "tenant": "abcdef_ghijkl"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

ID

Response

Retrieve a Synctera Pay configuration

A Synctera Pay configuration is a configuration that is used when creating a Synctera Pay transfer.

​
details
object
required

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

​
name
string
required
Example:

"International Remittance"

​
rules
object
required

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

​
tenant
string
required

The id of the tenant containing the resource.

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 a Synctera Pay transfer.

​
id
string<uuid>

The ID of the Synctera Pay configuration