Skip to main content
GET
/
synctera_pay
/
incoming
/
configurations
/
{id}
Get Incoming Synctera Pay Configuration
curl --request GET \
  --url https://api.synctera.com/v1/synctera_pay/incoming/configurations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "creation_time": "2010-05-06T12:23:34.321Z",
  "currency": "USD",
  "enabled": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "name": "<string>",
  "payer_must_be_payee": true,
  "settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "settlement_account_owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant": "abcdef_ghijkl",
  "transaction_subtype": "INCOMING_INTERNATIONAL_WIRE"
}

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

The unique resource identifier

Example:

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

Response

Incoming Synctera Pay Configuration

​
creation_time
string<date-time>
required

The timestamp representing when the dispute was created

Example:

"2010-05-06T12:23:34.321Z"

​
currency
string
required

ISO 4217 Alpha-3 code representing the currency to be credited to the Synctera account.

Required string length: 3
Example:

"USD"

​
enabled
boolean
required

Determines if this Incoming Synctera Pay Configuration can be used to create new transfers.

​
id
string<uuid>
required

The unique ID of the Incoming Synctera Pay configuration

​
last_updated_time
string<date-time>
required

The timestamp representing when the dispute was last modified

Example:

"2010-05-06T12:23:34.321Z"

​
name
string
required

User-supplied name for the configuration

​
payer_must_be_payee
boolean
required

If true, transfers using this config must have the same payer and payee ("me-to-me") and peer-to-peer transfers can not use this configuration.

​
settlement_account_id
string<uuid>
required

Account used for settlement of all transfers that use this configuration.

​
settlement_account_owner_id
string<uuid>
required

Business or Person that owns the settlement account for all transfers that use this configuration.

​
tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

​
transaction_subtype
enum<string>
required

Transaction sub-type to be recorded in the Synctera ledger for transactions using this configuration.

Available options:
INCOMING_INTERNATIONAL_WIRE