Update an Outgoing Synctera Pay Transfer

curl --request PATCH \
  --url https://api.synctera.com/v2/synctera_pay/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 2,
  "exchange_details": {
    "fees": [
      {
        "amount": 2,
        "currency": "<string>",
        "description": "<string>",
        "fee_type": "FX",
        "percentage": "<string>"
      }
    ],
    "rate": 1.30445,
    "source_amount": 10000,
    "source_currency": "USD",
    "target_amount": 10000,
    "target_currency": "GBP"
  },
  "final_external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference_id": "<string>",
  "source_data": {},
  "status": "CANCELLED",
  "synctera_pay_vendor_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}'

{
  "amount": 10000,
  "configuration_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "currency": "USD",
  "dc_sign": "CREDIT",
  "direction": "OUTGOING",
  "exchange_details": {
    "fees": [
      {
        "amount": 2,
        "currency": "<string>",
        "description": "<string>",
        "fee_type": "FX",
        "percentage": "<string>"
      }
    ],
    "rate": 1.30445,
    "source_amount": 10000,
    "source_currency": "USD",
    "target_amount": 10000,
    "target_currency": "GBP"
  },
  "final_external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_data": {},
  "subtype": "OUTGOING_INTERNATIONAL_REMITTANCE",
  "synctera_pay_network": "WISE",
  "synctera_pay_vendor_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_id": "46fec39e-e776-4571-bf90-d0e1d15172fe",
  "destination_account_id": "fccb4a46-1261-4e91-b622-73b5b946183d",
  "destination_account_owner_name": "<string>",
  "effective_date": "2022-03-18",
  "failed": false,
  "history": [
    {
      "data": {},
      "message": "<string>",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_same_day": true,
  "network_status": "POSTED",
  "original_reference_id": "<string>",
  "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "originating_account_owner_name": "<string>",
  "posting_date": "2022-03-18",
  "reference_id": "<string>",
  "status": "POSTED",
  "suspended": false,
  "tenant_id": "abcdef_ghijkl",
  "transaction_id": "45b5246f-ad97-4629-9aac-465b74a05505"
}

PATCH

synctera_pay

{id}

Update an Outgoing Synctera Pay Transfer

curl --request PATCH \
  --url https://api.synctera.com/v2/synctera_pay/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 2,
  "exchange_details": {
    "fees": [
      {
        "amount": 2,
        "currency": "<string>",
        "description": "<string>",
        "fee_type": "FX",
        "percentage": "<string>"
      }
    ],
    "rate": 1.30445,
    "source_amount": 10000,
    "source_currency": "USD",
    "target_amount": 10000,
    "target_currency": "GBP"
  },
  "final_external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference_id": "<string>",
  "source_data": {},
  "status": "CANCELLED",
  "synctera_pay_vendor_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}'

{
  "amount": 10000,
  "configuration_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "currency": "USD",
  "dc_sign": "CREDIT",
  "direction": "OUTGOING",
  "exchange_details": {
    "fees": [
      {
        "amount": 2,
        "currency": "<string>",
        "description": "<string>",
        "fee_type": "FX",
        "percentage": "<string>"
      }
    ],
    "rate": 1.30445,
    "source_amount": 10000,
    "source_currency": "USD",
    "target_amount": 10000,
    "target_currency": "GBP"
  },
  "final_external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_data": {},
  "subtype": "OUTGOING_INTERNATIONAL_REMITTANCE",
  "synctera_pay_network": "WISE",
  "synctera_pay_vendor_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_id": "46fec39e-e776-4571-bf90-d0e1d15172fe",
  "destination_account_id": "fccb4a46-1261-4e91-b622-73b5b946183d",
  "destination_account_owner_name": "<string>",
  "effective_date": "2022-03-18",
  "failed": false,
  "history": [
    {
      "data": {},
      "message": "<string>",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_same_day": true,
  "network_status": "POSTED",
  "original_reference_id": "<string>",
  "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "originating_account_owner_name": "<string>",
  "posting_date": "2022-03-18",
  "reference_id": "<string>",
  "status": "POSTED",
  "suspended": false,
  "tenant_id": "abcdef_ghijkl",
  "transaction_id": "45b5246f-ad97-4629-9aac-465b74a05505"
}

Headers

Idempotency-Key

string

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"

Path Parameters

string<uuid>

required

The unique resource identifier

Example:

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

Body

application/json

Attributes of the Outgoing Synctera Pay transfer

Properties for updating an outgoing transfer

amount

integer

The amount in the source currency's minor unit. For example, 10000 would be $100 for USD. One of the amount or percentage is required.

Required range: x >= 1

exchange_details

object

Show child attributes

final_external_account_id

string<uuid>

The ID of the final external account that will be the receiver of the Synctera Pay transfer.

reference_id

string

The reference id of the transfer.

source_data

object

Additional information to be added to the transfer

status

enum<string>

Available options:

CANCELLED,

POSTED

synctera_pay_vendor_id

string<uuid>

The ID of the vendor that will be used to process the Synctera Pay transfer.

Example:

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

Response

Successful update of an Outgoing Synctera Pay transfer

Outgoing Synctera Pay transfer

amount

integer

required

Transfer amount in cents

Required range: x >= 1

Example:

10000

currency

string

required

The currency of the transfer in ISO 4217 format

Example:

"USD"

dc_sign

enum<string>

required

The debit/credit sign of the transfer. This is a legacy field for backward compatibility. For outgoing synctera pay, customer accounts are always debited. For incoming synctera pay, customer accounts are always credited. The direction of the transfer is determined by the API route that is used to create the transfer. For outgoing synctera pay, the dc_sign must be specified and it must always be 'CREDIT'.

Available options:

CREDIT

Example:

"CREDIT"

direction

enum<string>

required

The direction of the transfer. This is a legacy field for backward compatibility. The direction of the transfer is determined by the API route that is used to create the transfer. For outgoing synctera pay, the direction must be specified and it must always be 'OUTGOING'.

Available options:

OUTGOING

Example:

"OUTGOING"

subtype

enum<string>

required

The subtype of the outgoing synctera pay transfer

Available options:

OUTGOING_INTERNATIONAL_REMITTANCE,

OUTGOING_INTERNATIONAL_REMITTANCE_REVERSAL,

OUTGOING_INTERNATIONAL_REMITTANCE_RETURN,

OUTGOING_INTERNATIONAL_REMITTANCE_RETURN_REVERSAL,

INCOMING_INTERAC_E_TRANSFER,

INCOMING_INTERAC_E_TRANSFER_REVERSAL,

INCOMING_INTERAC_E_TRANSFER_RETURN,

INCOMING_INTERAC_E_TRANSFER_RETURN_REVERSAL,

OUTGOING_INTERAC_E_TRANSFER,

OUTGOING_INTERAC_E_TRANSFER_REVERSAL,

OUTGOING_INTERAC_E_TRANSFER_RETURN,

OUTGOING_INTERAC_E_TRANSFER_RETURN_REVERSAL,

OUTGOING_BILL_PAYMENT,

OUTGOING_BILL_PAYMENT_REVERSAL,

OUTGOING_BILL_PAYMENT_RETURN,

OUTGOING_BILL_PAYMENT_RETURN_REVERSAL,

INCOMING_INTERAC_AUTODEPOSIT,

INCOMING_INTERAC_AUTODEPOSIT_REVERSAL,

INCOMING_INTERAC_AUTODEPOSIT_RETURN,

INCOMING_INTERAC_AUTODEPOSIT_RETURN_REVERSAL,

OUTGOING_CARD_LOAD,

OUTGOING_CARD_LOAD_REVERSAL,

OUTGOING_ACCOUNT_TRANSFER,

OUTGOING_ACCOUNT_TRANSFER_REVERSAL,

OUTGOING_ACCOUNT_TRANSFER_RETURN,

OUTGOING_ACCOUNT_TRANSFER_RETURN_REVERSAL

Example:

"OUTGOING_INTERNATIONAL_REMITTANCE"

synctera_pay_network

string

required

The network of the transfer.

Example:

"WISE"

effective_date

string<date>

required

The effective date of the transaction once it gets posted

Example:

"2022-03-18"

string<uuid>

required

ID of the transfer

is_same_day

boolean

required

Send the same day (use only is_same_day without specific effective_date).

Example:

true

status

enum<string>

required

The status of the outgoing transfer in the Synctera platform. This is automatically set upon the creation of a transfer. To cancel a transfer, the current status must be 'INITIATED' or 'PENDING' and the request status set to 'CANCELLED'. To trigger a return, the current status must be 'POSTED' and the returned status will be set to 'RETURNED' if successful.

Available options:

INITIATED,

PENDING,

POSTED,

CANCELLED,

EXPIRED

Example:

"POSTED"

tenant_id

string

required

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

Example:

"abcdef_ghijkl"

configuration_id

string<uuid>

The ID of the Outgoing Synctera Pay configuration that will be used to match the Synctera Pay transfer to the appropriate configuration. Only required if the transfer is not automatically matched to a configuration.

Example:

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

exchange_details

object

Show child attributes

final_external_account_id

string<uuid>

The ID of the final external account that will be the receiver of the Outgoing Synctera Pay transfer. Required unless previously agreed with Synctera.

source_data

object

Additional information to be added to the transfer

synctera_pay_vendor_id

string<uuid>

The ID of the vendor that will be used to process the Synctera Pay transfer.

Example:

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

customer_id

string

The UUID of the Synctera customer resource that is the originator of the transfer.

Example:

"46fec39e-e776-4571-bf90-d0e1d15172fe"

destination_account_id

string

The UUID of the Synctera account that is the destination of the transfer. For a transfer originated by the Synctera platform, this will be an external account resource, while for a transfer originated by the external account, this account will be an account resource.

Example:

"fccb4a46-1261-4e91-b622-73b5b946183d"

destination_account_owner_name

string

The account owner name of the destination account.

failed

boolean

Whether the transfer failed or not.

Example:

false

history

object[]

Show child attributes

network_status

enum<string>

The network status of the outgoing transfer in the Synctera platform.

Available options:

PENDING,

POSTED,

RETURNED,

REVERSED

Example:

"POSTED"

original_reference_id

string

The original reference id of the transfer if it's a return.

originating_account_id

string

The UUID of the Synctera account that is the origination of the transfer. For a transfer originated by the Synctera platform, this will be an account resource, while for a transfer originated by the external account, this will be an external account resource.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

originating_account_owner_name

string

The account owner name of the origination account.

posting_date

string<date>

The posting date of the transaction once it gets posted

Example:

"2022-03-18"

reference_id

string

The reference id of the transfer.

suspended

boolean

Whether the transfer is suspended or not.

Example:

false

transaction_id

string<uuid>

The related transaction id of the transfer.

Example:

"45b5246f-ad97-4629-9aac-465b74a05505"

Get Outgoing Synctera Pay Transfer Return a Synctera Pay Transfer

⌘I

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Update an Outgoing Synctera Pay Transfer

Headers

Path Parameters

Body

Response