Xtrempay Api Documentation

Top up a savings plan

Cloud Mock

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

POST

/v1/corebanking/{savingType}/savings-plan/topup

Maintainer:Xtrempay Devs

Allows a user to top up their savings plan by specifying an amount. The system processes the contribution and returns a confirmation with the credited amount and a ticket ID for transaction tracking.

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

{
    "planId": "8d59fc22-e1de-490c-b50a-3b4453fb1d24",
    "amount": 1000,
    "pin":{{transactionPin}}
}

Request 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}}/savings-plan/topup' \
--header 'Content-Type: application/json' \
--data-raw '{
    "planId": "8d59fc22-e1de-490c-b50a-3b4453fb1d24",
    "amount": 1000,
    "pin":{{transactionPin}}
}'

Responses

🟢200Success

application/json

Body

Example

{
    "amountTopUp": 5000,
    "ticketId": "topup_abc12345"
}

🟠400Invalid input

Modified at 2025-08-03 15:14:47

Fetch Saving plans

Fetch Account Details