API Reference
This reference section provides in depth integration details of the DIZ API.
Environments
There are two environments: TEST and LIVE
| Environment |
URL |
| TEST |
https://test-api.diztance.io/ |
| LIVE |
https://api.diztance.io/ |
Security/Authentication
All requests are authenticated against an Authorization header with an access token and IP whitelisting.
Versioning
All changes made to the API are backwards compatible, hence any major features that are released, that would otherwise break existing implementations, will be released using a new version.
HTTP Status Codes
For each request you send to our API the HTTP status code of the response will already tell you the basic result.
| Parameter Name |
Description |
| 200 |
Successful request. |
| 201 |
Successful request that led to the creation of a resource. |
| 400 |
Bad request. The request is not correct. Verify that the required header(s) and parameter(s) is present and correct. |
| 401 |
Unauthorized. The request is not authorized. Verify that the authorization key is valid. |
| 403 |
Forbidden. The request is not permitted to continue. Verify if the current authority is allowed. |
| 404 |
Successful request. |
| 422 |
Unprocessable Entity. The request cannot be processed. Verify that the data attribute(s) and state is correct. |
| 500 |
Internal Server Error. The system encountered an internal error. Retry the transaction if possible. If not, contact support. |
| 503 |
External System Error. The system encountered an external error. Retry the transaction if possible. If not, contact support. |
Transaction Body Payload Data
| Parameter Name |
Required? |
Description |
Format |
| transactionComplianceRequest |
Conditional |
Parameters for transaction compliance |
Refer to Transaction Compliance Parameters Table |
| merchantReference |
Required |
Any issued merchant reference id for reference. |
Alphanumeric |
| facility |
Required |
Generated token from /facility endpoint |
Alphanumeric |
| items |
Required |
|
Refer to Items Data Table |
Items Data Table
| Parameter Name |
Required? |
Description |
Format |
| reference |
Required |
Identifier of the receiver account number. |
Alphanumeric |
| amount |
Required |
Amount to disburse |
Decimal number |
| customParameters |
Optional |
Custom parameters for difference facilities |
Refer to Custom Parameters Data Table |
| notification |
Optional |
|
Refer to Notifications Data Table |
Transaction Compliance Request Data Table
| Parameter Name |
Required? |
Description |
Format |
| senderDetails |
Required |
Details of the sender |
Refer to Sender Details Data Table |
| beneficiaryDetails |
Required |
Details of the beneficiary |
Refer to Beneficiary Details Data Table |
| nature |
Required |
Nature of the transaction |
Alphanumeric |
| transactionType |
Required |
Type of transaction (e.g., B2B, B2C, C2C, C2B) |
Alphanumeric |
Sender Details Data Table
| Parameter Name |
Required? |
Description |
Format |
| birthdate |
Required |
Sender birth date |
Alphanumeric |
| contact |
Required |
Contact details of the sender |
Refer to Contact Details Data Table |
| identification |
Required |
Identification details of the sender |
Refer to Identification Details Data Table |
| isSameAsPresentAddress |
Required |
Validation if present address is the same as permanent address |
Boolean |
| name |
Required |
Name of the sender |
Refer to Name Data Table |
| nationality |
Required |
Nationality of the sender |
Alphanumeric |
| natureOfBusinessOrEmployment |
Required |
Nature or business or employment of the sender |
Alphanumeric |
| permanentAddress |
Required |
Permanent address of the sender |
Refer to Address Data Table |
| placeOfBirth |
Required |
Place of birth of the sender |
Alphanumeric |
| presentAddress |
Required |
Present address of the sender |
Refer to Address Data Table |
| sourceOfFunds |
Required |
Source of funds of the sender |
Alphanumeric |
| purpose |
Required |
Purpose of the transfer of the sender |
Alphanumeric |
Beneficiary Details Data Table
| Parameter Name |
Required? |
Description |
Format |
| accountDetails |
Required |
Account details of the beneficiary |
Refer to the Account Details Data Table |
| beneficiaryType |
Required |
Beneficiary type of the beneficiary |
Alphanumeric |
| birthdate |
Required |
Beneficiary birth date |
Alphanumeric |
| contact |
Required |
Contact details of the beneficiary |
Refer to Contact Details Data Table |
| isSameAsPresentAddress |
Required |
Validation if present address is the same as permanent address |
Boolean |
| name |
Required |
Name of the beneficiary |
Refer to Name Data Table |
| nationality |
Required |
Nationality of the beneficiary |
Alphanumeric |
| natureOfBusinessOrEmployment |
Required |
Nature or business or employment of the beneficiary |
Alphanumeric |
| permanentAddress |
Required |
Permanent address of the beneficiary |
Refer to Address Data Table |
| placeOfBirth |
Required |
Place of birth of the beneficiary |
Alphanumeric |
| presentAddress |
Required |
Present address of the beneficiary |
Refer to Address Data Table |
| Parameter Name |
Required? |
Description |
Format |
| email |
Optional |
Email address of Sender/Beneficiary |
Refer to Sender Details Data Table |
| landlineNumber |
Optional |
Landline number of the sender/beneficiary |
Numeric |
| mobileNumber |
Required |
Mobile number of the sender/beneficiary |
Numeric |
Identification Data Table
| Parameter Name |
Required? |
Description |
Format |
| expiryDate |
Required |
Expiration date of the identification document |
Date format |
| identificationNumber |
Required |
Identification number of the identification document |
Numeric |
| identificationType |
Required |
Type of identification document |
Alphanumeric |
| issueDate |
Required |
Issue date of the identification document |
Date format |
| issuingAuthority |
Required |
Authority that issued the identification document |
Alphanumeric |
Name Data Table
| Parameter Name |
Required? |
Description |
Format |
| businessName |
Conditional |
Name of the business/employment of the sender/beneficiary |
Alphanumeric |
| firstName |
Required |
First name of the sender/beneficiary |
Alphanumeric |
| lastName |
Required |
Last name of the sender/beneficiary |
Alphanumeric |
| middleName |
Optional |
Middle name of the sender/beneficiary |
Alphanumeric |
| prefix |
Optional |
Prefix of the sender/beneficiary |
Alphanumeric |
| suffix |
Optional |
Suffix of the sender/beneficiary |
Alphanumeric |
Address Data Table
| Parameter Name |
Required? |
Description |
Format |
| addressLine1 |
Required |
Address of the sender/beneficiary |
Alphanumeric |
| addressLine2 |
Optional |
Address of the sender/beneficiary |
Alphanumeric |
| city |
Required |
City address of the sender/beneficiary |
Alphanumeric |
| postalCode |
Required |
Postal address of the sender/beneficiary |
Alphanumeric |
| state |
Required |
State of the sender/beneficiary |
Alphanumeric |
Custom Parameters Data Table
| Parameter Name |
Required? |
Description |
Format |
Facility |
| name |
Required |
Customer's name. |
Alphanumeric |
PESONet |
| address |
Optional |
Customer's address |
Valid address |
PESONet |
| currency |
Required |
Transaction amount currency |
Alphanumeric |
PESONet, InstaPay |
| email |
Required |
Account email address |
Valid email address |
AU Solutions, EU Solutions |
| bic |
Required |
Bank Code |
Alphabet |
InstaPay |
| pin |
Required |
Dummy ATM Pin |
111111 |
InstaPay |
| Param1 |
Conditional |
Any parameter that partner bank wants to send and receive |
Alphanumeric |
InstaPay |
| Param2 |
Conditional |
Any parameter that partner bank wants to send and receive |
Alphanumeric |
InstaPay |
| Param3 |
Conditional |
Any parameter that partner bank wants to send and receive |
Alphanumeric |
InstaPay |
| custno |
Conditional |
Customer number in the first 19 digits |
Alphanumeric |
InstaPay |
| purpose |
Conditional |
Purpose of transfer |
Alphabet |
InstaPay, AU Solutions, EU Solutions |
| individualOrBusiness |
Required |
Type of receiver |
"I" or "B" |
AU Solutions |
| firstname |
Required if individualOrBusiness is I |
First name of receiver |
Alphabet |
AU Solutions |
| lastName |
Required |
Last name of receiver |
Alphabet |
AU Solutions, EU Solutions |
| businessName |
Required if individualOrBusiness is B |
Business name |
Alphabet |
AU Solutions |
| abn |
Required if individualOrBusiness is B |
Australian Business Number |
Numeric |
AU Solutions |
| addressLine1 |
Required |
Address of the receiver |
Alphabet |
AU Solutions |
| suburb |
Required |
District of the city |
Alphabet |
AU Solutions |
| state |
Required |
State of the receiver |
Alphabet (3-letter combination) |
AU Solutions, EU Solutions |
| postcode |
Required |
Postal Code |
Numeric |
AU Solutions |
| country |
Required |
Country of the receiver |
AUS |
AU Solutions |
| dob |
Required |
Date of birth |
valid date format (DD/MM/YYYY) |
AU Solutions |
| bankCode |
Required |
Bank code from Australia |
Alphabet (3-letter combination) |
AU Solutions |
| bsb |
Required |
Bank State Branch |
Numeric |
AU Solutions |
| bankSwiftCode |
Required |
Swift code or BIC |
Alphanumeric |
EU Solutions |
| city |
Required |
city of the receiver |
Alphabet |
EU Solutions |
| country |
Required |
Country of the receiver |
Alphabet |
EU Solutions |
| corporateName |
Required |
Corporate name of the receiver |
Alphabet |
EU Solutions |
| customerId |
Required |
Receiver ID |
Alphabet |
EU Solutions |
| customerId |
Required |
Receiver ID |
Alphabet |
EU Solutions |
| birthDate |
Required |
Birth date of the receiver |
valid date format (YYYY/MM/dd) |
EU Solutions |
| birthPlace |
Required |
Birth place of the receiver |
Alphabet |
EU Solutions |
| documentNumber |
Required |
Document number |
Alphanumeric |
EU Solutions |
| documentType |
Required |
Proof of identification of the receiver |
Alphabet |
EU Solutions |
| expirationDate |
Required |
Expiration date of the document |
valid date format (YYYY/MM/dd) |
EU Solutions |
| firstName |
Required |
First name of the receiver |
Alphabet |
EU Solutions |
| issuedBy |
Required |
Proof of identification issuer |
Alphabet |
EU Solutions |
| issuedCountryCode |
Required |
ISO format Country code |
Alphabet |
EU Solutions |
| issuedDate |
Required |
Date of issuance of the document |
valid date format (YYYY/MM/dd) |
EU Solutions |
| middleName |
Required |
Middle name of the receiver |
Alphabet |
EU Solutions |
| payeeType |
Required |
Type of payee |
"INDIVIDUAL" or "CORPORATE" |
EU Solutions |
| phone |
Required |
Valid phone number |
Numeric |
EU Solutions |
| street |
Required |
street of the receiver |
Alphabet |
EU Solutions |
| zip |
Required |
ZIP code of the receiver |
Numeric |
EU Solutions |
Notifications Data Table
| Parameter Name |
Required? |
Description |
Format |
Value |
| notify |
Required |
Determines if a notification email will be sent or not |
Boolean |
True/False |
| type |
Optional |
Classifies the notification that will be sent. Either as Email or as an SMS |
Alphabet |
EMAIL/SMS |
| email |
Required |
The receiver's email |
Alphabet |
Valid Email address |
Response Messages
| Status Code |
Description |
Remarks |
| OK.00.00 |
Disbursement Successsful |
Status for a successful disbursement transaction |
| OK.00.10 |
Disbursement Pending |
If a disbursement is not confirmed by an integrator, it will be tagged as pending until confirmed if the disbursement is successful or failed |
| OK.01.00 |
Disbursement Ongoing |
Integrator will receive this status for a successful disbursement process |
| ER.00.00 |
Disbursement Failed |
Status for a failed disbursement |
| ER.01.XX |
System Error |
Integrator will receive this status if an internal system error is encountered |
| ER.02.XX |
Error by Client |
Integrator will receive this status if a client side or client provided details encountered an error |
| ER.03.XX |
Error by 3rd party |
Integrator will receive this status if a 3rd-party error is encountered |
Error Messages
| Status Code |
Description |
Remarks |
| ER.XX.00 |
System Error |
Integrator will receive this error if an internal, client, or 3rd-party system error is encountered |
| ER.XX.10 |
Unauthorized |
Integrator will receive this error if an incorrect authorization is provided |
| ER.XX.20 |
Bad Request |
Integrator will receive this error if a bad request data is provided |
| ER.XX.30 |
Invalid Request |
Integrator will receive this error if an invalid parameter value is provided |
| ER.XX.40 |
System Timeout |
Integrator will receive this error if an unexpected system timeout is encountered |