1. Bank Cashout
Nilpay
  • NilPay Bank Integration API
    • Custody Bank Deposit
      • Integration Guide
      • Initiate deposit transaction
      • Complete deposit transaction
    • Bank Cashout
      • Integration Guide
      • Inquiry for bank cashout
        POST
      • Initiate bank cashout
        POST
      • Complete bank cashout with OTP
        POST
    • Schemas
      • InitiateDepositRequest
      • BankCashoutInquiryRequest
      • CompleteDepositRequest
      • BankCashoutInitiateRequest
      • BankCashoutCompleteRequest
      • Depositor
      • BankCashoutInquirySuccessResponse
      • InitiateDepositSuccessResponse
      • ChargeResponse
      • BankCashoutInitiateSuccessResponse
      • AccountBasicInfo
      • BankCashoutCompleteSuccessResponse
      • CompleteDepositSuccessResponse
      • WalletBasicInfo
      • ErrorResponse
      • ValidationErrorResponse
      • TransactionResponse
      • ProblemDetailsResponse
  • NilPay External Party Transfer API
    • Transactions
      • Integration Guide
      • External Party Transfer To Wallet
    • Schemas
      • ExternalPartyTransferRequest
      • TransactionResponseData
      • ExternalPartyTransferSuccessResponse
      • ErrorResponse
  1. Bank Cashout

Initiate bank cashout

POST
/v1/transactions/bank-cashout/initiate
Create pending transaction and send OTP to customer.

Request

Authorization
Basic Auth
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
API Key
Add parameter in header
X-Signature
Example:
X-Signature: ********************
API Key
Add parameter in header
X-Timestamp
Example:
X-Timestamp: ********************
or
Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
OTP sent and pending transaction created
Bodyapplication/json

🟠400
🟠401
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.dev.pynil.com/v1/transactions/bank-cashout/initiate' \
--header 'Authorization: Basic <encoded-value>' \
--header 'X-Signature: <api-key>' \
--header 'X-Timestamp: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "walletNumber": "101000001",
    "amount": 100,
    "timestamp": "2026-01-08",
    "notes": "Test request"
}'
Response Response Example
200 - success
{
    "success": true,
    "message": "OTP sent successfully",
    "statusCode": 200,
    "data": {
        "nilpayTranRef": "333"
    }
}
Previous
Inquiry for bank cashout
Next
Complete bank cashout with OTP
Built with