API Reference
Log inContact us

Connectivity sync object

Monitor connectivity with partner banks, CSMs, and connectivity providers

Connectivity syncs are created as Numeral connects to partner banks, CSMs, or connectivity provider to send and receive payments and reports.

AttributeDescription
id
string		The connectivity sync ID.
object
string		Always connectivity_sync.
type
string		The type of connectivity sync:
  • up: when sending data to the partner bank or CSM
  • down: when receiving data from the partner bank or CSM
  • transfer_file: when forwarding a file to a third-party system
connected_account_ids
array[string]		The ID(s) of the connected account used to connect to the partner bank, CSM, or third-party system
status
string		The status of the connectivity sync:
  • success: connectivity sync was successful
  • failure : connectivity sync failed during banking hours
  • warning: connectivity failed outside of banking hours
status_details
string		The connectivity sync status details.
created_at
datetime		The UTC timestamp of the creation of the connectivity sync.