logo
API docs by Redocly

Sync Savings API Specification

Download OpenAPI specification:Download

Introduction

Welcome to the Sync Savings API, providing access to the Sync Savings Platform.

ℹ️ Embedded savings is the integration of cash savings products into other digital applications without the need to redirect users to the underlying financial institution. Embedded financial services enable providers to offer seamless access to relevant financial products at the point of intent, and thus drive engagement and value to customers.

🔑 Authentication: The API requires authentication using API keys included in request headers (see authorize)

Should you have any queries on the standards implemented or the capability of our services, please do let us know by emailing us at contact@sync-savings.com

Overview

The Sync Savings API provides a set of RESTful, JSON-based APIs that can be used to create and manage savings for your users.

Security

We store only the required information to be able to provide your users with a savings account, all data is encrypted at rest and in transit by TLS 1.2+. Authentication is provided by AWS's Cognito product which restricts access to the API.

User data is segregated by Distributor so that it is only accessible to clients from the relevant Distributor and with a token bearing the correct level of permission.

Authentication

We use the OAuth 2.0 Client Credentials flow for authentication. The clientId and clientSecret can be exchanged for an accessToken, this can be reused until it expires. Typically this is after 10 minutes, the time that the token will expire is listed in the "exp" field of the access token.

Details of how to obtain an access token will be included when issuing the clientId and clientSecret. All requests must include the access token in the Authorization header.

Pagination

All of our Search endpoints, e.g. searching transactions by Account ID accept optional limit and page query parameters.

By default the limit parameter is set to 10 and the page is set to 1.

Savers

Savers are Distributors' customers, Savers want to open an Account to save money.

Create a new Saver

Authorizations:
oauth2
Request Body schema: application/json
required
firstName
required
string

The given name of the Saver.

lastName
required
string

The family name of the Saver.

email
required
string

The email address of the Saver.

dateOfBirth
required
string <date>

The date of birth of the Saver in ISO 8601 format.

mobileNumber
required
string/\+447\d{9}/

The mobile phone number of the Saver.

required
object (AddressRequest)
required
object

This bank account is where Withdrawal Transactions will be paid to

institution
string

If you aggregate data and need to identity Savers by the source of that data institution can be used for this, e.g. this could be populated with the Saver's employer

required
object
sourceOfFunds
required
string
Enum: "gambling-or-lottery" "investments" "property-or-asset-sale" "business-income" "savings" "salary-or-bonus" "student-loans-or-bursary" "retirement-or-pension" "legal-settlement" "family-or-gifted" "loan" "inheritance"

The nature of the money being used to fund the Bank Account

taxResidency
required
string
Value: "GB"

The country where the Saver is a tax resident. Currently GB only

Responses

Request samples

Content type
application/json
{
  • "firstName": "Christopher",
  • "lastName": "Robin",
  • "email": "christopher.robin@sync-savings.com",
  • "dateOfBirth": "1969-12-31",
  • "mobileNumber": "+447123456789",
  • "address": {
    },
  • "sourceAccountDetails": {
    },
  • "institution": "Winslow Luggages",
  • "employment": {
    },
  • "sourceOfFunds": "salary-or-bonus",
  • "taxResidency": "GB"
}

Response samples

Content type
application/json
{
  • "id": "668286d72ea20e3725f813eb",
  • "firstName": "Christopher",
  • "lastName": "Robin",
  • "email": "christopher.robin@sync-savings.com",
  • "dateOfBirth": "1969-12-31",
  • "mobileNumber": "+447123456789",
  • "address": {
    },
  • "sourceAccountDetails": {
    },
  • "institution": "Winslow Luggages",
  • "employment": {
    },
  • "sourceOfFunds": "salary-or-bonus",
  • "taxResidency": "GB",
  • "createdAt": "2024-12-31T00:00:00.000Z",
  • "updatedAt": "2024-12-31T00:00:00.000Z"
}

View an existing Saver

Authorizations:
oauth2
path Parameters
saverId
required
string
Example: 668286d72ea20e3725f813eb

The ID of the Saver

Responses

Response samples

Content type
application/json
{
  • "id": "668286d72ea20e3725f813eb",
  • "firstName": "Christopher",
  • "lastName": "Robin",
  • "email": "christopher.robin@sync-savings.com",
  • "dateOfBirth": "1969-12-31",
  • "mobileNumber": "+447123456789",
  • "address": {
    },
  • "sourceAccountDetails": {
    },
  • "institution": "Winslow Luggages",
  • "employment": {
    },
  • "sourceOfFunds": "salary-or-bonus",
  • "taxResidency": "GB",
  • "createdAt": "2024-12-31T00:00:00.000Z",
  • "updatedAt": "2024-12-31T00:00:00.000Z"
}

Update an existing Saver

Authorizations:
oauth2
path Parameters
saverId
required
string
Example: 668286d72ea20e3725f813eb

The ID of the Saver

Request Body schema: application/json
required
firstName
string

The given name of the Saver.

lastName
string

The family name of the Saver.

email
string

The email address of the Saver.

dateOfBirth
string <date>

The date of birth of the Saver in ISO 8601 format.

mobileNumber
string/\+447\d{9}/

The mobile phone number of the Saver.

object
object

This bank account is where Withdrawal Transactions will be paid to

institution
string

If you aggregate data and need to identity Savers by the source of that data institution can be used for this, e.g. this could be populated with the Saver's employer

object
sourceOfFunds
string
Enum: "gambling-or-lottery" "investments" "property-or-asset-sale" "business-income" "savings" "salary-or-bonus" "student-loans-or-bursary" "retirement-or-pension" "legal-settlement" "family-or-gifted" "loan" "inheritance"

The nature of the money being used to fund the Bank Account

taxResidency
string
Value: "GB"

The country where the Saver is a tax resident. Currently GB only

Responses

Request samples

Content type
application/json
{
  • "firstName": "Christopher",
  • "lastName": "Robin",
  • "email": "christopher.robin@sync-savings.com",
  • "dateOfBirth": "1969-12-31",
  • "mobileNumber": "+447123456789",
  • "address": {
    },
  • "sourceAccountDetails": {
    },
  • "institution": "Winslow Luggages",
  • "employment": {
    },
  • "sourceOfFunds": "salary-or-bonus",
  • "taxResidency": "GB"
}

Response samples

Content type
application/json
{
  • "id": "668286d72ea20e3725f813eb",
  • "firstName": "Christopher",
  • "lastName": "Robin",
  • "email": "christopher.robin@sync-savings.com",
  • "dateOfBirth": "1969-12-31",
  • "mobileNumber": "+447123456789",
  • "address": {
    },
  • "sourceAccountDetails": {
    },
  • "institution": "Winslow Luggages",
  • "employment": {
    },
  • "sourceOfFunds": "salary-or-bonus",
  • "taxResidency": "GB",
  • "createdAt": "2024-12-31T00:00:00.000Z",
  • "updatedAt": "2024-12-31T00:00:00.000Z"
}

Products

Products represent the types of savings accounts available with Banks.

List available Products

List available Products

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
{
  • "0": {
    },
  • "createdAt": "2024-12-31T00:00:00.000Z",
  • "updatedAt": "2024-12-31T00:00:00.000Z"
}

Accounts

Accounts are owned by a Saver, they are the representation in Sync's system of the Saver's bank account.

Create a new Account

Create a new Account for an existing Saver

Authorizations:
oauth2
Request Body schema: application/json
required
saverId
required
string

The ID of the Saver that owns the Account

name
required
string

A friendly name that a Saver can use to identify the Account

productId
required
string

The ID of the Product that this Account is an instance of

goalAmount
number decimal places <= 2 >= 0.01

The amount the Saver wants to save for their goal

isoCurrencyCode
required
string
Value: "GBP"

The currency of the account in ISO 4217 format.

termsAgreed
boolean

Whether the Saver has agreed to the product terms and conditions

summaryBoxViewed
boolean

Whether the Saver has seen and read the Summary Box of the Savings Account

fscsSheetViewed
boolean

Whether the Saver has seen and read the FSCS protection information declaration

Responses

Request samples

Content type
application/json
{
  • "saverId": "668286d72ea20e3725f813eb",
  • "name": "Holiday in Bahamas",
  • "productId": "66c7020263facd181eb0f6cf",
  • "goalAmount": 12345.67,
  • "isoCurrencyCode": "GBP",
  • "termsAgreed": true,
  • "summaryBoxViewed": true,
  • "fscsSheetViewed": true
}

Response samples

Content type
application/json
{
  • "id": "6682d9d4d8c3ad5632af059c",
  • "bankAccountDetails": {
    },
  • "availableBalance": 1234.56,
  • "totalInterest": 142.76,
  • "saverId": "668286d72ea20e3725f813eb",
  • "name": "Holiday in Bahamas",
  • "productId": "66c7020263facd181eb0f6cf",
  • "goalAmount": 12345.67,
  • "isoCurrencyCode": "GBP",
  • "termsAgreed": true,
  • "summaryBoxViewed": true,
  • "fscsSheetViewed": true,
  • "createdAt": "2024-12-31T00:00:00.000Z",
  • "updatedAt": "2024-12-31T00:00:00.000Z"
}

Search existing Accounts

Authorizations:
oauth2
query Parameters
saverId
required
string
Example: saverId=668286d72ea20e3725f813eb

The ID of the Saver that the Account is owned by

Responses

Response samples

Content type
application/json
{
  • "id": "6682d9d4d8c3ad5632af059c",
  • "bankAccountDetails": {
    },
  • "availableBalance": 1234.56,
  • "totalInterest": 142.76,
  • "saverId": "668286d72ea20e3725f813eb",
  • "name": "Holiday in Bahamas",
  • "productId": "66c7020263facd181eb0f6cf",
  • "goalAmount": 12345.67,
  • "isoCurrencyCode": "GBP",
  • "termsAgreed": true,
  • "summaryBoxViewed": true,
  • "fscsSheetViewed": true,
  • "createdAt": "2024-12-31T00:00:00.000Z",
  • "updatedAt": "2024-12-31T00:00:00.000Z"
}

View an existing Account

Authorizations:
oauth2
path Parameters
accountId
required
string
Example: 6682d9d4d8c3ad5632af059c

The ID of the Account

Responses

Response samples

Content type
application/json
{
  • "id": "6682d9d4d8c3ad5632af059c",
  • "bankAccountDetails": {
    },
  • "availableBalance": 1234.56,
  • "totalInterest": 142.76,
  • "saverId": "668286d72ea20e3725f813eb",
  • "name": "Holiday in Bahamas",
  • "productId": "66c7020263facd181eb0f6cf",
  • "goalAmount": 12345.67,
  • "isoCurrencyCode": "GBP",
  • "termsAgreed": true,
  • "summaryBoxViewed": true,
  • "fscsSheetViewed": true,
  • "createdAt": "2024-12-31T00:00:00.000Z",
  • "updatedAt": "2024-12-31T00:00:00.000Z"
}

Update an existing Account

Authorizations:
oauth2
path Parameters
accountId
required
string
Example: 6682d9d4d8c3ad5632af059c

The ID of the Account

Request Body schema: application/json
name
string

A friendly name that a Saver can use to identify the Account

goalAmount
number decimal places <= 2 >= 0.01

The amount the Saver wants to save for their goal

Responses

Request samples

Content type
application/json
{
  • "name": "Holiday in Bahamas",
  • "goalAmount": 12345.67
}

Response samples

Content type
application/json
{
  • "id": "6682d9d4d8c3ad5632af059c",
  • "bankAccountDetails": {
    },
  • "availableBalance": 1234.56,
  • "totalInterest": 142.76,
  • "saverId": "668286d72ea20e3725f813eb",
  • "name": "Holiday in Bahamas",
  • "productId": "66c7020263facd181eb0f6cf",
  • "goalAmount": 12345.67,
  • "isoCurrencyCode": "GBP",
  • "termsAgreed": true,
  • "summaryBoxViewed": true,
  • "fscsSheetViewed": true,
  • "createdAt": "2024-12-31T00:00:00.000Z",
  • "updatedAt": "2024-12-31T00:00:00.000Z"
}

Transactions

Transactions are owned by an Account, they are the representation in Sync's system of cash movements in the Saver's bank account.

Create a new Transaction

Create a new Transaction for an existing Account

Authorizations:
oauth2
Request Body schema: application/json
required
accountId
required
string

The ID of the Account that the Transaction relates to

type
required
string
Value: "WITHDRAWAL"

The type of the transaction to be created in Sync's system

reference
required
string
amount
required
number decimal places <= 2

The monetary value of the Transaction

isoCurrencyCode
required
string
Value: "GBP"

Responses

Request samples

Content type
application/json
{
  • "accountId": "6682d9d4d8c3ad5632af059c",
  • "type": "WITHDRAWAL",
  • "reference": "string",
  • "amount": 123.45,
  • "isoCurrencyCode": "GBP"
}

Response samples

Content type
application/json
{
  • "id": "6683b802a65f44cae8dc06e2",
  • "status": "AUTHORISING",
  • "accountId": "6682d9d4d8c3ad5632af059c",
  • "type": "WITHDRAWAL",
  • "reference": "string",
  • "amount": 123.45,
  • "isoCurrencyCode": "GBP",
  • "createdAt": "2024-12-31T00:00:00.000Z",
  • "updatedAt": "2024-12-31T00:00:00.000Z"
}

Search existing Transactions

Authorizations:
oauth2
query Parameters
accountId
required
string
Example: accountId=6682d9d4d8c3ad5632af059c

The ID of the Account that the transaction relates to

Responses

Response samples

Content type
application/json
[
  • {
    }
]

View an existing Transaction

Authorizations:
oauth2
path Parameters
transactionId
required
string
Example: 6683b802a65f44cae8dc06e2

The ID of the Transaction

Responses

Response samples

Content type
application/json
{
  • "id": "6683b802a65f44cae8dc06e2",
  • "status": "AUTHORISING",
  • "accountId": "6682d9d4d8c3ad5632af059c",
  • "type": "WITHDRAWAL",
  • "reference": "string",
  • "amount": 123.45,
  • "isoCurrencyCode": "GBP",
  • "createdAt": "2024-12-31T00:00:00.000Z",
  • "updatedAt": "2024-12-31T00:00:00.000Z"
}

Commitments

Commitments are the Saver's instruction of how much they want to contribute to their Account.

Create a new Commitment

Create a new Commitment for an existing Account

Authorizations:
oauth2
Request Body schema: application/json
required
accountId
required
string

The ID of the Account that the Commitment relates to

amount
required
number decimal places <= 2 >= 0.01

The amount the Saver wants to pay into their Account

Responses

Request samples

Content type
application/json
{
  • "accountId": "6682d9d4d8c3ad5632af059c",
  • "amount": 67.89
}

Response samples

Content type
application/json
{
  • "id": "671b7c2b3f541ccb827b7c0a",
  • "accountId": "6682d9d4d8c3ad5632af059c",
  • "amount": 67.89,
  • "createdAt": "2024-12-31T00:00:00.000Z",
  • "updatedAt": "2024-12-31T00:00:00.000Z"
}

Search existing Commitments.

This endpoint is to facilitate payments into Accounts.

Authorizations:
oauth2
query Parameters
institution
required
string
Example: institution=Winslow Luggages

The institution field from Savers

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ],
  • "totalAmount": 67.89
}

View an existing Commitment

Authorizations:
oauth2
path Parameters
commitmentId
required
string
Example: 671b7c2b3f541ccb827b7c0a

The ID of the Commitment

Responses

Response samples

Content type
application/json
{
  • "id": "671b7c2b3f541ccb827b7c0a",
  • "accountId": "6682d9d4d8c3ad5632af059c",
  • "amount": 67.89,
  • "createdAt": "2024-12-31T00:00:00.000Z",
  • "updatedAt": "2024-12-31T00:00:00.000Z"
}

Update an existing Commitment

Authorizations:
oauth2
path Parameters
commitmentId
required
string
Example: 671b7c2b3f541ccb827b7c0a

The ID of the Commitment

Request Body schema: application/json
amount
number decimal places <= 2 >= 0.01

The amount the Saver wants to pay into their Account

Responses

Request samples

Content type
application/json
{
  • "amount": 67.89
}

Response samples

Content type
application/json
{
  • "id": "671b7c2b3f541ccb827b7c0a",
  • "accountId": "6682d9d4d8c3ad5632af059c",
  • "amount": 67.89,
  • "createdAt": "2024-12-31T00:00:00.000Z",
  • "updatedAt": "2024-12-31T00:00:00.000Z"
}

Reconciliations

Reconciliations are instructions to Sync on how to distribute a consolidated payment in.

Create a new Reconciliation

Create a new Reconciliation for existing Accounts

Authorizations:
oauth2
Request Body schema: application/json
required
paymentReference
string

The end-to-end reference for the payment

paymentTotal
number

The total amount of the payment

institution
string

The institution field from Savers. Accounts in this payment must belong to Savers with a matching institution field.

paymentDate
string <date>

The date the payment will be made in ISO 8601 format.

Array of objects (Deposit)

Responses

Request samples

Content type
application/json
{
  • "paymentReference": "REF001-20250630",
  • "paymentTotal": 67.89,
  • "institution": "institution-1",
  • "paymentDate": "2025-06-30",
  • "deposits": [
    ]
}

Response samples

Content type
application/json
{
  • "paymentReference": "REF001-20250630",
  • "paymentTotal": 67.89,
  • "institution": "institution-1",
  • "paymentDate": "2025-06-30",
  • "status": "pending",
  • "deposits": [
    ]
}

Search existing Reconciliations

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

View an existing Reconciliation

Authorizations:
oauth2
path Parameters
reconciliationId
required
string
Example: 67e1444b07086452becd707c

The ID of the Reconciliation

Responses

Response samples

Content type
application/json
{
  • "paymentReference": "REF001-20250630",
  • "paymentTotal": 67.89,
  • "institution": "institution-1",
  • "paymentDate": "2025-06-30",
  • "status": "pending",
  • "deposits": [
    ]
}

Delete an existing Reconciliation

Authorizations:
oauth2
path Parameters
reconciliationId
required
string
Example: 67e1444b07086452becd707c

The ID of the Reconciliation

Responses