Transfer Logs

List all transfer logs

Transfer logs are created any time Synci attempts to transfer a bank transaction. Since destinations and financial accounts can have multiple transfer links, transfer logs are created for each transfer link. You should use transfer logs to track the status of a transaction. For example, by getting the latest transfer log for a transaction and transfer link, you can see if the transfer was successful or not.

GET

/transfer-logs

curl --request GET \
  --url https://api.synci.io/api/v1/transfer-logs \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "created_at": "<string>",
      "destination_transaction_id": "<string>",
      "id": "<string>",
      "message": "<string>",
      "status": "<string>",
      "transaction": {
        "additional_data_structured": "<string>",
        "additional_information": "<string>",
        "additional_information_structured": "<string>",
        "amount": "<string>",
        "attempted_transfers": "<string>",
        "balance_after_transaction": "<string>",
        "booked": "<string>",
        "booking_date": "<string>",
        "booking_datetime": "<string>",
        "codes": {
          "bank_transaction_code": "<string>",
          "merchant_category_code": "<string>",
          "proprietary_bank_transaction_code": "<string>",
          "purpose_code": "<string>"
        },
        "created_at": "<string>",
        "creditor": {
          "agent": "<string>",
          "bban": "<string>",
          "currency": "<string>",
          "iban": "<string>",
          "id": "<string>",
          "masked_pan": "<string>",
          "msisdn": "<string>",
          "name": "<string>",
          "pan": "<string>"
        },
        "currency": "<string>",
        "currency_exchange": {
          "contract_identification": "<string>",
          "exchange_rate": "<string>",
          "quotation_date": "<string>",
          "source_currency": "<string>",
          "target_currency": "<string>",
          "unit_currency": "<string>"
        },
        "debtor": {
          "agent": "<string>",
          "bban": "<string>",
          "currency": "<string>",
          "iban": "<string>",
          "masked_pan": "<string>",
          "msisdn": "<string>",
          "name": "<string>",
          "pan": "<string>"
        },
        "enriched": {
          "category_general": "<string>",
          "certainty_score": "<string>",
          "counterparty": {
            "logo_url": "<string>",
            "mccs": "<string>",
            "name": "<string>",
            "website": "<string>"
          },
          "intermediary": {
            "logo_url": "<string>",
            "mccs": "<string>",
            "name": "<string>",
            "website": "<string>"
          },
          "is_personal": "<string>",
          "is_subscription": "<string>",
          "location": {
            "apple_maps_url": "<string>",
            "google_maps_url": "<string>",
            "raw_address": "<string>"
          },
          "provider": "<string>"
        },
        "external_identifiers": {

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

page[size]integerquerydefault:25

The number of results that will be returned per page.

page[number]integerquery

The page number to start the pagination from.

filter[transfer_link_id]stringquery

Filter transfer logs by the ID of the transfer link the transaction was transferred through.

filter[transaction_id]stringquery

Filter transfer logs by the ID of the transaction that was transferred.

filter[destination_transaction_id]stringquery

Filter transfer logs by the ID the destination assigned to the transferred transaction.

filter[status]stringquery

Filter transfer logs by status, for example TRANSFERRED or FAILED.

filter[transaction_ids]stringquery

Filter transfer logs by one or more transaction IDs, separated by commas.

filter[search]stringquery

Search for transfer logs by commonly populated fields

sortenum<string>[]querydefault:["-id"]

includeenum<string>[]query

Response

Paginated set of TransferLogResource

dataobject[]required

Show child attributes

linksobjectrequired

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Ask the team