Making a deposit

This endpoint creates a payment intent for a deposit.

Use it when you want ZedPay to prepare a deposit request and return a payment reference you can track.

Endpoint

Method: POST

URL: /payment/v1/make-deposit

Authentication And Security

Your request must include these headers:

Header	Required	Description
`Authorization`	Yes	Bearer token used to authenticate your client. Format: `Bearer <token>`
`timestamp`	Yes	Timestamp is required
`Content-Type`	Yes	Use `application/json`

If the token is missing or invalid, the API returns 401.

Request Body

Field	Type	Required	What it means	Example
`walletAccountNo`	`number`	Required	Your ZedPay wallet account number. Your wallet account numbers are visible on your management portal. Must be a whole number.	`200001`
`referenceNo`	`string`	Required	Your reference number. A unique identifier for this transaction, generated by your system.	`b1d05644-c52c-409b-af09-50f5eb54bcb0`
`transactionCategory`	`string`	Required	Transaction category for this payment. Get the list of transaction categories from the `masterdata` endpoint.	`"CUSTOMER_PAYMENT"`
`amount`	`number`	Required	Amount to collect. Send it as a number, not a string.	`50000`
`paidBy`	`string`	Optional	Name of the person making the payment. If not specified, we shall substitute with customerName	`"Devine Balizza"`
`remarks`	`string`	Required	Short description of the deposit or reason for payment.	`"Monday deposit"`
`telephoneNumber`	`string`	Required	The (Ugandan) telephone number from which the money will be deducted from.	`"256752002106"`
`telephoneNetwork`	`string`	Required	The mobile money network, such as `AIRTEL` or `MTN`.	`"AIRTEL"`
`customerName`	`string`	Required	The customer's name.	`"Devine Balizza"`
`requestMethod`	`string`	Required	Use this to show where the payment request came from.	`"MOBILE"`

Example Request Body

This is a valid and easy-to-follow example:

{
    "walletAccountNo": 200001,
    "referenceNo": "b1d05644-c52c-409b-af09-50f5eb54bcb0",
    "transactionCategory": "CUSTOMER_PAYMENT",
    "amount": 50000,
    "paidBy": "Devine Balizza",
    "remarks": "Monday deposit",
    "telephoneNumber": "256752002106",
    "telephoneNetwork": "AIRTEL",
    "customerName": "Devine Balizza",
    "requestMethod": "MOBILE"
}

Example cURL Request

Replace the token, timestamp, and sample values with your real integration values:

Success Response

If the payment intent is created successfully, the API returns a response like this:

This is a simplified example. The actual data object may include additional stored fields.

{
    "status": "success",
    "message": "Payment intent created successfully",
    "error": null,
    "data": {
        "id": "b7d9a2f7-3d5a-4db2-8c44-53b6a64ce001",
        "uiReferenceNo": "TXN-AB12CD34",
        "walletAccountNo": 200001,
        "transactionCategory": "CUSTOMER_PAYMENT",
        "requestMethod": "MOBILE",
        "currency": "UGX",
        "amount": 50000,
        "paymentMethod": "MOBILEMONEY",
        "telephoneNumber": "256752002106",
        "telephoneNetwork": "AIRTEL",
        "paidBy": "Devine Balizza",
        "customerName": "Devine Balizza",
        "remarks": "Monday deposit",
        "transactionStatus": "PENDING"
    }
}

Important Notes

A successful call creates a payment intent. It does not mean the customer has already paid.

The API generates uiReferenceNo for you. You do not send it in the request.

The initial transactionStatus is typically PENDING.

Send numeric fields like walletAccountNo and amount as numbers, not quoted strings.

Quick field guide

Use this checklist when preparing your request:

Always send: walletAccountNo, referenceNo,transactionCategory, amount, paidBy, remarks, telephoneNumber, telephoneNetwork, customerName, requestMethod

Making a deposit

Endpoint#

Authentication And Security#

Request Body#

Example Request Body#

Example cURL Request#

Success Response#

Important Notes#

Quick field guide#