Xtrempay Api Documentation

Add and fund a Savings Plan

Cloud Mock

https://mock.apidog.com/m1/918700-0-default

POST

/v1/corebanking/{savingsType}/fund

Maintainer:Xtrempay Devs

Transfers amount from the user’s wallet into their savings account of the given type, while also (re)setting the plan’s maturityDate and target.

All savings are locked until maturityDate (minimum one month).

Early withdrawal later will incur a 1% penalty (handled by the withdrawal endpoint).

Requires 4-digit PIN.

Path Parameter
savingsType ∈ {RAFFLE, TRIVIA, LIFESTYLE, SPIN_AND_WIN}

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Example

{
  "pin": {{transactionPin}},
  "reason": "House Expense",
  "amount": 1500.00,
  "maturityDate": "2025-12-25",
  "target": 40000.00
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://mock.apidog.com/m1/918700-0-default/v1/corebanking/{{savingType}}/fund' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "pin": {{transactionPin}},
  "reason": "House Expense",
  "amount": 1500.00,
  "maturityDate": "2025-12-25",
  "target": 40000.00
}'

Responses

🟢200Success

application/json

Body

Example

{
    "timestamp": "2025-01-15T10:30:00",
    "status": 0,
    "success": true,
    "message": "string",
    "data": {
        "totalCount": 3,
        "successCount": 2,
        "failureCount": 1,
        "results": [
            {
                "accountNumber": "9876543210",
                "success": true,
                "message": "Account deleted successfully"
            }
        ]
    }
}

🟠400Invalid input

Modified at 2025-09-25 14:23:06

Fetch Recent Transactions by Savings Type

Withdraw to Wallet