Request deposit
curl --request POST \
--url https://api.sandbox.pawapay.io/deposits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"depositId": "<INSERT_UUID_FOR_DEPOSIT>",
"amount": "15",
"currency": "ZMW",
"correspondent": "MTN_MOMO_ZMB",
"payer": {
"type": "MSISDN",
"address": {
"value": "260763456789"
}
},
"customerTimestamp": "2020-02-21T17:32:28Z",
"statementDescription": "Note of 4 to 22 chars",
"country": "ZMB",
"preAuthorisationCode": "<string>",
"metadata": [
{
"fieldName": "orderId",
"fieldValue": "ORD-123456789"
},
{
"fieldName": "customerId",
"fieldValue": "customer@email.com",
"isPII": true
}
]
}
'import requests
url = "https://api.sandbox.pawapay.io/deposits"
payload = {
"depositId": "<INSERT_UUID_FOR_DEPOSIT>",
"amount": "15",
"currency": "ZMW",
"correspondent": "MTN_MOMO_ZMB",
"payer": {
"type": "MSISDN",
"address": { "value": "260763456789" }
},
"customerTimestamp": "2020-02-21T17:32:28Z",
"statementDescription": "Note of 4 to 22 chars",
"country": "ZMB",
"preAuthorisationCode": "<string>",
"metadata": [
{
"fieldName": "orderId",
"fieldValue": "ORD-123456789"
},
{
"fieldName": "customerId",
"fieldValue": "customer@email.com",
"isPII": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
depositId: '<INSERT_UUID_FOR_DEPOSIT>',
amount: '15',
currency: 'ZMW',
correspondent: 'MTN_MOMO_ZMB',
payer: {type: 'MSISDN', address: {value: '260763456789'}},
customerTimestamp: '2020-02-21T17:32:28Z',
statementDescription: 'Note of 4 to 22 chars',
country: 'ZMB',
preAuthorisationCode: '<string>',
metadata: [
{fieldName: 'orderId', fieldValue: 'ORD-123456789'},
{fieldName: 'customerId', fieldValue: 'customer@email.com', isPII: true}
]
})
};
fetch('https://api.sandbox.pawapay.io/deposits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.pawapay.io/deposits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'depositId' => '<INSERT_UUID_FOR_DEPOSIT>',
'amount' => '15',
'currency' => 'ZMW',
'correspondent' => 'MTN_MOMO_ZMB',
'payer' => [
'type' => 'MSISDN',
'address' => [
'value' => '260763456789'
]
],
'customerTimestamp' => '2020-02-21T17:32:28Z',
'statementDescription' => 'Note of 4 to 22 chars',
'country' => 'ZMB',
'preAuthorisationCode' => '<string>',
'metadata' => [
[
'fieldName' => 'orderId',
'fieldValue' => 'ORD-123456789'
],
[
'fieldName' => 'customerId',
'fieldValue' => 'customer@email.com',
'isPII' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.pawapay.io/deposits"
payload := strings.NewReader("{\n \"depositId\": \"<INSERT_UUID_FOR_DEPOSIT>\",\n \"amount\": \"15\",\n \"currency\": \"ZMW\",\n \"correspondent\": \"MTN_MOMO_ZMB\",\n \"payer\": {\n \"type\": \"MSISDN\",\n \"address\": {\n \"value\": \"260763456789\"\n }\n },\n \"customerTimestamp\": \"2020-02-21T17:32:28Z\",\n \"statementDescription\": \"Note of 4 to 22 chars\",\n \"country\": \"ZMB\",\n \"preAuthorisationCode\": \"<string>\",\n \"metadata\": [\n {\n \"fieldName\": \"orderId\",\n \"fieldValue\": \"ORD-123456789\"\n },\n {\n \"fieldName\": \"customerId\",\n \"fieldValue\": \"customer@email.com\",\n \"isPII\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.pawapay.io/deposits")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"depositId\": \"<INSERT_UUID_FOR_DEPOSIT>\",\n \"amount\": \"15\",\n \"currency\": \"ZMW\",\n \"correspondent\": \"MTN_MOMO_ZMB\",\n \"payer\": {\n \"type\": \"MSISDN\",\n \"address\": {\n \"value\": \"260763456789\"\n }\n },\n \"customerTimestamp\": \"2020-02-21T17:32:28Z\",\n \"statementDescription\": \"Note of 4 to 22 chars\",\n \"country\": \"ZMB\",\n \"preAuthorisationCode\": \"<string>\",\n \"metadata\": [\n {\n \"fieldName\": \"orderId\",\n \"fieldValue\": \"ORD-123456789\"\n },\n {\n \"fieldName\": \"customerId\",\n \"fieldValue\": \"customer@email.com\",\n \"isPII\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.pawapay.io/deposits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"depositId\": \"<INSERT_UUID_FOR_DEPOSIT>\",\n \"amount\": \"15\",\n \"currency\": \"ZMW\",\n \"correspondent\": \"MTN_MOMO_ZMB\",\n \"payer\": {\n \"type\": \"MSISDN\",\n \"address\": {\n \"value\": \"260763456789\"\n }\n },\n \"customerTimestamp\": \"2020-02-21T17:32:28Z\",\n \"statementDescription\": \"Note of 4 to 22 chars\",\n \"country\": \"ZMB\",\n \"preAuthorisationCode\": \"<string>\",\n \"metadata\": [\n {\n \"fieldName\": \"orderId\",\n \"fieldValue\": \"ORD-123456789\"\n },\n {\n \"fieldName\": \"customerId\",\n \"fieldValue\": \"customer@email.com\",\n \"isPII\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"depositId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
"status": "ACCEPTED",
"created": "2020-10-19T11:17:01Z"
}Deposits
Request deposit
POST
/
deposits
Request deposit
curl --request POST \
--url https://api.sandbox.pawapay.io/deposits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"depositId": "<INSERT_UUID_FOR_DEPOSIT>",
"amount": "15",
"currency": "ZMW",
"correspondent": "MTN_MOMO_ZMB",
"payer": {
"type": "MSISDN",
"address": {
"value": "260763456789"
}
},
"customerTimestamp": "2020-02-21T17:32:28Z",
"statementDescription": "Note of 4 to 22 chars",
"country": "ZMB",
"preAuthorisationCode": "<string>",
"metadata": [
{
"fieldName": "orderId",
"fieldValue": "ORD-123456789"
},
{
"fieldName": "customerId",
"fieldValue": "customer@email.com",
"isPII": true
}
]
}
'import requests
url = "https://api.sandbox.pawapay.io/deposits"
payload = {
"depositId": "<INSERT_UUID_FOR_DEPOSIT>",
"amount": "15",
"currency": "ZMW",
"correspondent": "MTN_MOMO_ZMB",
"payer": {
"type": "MSISDN",
"address": { "value": "260763456789" }
},
"customerTimestamp": "2020-02-21T17:32:28Z",
"statementDescription": "Note of 4 to 22 chars",
"country": "ZMB",
"preAuthorisationCode": "<string>",
"metadata": [
{
"fieldName": "orderId",
"fieldValue": "ORD-123456789"
},
{
"fieldName": "customerId",
"fieldValue": "customer@email.com",
"isPII": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
depositId: '<INSERT_UUID_FOR_DEPOSIT>',
amount: '15',
currency: 'ZMW',
correspondent: 'MTN_MOMO_ZMB',
payer: {type: 'MSISDN', address: {value: '260763456789'}},
customerTimestamp: '2020-02-21T17:32:28Z',
statementDescription: 'Note of 4 to 22 chars',
country: 'ZMB',
preAuthorisationCode: '<string>',
metadata: [
{fieldName: 'orderId', fieldValue: 'ORD-123456789'},
{fieldName: 'customerId', fieldValue: 'customer@email.com', isPII: true}
]
})
};
fetch('https://api.sandbox.pawapay.io/deposits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.pawapay.io/deposits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'depositId' => '<INSERT_UUID_FOR_DEPOSIT>',
'amount' => '15',
'currency' => 'ZMW',
'correspondent' => 'MTN_MOMO_ZMB',
'payer' => [
'type' => 'MSISDN',
'address' => [
'value' => '260763456789'
]
],
'customerTimestamp' => '2020-02-21T17:32:28Z',
'statementDescription' => 'Note of 4 to 22 chars',
'country' => 'ZMB',
'preAuthorisationCode' => '<string>',
'metadata' => [
[
'fieldName' => 'orderId',
'fieldValue' => 'ORD-123456789'
],
[
'fieldName' => 'customerId',
'fieldValue' => 'customer@email.com',
'isPII' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.pawapay.io/deposits"
payload := strings.NewReader("{\n \"depositId\": \"<INSERT_UUID_FOR_DEPOSIT>\",\n \"amount\": \"15\",\n \"currency\": \"ZMW\",\n \"correspondent\": \"MTN_MOMO_ZMB\",\n \"payer\": {\n \"type\": \"MSISDN\",\n \"address\": {\n \"value\": \"260763456789\"\n }\n },\n \"customerTimestamp\": \"2020-02-21T17:32:28Z\",\n \"statementDescription\": \"Note of 4 to 22 chars\",\n \"country\": \"ZMB\",\n \"preAuthorisationCode\": \"<string>\",\n \"metadata\": [\n {\n \"fieldName\": \"orderId\",\n \"fieldValue\": \"ORD-123456789\"\n },\n {\n \"fieldName\": \"customerId\",\n \"fieldValue\": \"customer@email.com\",\n \"isPII\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.pawapay.io/deposits")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"depositId\": \"<INSERT_UUID_FOR_DEPOSIT>\",\n \"amount\": \"15\",\n \"currency\": \"ZMW\",\n \"correspondent\": \"MTN_MOMO_ZMB\",\n \"payer\": {\n \"type\": \"MSISDN\",\n \"address\": {\n \"value\": \"260763456789\"\n }\n },\n \"customerTimestamp\": \"2020-02-21T17:32:28Z\",\n \"statementDescription\": \"Note of 4 to 22 chars\",\n \"country\": \"ZMB\",\n \"preAuthorisationCode\": \"<string>\",\n \"metadata\": [\n {\n \"fieldName\": \"orderId\",\n \"fieldValue\": \"ORD-123456789\"\n },\n {\n \"fieldName\": \"customerId\",\n \"fieldValue\": \"customer@email.com\",\n \"isPII\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.pawapay.io/deposits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"depositId\": \"<INSERT_UUID_FOR_DEPOSIT>\",\n \"amount\": \"15\",\n \"currency\": \"ZMW\",\n \"correspondent\": \"MTN_MOMO_ZMB\",\n \"payer\": {\n \"type\": \"MSISDN\",\n \"address\": {\n \"value\": \"260763456789\"\n }\n },\n \"customerTimestamp\": \"2020-02-21T17:32:28Z\",\n \"statementDescription\": \"Note of 4 to 22 chars\",\n \"country\": \"ZMB\",\n \"preAuthorisationCode\": \"<string>\",\n \"metadata\": [\n {\n \"fieldName\": \"orderId\",\n \"fieldValue\": \"ORD-123456789\"\n },\n {\n \"fieldName\": \"customerId\",\n \"fieldValue\": \"customer@email.com\",\n \"isPII\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"depositId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
"status": "ACCEPTED",
"created": "2020-10-19T11:17:01Z"
}Deposits operation allows you to initiate a deposit for asynchronous processing.
Learn more!
See what the deposit flow looks like with PawaPay and for your customers.
- This API call is idempotent, which means it is safe to submit a request with the same
depositIdmultiple times. - Duplicate requests with the same
depositIdwill be ignored with theDUPLICATE_IGNOREDstatus in the response. - Since the request can rejected, you must check the
statuscode in the response for each submitted request. TherejectionReasonin the response will contain information about the reason of the rejection.
| Status | Description | |
|---|---|---|
ACCEPTED | Yes | The deposit request has been accepted by PawaPay for processing. |
REJECTED | No | The deposit request has been rejected. See rejectionReason for details. |
DUPLICATE_IGNORED | No | The deposit request has been ignored as a duplicate of an already accepted deposit request. Duplication logic relies upon depositId. |
How to find out the final status of this deposit?
As the PawaPay Merchant API is an asynchronous API, you can find out the final status of theACCEPTED deposit by either:
Waiting for a callback
If you have configured callbacks, just wait for it.
Checking the status
Or poll the Check Deposit Status endpoint.
Headers related to signatures must only be included if you have enabled “Only accept signed requests”. Read more about it from the PawaPay Dashboard documentation.
Authorizations
See Authentication.
Headers
SHA-256 or SHA-512 hash of the request body.
Body
application/json
A UUIDv4 based ID specified by you, that uniquely identifies the deposit.
Required string length:
36Example:
"<INSERT_UUID_FOR_DEPOSIT>"
The amount to be collected (deposit) or disbursed (payout or refund).
Amount must follow below requirements or the request will be rejected:
- Between zero and two decimal places can be supplied, depending on what the specific MMO supports. Learn about all MMO supported decimal places.
- The minimum and maximum amount depends on the limits of the specific MMO. You can find them from the Active Configuration endpoint.
- Leading zeroes are not permitted except where the value is less than 1. For any value less than one, one and only one leading zero must be supplied.
- Trailing zeroes are permitted.
Valid examples:
5, 5.0, 5.00, 5.5, 5.55, 5555555, 0.5
Not valid examples:
5., 5.555, 5555555555555555555, .5, -5.5, 00.5, 00.00, 00001.32
Required string length:
1 - 23Pattern:
^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$Example:
"15"
The currency in which the amount is specified.
Format must be the ISO 4217 three character currency code in upper case. Read more from Wikipedia.
You can find all the supported currencies that the specific correspondent supports from here.
The active configuration endpoint provides the list of correspondents configured for your account together with the currencies.
Example:
"ZMW"
The correspondent code refers to the specific MMO that the specified phone number (MSISDN) has an active mobile money wallet with.
You can find all the supported correspondents listed here.
The active configuration endpoint provides the list of correspondents configured for your account.
You can use the predict correspondent enpoint to predict the correct correspondent to use based on the phone number (MSISDN).
Example:
"MTN_MOMO_ZMB"
The phone number (MSISDN) of the recipient or payer must be specified as the value of the address.
Show child attributes
Show child attributes
Short description for the transaction. Depending on the specific MMO performing the transaction this message may be visible to the customer in the SMS receipt or within their transaction history.
Must be between 4 and 22 alphanumeric characters.
Required string length:
4 - 22Pattern:
^[a-zA-Z0-9 ]+$Example:
"Note of 4 to 22 chars"
For MMOs (correspondents) that use a preauthorisation code instead of a PIN prompt for authorising the deposit.
Required string length:
1 - 36Pattern:
^[a-zA-Z0-9]+$A list of metadata that you can attach to the payment for providing additional context about the payment.
For example, adding orderId to indicate for which order this payment was for or customerId to know which customer this payment pertains to.
Metadata will not be visible to the customer that is party to this payment. It will be visible in the PawaPay Dashboard on the payment details page and in your financial statements as a JSON object to support automated reconciliation. It is also possible to search for recent payments in the PawaPay Dashboard using global search based on the values of metadata.
Up to 10 metadata fields can be attached to a payment.
Show child attributes
Show child attributes
Example:
[
{
"fieldName": "orderId",
"fieldValue": "ORD-123456789"
},
{
"fieldName": "customerId",
"fieldValue": "customer@email.com",
"isPII": true
}
]
Response
Request has been accepted for processing by PawaPay
The depositId of the deposit transaction.
Required string length:
36Example:
"f4401bd2-1568-4140-bf2d-eb77d2b2b639"
The initiation status of the Deposit:
ACCEPTED- The deposit request has been accepted by PawaPay for processing.REJECTED- The deposit request has been rejected. SeerejectionReasonfor detailsDUPLICATE_IGNORED- This deposit request is a duplicate and will be ignored.
Available options:
ACCEPTED, REJECTED, DUPLICATE_IGNORED Show child attributes
Show child attributes
Was this page helpful?