Change the baseUrl of the API
api.pawapay.cloud
as the baseUrl for the API, now it’s time to change it to:api.sandbox.pawapay.io
for your sandbox accountapi.pawapay.io
for your live account.cloud
domain.Versioned paths
Financial requests
correspondent
to provider
.accountDetails
object.type
within payer
or recipient
from value MSISDN
to MMO
.address
within payer
or recipient
to accountDetails
.value
within address
to phoneNumber
.customerTimestamp
from the request payload. This parameter has been removed.statementDescription
to customerMessage
."fieldName": "orderId"
and "fieldValue": "ORD-123456789"
format to "orderId": "ORD-123456789"
format.Required changes in responses
ENQUEUED
any more on initiation.
The only statuses returned on initiation are:ACCEPTED
REJECTED
DUPLICATE_IGNORED
rejectionReason
and error
responses are now consolidated into failureReason
.failureReason
later in the guide.Next let’s look at callbacks and status checks.New response format for status checks
Payload changes for callbacks and status checks
rejectionReason
, failureReason
and error
responses to a failureReason
.
You can now always find out what happened from a single place which is the failureReason
.You can find all the failureCodes
in our docs. Make sure you have implemented handling for them.The requestedAmount
and depositedAmount
are now just a single amount
, showing the amount that was requested to be deposited.
If the payment FAILED
, no funds have been deposited.The respondedByPayer
, receivedByRecipient
and suspiciousActivityReport
have been removed from all callbacks and status checks.The providerTransactionId
replaces the correspondentIds
object.
It will contain the ID of the transaction as specified by the provider (if available from the provider).Otherwise, all the changes in the request will be reflected in the callbacks and status checks as well, so make sure renamed or deprecated parameters are adjusted.Before:Callback resends, enqueued payout cancellation etc
Provider availability
correspondent
has been renamed to provider
everywhere in the API.Next let’s take a look at predict provider.Predicting the provider
correspondent
has been renamed to provider
.operator
has been omitted in the response.msisdn
has been renamed to phoneNumber
.Retrieving wallet balances
country
to do that instead of a path parameter.Checking wallet balances before:mno
has been renamed to provider
as well.Now let’s look at active configuration.Getting your active configuration
merchantId
has been removed from the response.The merchantName
has been renamed to companyName
.Of course the correspondents
have been renamed to providers
like in the rest of the API.Within the list of providers
you can now find the list of currencies
they support.
Currently, the only country with multicurrency support is DRC.In currencies
you will now find a map of operationTypes
which contain the minimum and maximum transaction limits.
The minTransactionLimit
and maxTransactionLimit
have been renamed to minAmount
and maxAmount
respectively.The ownerName
has been renamed to nameDisplayedToCustomer
.Getting your active configuration before:When using the payment page
msisdn
has been renamed to phoneNumber
.The statementDescription
has been renamed to customerMessage
.The amount
is now contained in the amountDetails
object together with the currency
.Before in V1:failureReason
like the rest of the API.When checking for the final status of the payment, the changes listed earlier in the guide must be implemented to ensure everything works.And done!
Support for different payment authorisation flows
Provider specific instructions for authorisation
Making sure payment data is accurate and valid
Easier support for showing provider availability
Making it easy to expand
What next?