Skip to main content
POST
/
pms
/
api
/
external
/
request
/
wallet
/
transfer-status
/
Transfer Status
curl --request POST \
  --url https://api.payvessel.com/pms/api/external/request/wallet/transfer-status/ \
  --header 'Content-Type: <content-type>' \
  --header 'api-key: <api-key>' \
  --header 'api-secret: <api-secret>' \
  --data '
{
  "reference": "PAYOUT_2026_0001",
  "session_id": "SESSION_123456789"
}
'
{
  "status": true,
  "message": "<string>",
  "data": {}
}
Use this endpoint to check the final status of a transfer you created with either Initiate Transfer or Bulk Transfer.

​
Endpoint

POST /pms/api/external/request/wallet/transfer-status/

​
Request Body

​
reference
string
Transfer reference you passed when initiating the transfer
​
session_id
string
Session ID returned in the initial transfer response

​
Example request

{
  "reference": "PAYOUT_2026_0001",
  "session_id": "SESSION_123456789"
}

​
Example cURL

curl -X POST "https://api.payvessel.com/pms/api/external/request/wallet/transfer-status/" \
  -H "api-key: YOUR_API_KEY" \
  -H "api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "PAYOUT_2026_0001",
    "session_id": "SESSION_123456789"
  }'

​
Response

{
  "status": true,
  "message": "Transfer status retrieved",
  "data": {
    "reference": "PAYOUT_2026_0001",
    "session_id": "SESSION_123456789",
    "amount": "15000.00",
    "status": "success",
    "destination_account_number": "0123456789",
    "destination_bank_code": "999991",
    "destination_account_name": "John Doe",
    "completed_at": "2026-03-11T13:04:35.988Z"
  }
}
The status field in data tells you whether the transfer is pending, success, or failed. Use this endpoint together with Initiate Transfer, Bulk Transfer, and wallet transaction history for full payout reconciliation.

Headers

​
api-key
string
required

Your Payvessel public API key

​
api-secret
string
required

Your Payvessel secret

​
Content-Type
enum<string>
required

Request content type

Available options:
application/json

Body

application/json
​
reference
string
required

Transfer reference

​
session_id
string
required

Session ID from initiation

Response

200 - application/json

Transfer status retrieved successfully

​
status
boolean

Request status

​
message
string

Response message

​
data
object

Transfer status data