POST
/
synctera_pay
/
{id}
/
return
Return a Synctera Pay Transfer
curl --request POST \
  --url https://api.synctera.com/v1/synctera_pay/{id}/return \
  --header 'Authorization: Bearer <token>'
{
  "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",
  "amount": 10000,
  "configuration_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "currency": "USD",
  "dc_sign": "DEBIT",
  "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"
}

Authorizations

​
Authorization
string
header
required

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

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

​
id
string<uuid>
required

ID

Response

200
application/json

The created return transfer

Synctera Pay transfer