Ozow PIN / Fast
All you need to start saving time for your clients
Overview
In order to reduce the number of steps it takes to make payments, Ozow will offer the user an opportunity to securely store their online banking login details, as well as the account they would prefer to make payments from. The process used to store and retrieve the login details has been vetted by a top independent cyber security consultancy.
Once the user completes the registration, the merchant will be sent a token profile ID and a token that can be used for future payments for this particular user. The user will only need to login using the Ozow PIN that was created during registration and confirm the payment using their banks second factor authentication method for future payments.
This process is broken down into 3 sections:
- Token registration
- Token notification response
- Token deleted notification response
- Token payment
Token registration
If you would like the user to be registered for Ozow Pin you will need to pass the following fields, along with the post variables in Step 1. If you pass through these fields you will need to append them to the concatenated post variables to calculate the post hash check.
These fields are only required if you want the user to register for Ozow Pin after the payment has been completed.
| Property | Type | Req. | Description |
|---|---|---|---|
1.RegisterTokenProfile | bool | Yes | If you would like your user to have an opportunity to register for Ozow Pin, pass this through as true. |
2.TokenNotificationUrl | String (150) | Yes | The URL you would like Ozow to send the token response to after successful payment and token registration. This is different to the payment notification result. |
3.TokenDeletedNotificationUrl | String (150) | Yes | The URL you would like Ozow to notify if we deactivate the token and it can no longer be used. |
Token notification response
After payment is completed and you have been sent the payment notification response in Step 2, the user will be offered the opportunity to create an Ozow PIN to make future payments easier and faster.
If the user successfully creates their Ozow PIN we will post the token response containing the fields below to the TokenNotificationUrl you passed to us in the post variables.
| Property | Type | Description |
|---|---|---|
TokenProfileId | Guid | The token profile ID required for future payments for this user. |
TransactionId | Guid | The Ozow transaction ID for the payment that was completed. |
TransactionReference | String (50) | Merchant's transaction reference for the payment that was completed. This is the same as the value that was passed through in the post variables. |
Token | String (Max) | The token required for future payments for this user. This should be treated as a sensitive field and should be encrypted and stored securely. |
Error | String (250) | The error if the user could not be successfully registered. No notification will be sent if the user opted out of the process. |
Token deleted notification response
If the user enters the incorrect Ozow PIN three consecutive times, the token profile will be deleted and we will send a token deleted notification to the merchant, so that the stored user token can be deleted.
The deleted token response will contain the following fields and will be posted to the TokenDeletedNotificationUrl passed to us in the post variables originally used to create the profile.
| Property | Type | Description |
|---|---|---|
TokenProfileId | Guid | The token profile ID required for future payments for this user. |
Message | String (250) | A message explaining why the token profile has been deleted. |
Token payment
If you have previously received a token for the user you only need to pass the fields below, along with the post variables in step 1 to initiate a tokenised payment. Only the TokenProfileId will need to be appended to the concatenated post variables to calculate the post hash check. The token field is not used in the hash check calculation.
These fields are only required if you want the user to use the token you have saved for them to complete the payment.
| Property | Type | Req. | Description |
|---|---|---|---|
1.TokenProfileId | Guid | Yes | The token profile identifier returned in the token response sent to the TokenNotificationUrl. |
2.Token | String (Max) | Yes | The token returned in the token response sent to the TokenNotificationUrl. |
Updated about 1 year ago