Withdrawal Process

A withdrawal allows you to transfer funds from a user's account back to their specified bank account. This guide explains how to initiate a withdrawal by making a POST request to the StableMint API.

Overview

The withdrawal process enables you to send funds directly to a user’s bank account after generating a valid withdrawal reference. You must provide essential details about the transaction, including the user's information and banking credentials.

---

Creating a Withdrawal Request

To initiate a withdrawal, send a POST request to: https://paymentinitiationservice-rest.stablemint.io/withdrawal

Headers

Include the following headers in your request:

signature: SHA256 hashed signature of the string "<TIMESTAMP>,<API_SECRET>,<UNIQUE_USER_ID>"
timestamp: <CURRENT UNIX TIMESTAMP>
apiKey: <YOUR API KEY>

For detailed instructions on generating the signature, refer to our Authentication Page.

Endpoint

POST

/withdrawal

Request Body

{

"userId": "string",

"userEmail": "string",

"userCountryCode": "string",

"userIp": "string",

"remittanceInformation": "string",

"amount": 0,

"currency": "string",

"withdrawalReason": 0,

"creditorAccount": "string",

"creditorBic": "string",

"creditorCountryCode": "string",

"creditorName": "string",

"creditorAddress": "string",

"idempotencyKey": "string",

"websiteReference": "string",

"customFields": "string",

"userKyc": {

"fullName": "string",

"citizenshipCountryCode": "string",

"residenceAddress": "string",

"dateOfBirth": "string",

"placeOfBirth": "string",

"gender": "string",

"mobilePhone": "string",

"personalIdentificationNumber": "string"

}

}

Responses

OK

Content-Type

text/plainapplication/jsontext/json

{

"reference": "string"

}

Webhooks

Once a withdrawal is initiated, StableMint will send a webhook to the URL specified in your dashboard. The webhook contains detailed information about the transaction, including its status and any relevant reference numbers.

To know more about webhooks, refer to our Webhooks Page.