Skip to main content
GET
/
synctera_pay
/
configurations
/
{id}
Get Outgoing Synctera Pay Configuration
curl --request GET \
  --url https://api.synctera.com/v2/synctera_pay/configurations/{id}
{
  "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": "INTERNAL_ACCOUNT",
    "subtypes": [
      "OUTGOING_INTERNATIONAL_REMITTANCE"
    ]
  },
  "enabled": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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"
}

Path Parameters

id
string<uuid>
required

The unique resource identifier

Example:

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

Response

Retrieve a Synctera Pay configuration

An Outgoing Synctera Pay configuration is a configuration that is used when creating an outgoing Synctera Pay transfer.

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.

name
string
required
Example:

"International Remittance"

rules
object
required

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

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.

id
string<uuid>

The ID of the Outgoing Synctera Pay configuration