GET
/
savings
{
  "status": "00",
  "message": "Loans retrieved successfully",
  "data": {
    "loans": [
      {
        "savings_id": "1",
        "customer_id": "1",
        "product_id": "1",
        "start_date": "2021-01-01",
        "currency": "NGN",
        "savings_amount": 123,
        "frequency": "MONTHLY",
        "total_savings_amount": 123,
        "total_savings_transactions": 123,
        "missed_savings_amount": 123,
        "missed_savings_transactions": 123,
        "next_savings_due_date": "2021-01-01",
        "next_savings_due_amount": 100000,
        "custom_properties": [
          {
            "id": "1",
            "description": "custom_property",
            "type": "string",
            "value": "custom_property"
          }
        ]
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

connection-id
string

Connection ID for the target bank

idempotency-key
string
required

Unique key to ensure idempotency of the request

signature
string
required

SHA-256 signature of client_secret + ";" + idempotency-key

Response

Loans retrieved successfully

status
string
required
Example:

"00"

message
string
required
Example:

"Loans retrieved successfully"

data
object
required
I