Xtrempay Api Documentation

Withdraw to Wallet

Pending

Cloud Mock

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

POST

/v1/corebanking/{savingsType}/withdraw

Maintainer:Xtrempay Devs

Description
Debits amount from the savings plan, applies a 1% penalty if before maturityDate, and credits the net amount to the user’s wallet. Requires 4-digit PIN.

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}},
  "amount": 1000.00,
  "type": "INSTANT",
  "savingsPlanId": "8d59fc22-e1de-490c-b50a-3b4453fb1d24"
}

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}}/withdraw' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "pin": {{transactionPin}},
  "amount": 1000.00,
  "type": "INSTANT",
  "savingsPlanId": "8d59fc22-e1de-490c-b50a-3b4453fb1d24"
}'

Responses

🟢200Success

application/json

Body

Example

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

🟠400Invalid input

Modified at 2025-08-30 14:54:32

Add and fund a Savings Plan

Fetch Saving plans