Get Account Information

Read on obtaining wallet/bank account details

This API provides information about account holder from the payer/bank if available. It can be mostly used to obtain wallet account holder name and status.

POST /v2/senders/{{senderId}}/recipients/{{recipientId}}/accounts/information

Parameter

Field	Required	Type	Description
senderId	Yes, in URL	UUID	Sender ID
recipientId	Yes, in URL	UUID	Recipient ID
identification_value	Yes, for WALLET payout_method	String	Recipient wallet id
identification_type	No	String	Wallet type. Enumerated value: TEL. The default value for identification_type is TEL
account_number	Yes, for BANK_DEPOSIT payout_method
payout_method	Yes	String	Payout method type. Enumerated value: WALLET, BANK_DEPOSIT
recipient_id	Response	UUID	Recipient ID
payload	Response	Object
payload.status	Response	String	Status of the recipient wallet. AVAILABLE, UNAVAILABLE, UNREGISTER, SERVICE_NOT_PRESENT Details on the above values AVAILABLE : The wallet/bank is available. UNAVAILABLE: The wallet/bank is unavailable. UNREGISTER : The MSISDN is not active. SERVICE_NOT_PRESENT : This API service is not available.
payload.full_name	Response	String	Full name of the account holder
payload.identifier	Response	String	Recipient wallet ID

Request Parameter

curl --location --request POST {{url}}/v2/senders/{{senderId}}/recipients/{{recipientId}}/accounts/information' \
--header 'X-Client-Id: clientid' \
--header 'X-Client-Secret: clientsecret' \
--header 'Content-Type: application/json' \
--data-raw '{
  "identification_value":"254723993187",
  "identification_type": "TEL",
  "payout_method": "WALLET"
  }
'

Response Parameter

{
    "recipient_id": "string",
    "payout_method": "WALLET",
    "payload": {
        "status": "AVAILABLE",
        "full_name": "JOSEPH MBUGUA NJEHU",
        "identifier": "254723993187"
    }
}