Skip to main content
POST
/
synctera_pay
/
incoming
/
transfers
Create Incoming Synctera Pay Transfer
curl --request POST \
  --url https://api.synctera.com/v2/synctera_pay/incoming/transfers \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{
  "amount": 2,
  "configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "destination_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_data": {},
  "payee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference_id": "<string>",
  "settlement_date": "2023-12-25",
  "source_external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "amount": 2,
  "configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "destination_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_data": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "payee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference_id": "<string>",
  "settlement_date": "2023-12-25",
  "source_external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "CREATE_HOLD",
  "tenant": "abcdef_ghijkl",
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Headers

​
Idempotency-Key
string
required

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

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

Body

application/json

Attributes of the Synctera Pay transfer

​
amount
integer
required

The amount in the source currency's minor unit. For example, 10000 would be $100 for USD.

Required range: x >= 1
​
configuration_id
string<uuid>
required

The ID of the Incoming Synctera Pay configuration to be used for this transfer

​
destination_account_id
string<uuid>
required

The ID of the account in the Synctera Platform that will receive the funds for this transfer.

​
payee_id
string<uuid>
required

The ID of the person or business customer in the Synctera Platform that is the receiver of the this transfer.

​
payer_id
string<uuid>
required

The ID of the person or business in the Synctera Platform that is the originator of the this transfer. Depending on the configuration being used, this does not necessarily need to be a customer.

​
reference_id
string
required

The unique network reference ID assigned to the transfer by the FinTech. This will be copied to the reference_id of the related ledger transaction.

Minimum length: 1
​
settlement_date
string<date>
required
​
source_external_account_id
string<uuid>
required

The ID of the external account in the Synctera Platform that is the ultimate source of funds for this transfer.

​
external_data
object

External Data for FinTech use, copied to ledger transactions related to this transfer.

Response

Successful creation of a Synctera Pay transfer

​
amount
integer
required

The amount in the source currency's minor unit. For example, 10000 would be $100 for USD.

Required range: x >= 1
​
configuration_id
string<uuid>
required

The ID of the Incoming Synctera Pay configuration used for this transfer

​
creation_time
string<date-time>
required

The timestamp representing when the dispute was created

Example:

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

​
destination_account_id
string<uuid>
required

The ID of the account in the Synctera Platform that will receive the funds for this transfer.

​
id
string<uuid>
required

The unique ID of the Incoming Synctera Pay transfer

​
last_updated_time
string<date-time>
required

The timestamp representing when the dispute was last modified

Example:

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

​
payee_id
string<uuid>
required

The ID of the person or business customer in the Synctera Platform that is the receiver of the this transfer.

​
payer_id
string<uuid>
required

The ID of the person or business in the Synctera Platform that is the originator of the this transfer. Depending on the configuration being used, this does not necessarily need to be a customer.

​
reference_id
string
required

The unique network reference ID assigned to the transfer by the FinTech.

​
settlement_date
string<date>
required
​
source_external_account_id
string<uuid>
required

The ID of the external account in the Synctera Platform that is the ultimate source of funds for this transfer.

​
status
enum<string>
required

The status of the incoming transfer. All values other than POSTED and DECLINED are intermediate statuses that will only appear if the transfer needs to be retried, using the same idempotency key.

Available options:
CREATE_HOLD,
CHECK,
POST_HOLD,
DECLINE_HOLD,
POSTED,
DECLINED
​
tenant
string
required

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

Example:

"abcdef_ghijkl"

​
external_data
object

External Data for FinTech use, copied to ledger transactions related to this transfer.

​
transaction_id
string<uuid>

The ID of the transaction in the Synctera Ledger related to this transfer.