Disburse Money
Depending on the disbursement facility to be used, to disburse money, send the request headers and body parameters via POST.
POST/disburse?walletReferenceId={{walletReferenceId}}
Header Parameters
| Parameter | Required? | Type | Description |
|---|---|---|---|
| Content-Type | Optional | string | Default content type of the API. |
| Authorization | Required | string | Unique identifier of the integrator. |
Query Parameters
| Parameter | Required? | Type | Description |
|---|---|---|---|
| walletReferenceId | Required | string | Unique Identifier for wallet. |
Request Body
| Parameter | Required? | Type | Description |
|---|---|---|---|
| payload | Required | string | Generated JSON Web Token (JWT) from transaction data signed with integrator's secret using HS256 algorithm. |
Once the instructions are submitted, the integrator can check the status of disbursement items from time to time. The integrator should be aware that each facility has different result codes.
Transaction Payload
{
"data": {
"transactionComplianceRequest": {}, //Use API reference for details
"merchantReference": "sampleMerchantReference",
"facility": "facilityjwt",
"items": [
{
"reference": "091234546789",
"amount": "1.00",
"notification": {
"notify": true,
"type": "email",
"email": "email@email.com"
}
}
]
}
}
Sequence Diagram for Disbursements
The integrator can access API functions to process disbursements. First, the integrator should get all the disbursement facilities available to their account. After that, the integrator can submit disbursement instructions to the selected facility. The number of instructions for sending depends on the capability of the facility.
Once the instructions are submitted, the integrator can check the status of disbursement items from time to time. The integrator should be aware that each facility has different result codes.
{
"data": {
"transactionComplianceRequest": {}, //Use API reference for details
"merchantReference": "sampleMerchantReference",
"facility": "facilityjwt",
"items": [
{
"customParameters": {
"currency": "123",
"bic": "SAMPLEBICXX",
"pin": "111111",
"param1": "123",
"param2": "123",
"param3": "123",
"custno": "123",
"purpose": "Test Credit Transfer"
},
"reference": "12345678909",
"amount": "1.00",
"notification": {
"notify": true,
"type": "email",
"email": "email@email.com"
}
}
]
}
}
Sequence Diagram for Disbursements
The integrator can access API functions to process disbursements. First, the integrator should get all the disbursement facilities available to their account. After that, the integrator can submit disbursement instructions to the selected facility. The number of instructions for sending depends on the capability of the facility.
Once the instructions are submitted, the integrator can check the status of disbursement items from time to time. The integrator should be aware that each facility has different result codes.
{
"data": {
"transactionComplianceRequest": {}, //Use API reference for details
"merchantReference": "sampleMerchantReference",
"facility": "facilityjwt",
"items": [
{
"customParameters": {
"currency": "123",
"bic": "SAMPLEBICXX",
"name": "111111",
"address": "123 St."
},
"reference": "12345678909",
"amount": "1.00",
"notification": {
"notify": true,
"type": "email",
"email": "email@email.com"
}
}
]
}
}
Sequence Diagram for Disbursements
The integrator can access API functions to process disbursements. First, the integrator should get all the disbursement facilities available to their account. After that, the integrator can submit disbursement instructions to the selected facility. The number of instructions for sending depends on the capability of the facility.
Once the instructions are submitted, the integrator can check the status of disbursement items from time to time. The integrator should be aware that each facility has different result codes.
{
"data": {
"transactionComplianceRequest": {}, //Use API reference for details
"merchantReference": "sampleMerchantReference",
"facility": "facilityjwt",
"items": [
{
"reference": "1234506948123",
"amount": "1.00",
"customParameters": {
"lastName": "Sender",
"country": "AUS",
"bankCode": "CBA",
"purpose": "Test Credit Transfer",
"postcode": "1234",
"individualOrBusiness": "I",
"bsb": "063259",
"firstName": "John",
"emailAddress": "email@email.com",
"dob": "01/01/01",
"addressLine1": "Kent Street Seabridge House",
"suburb": "Sydney",
"state": "NSW"
},
"notification": {
"notify" true,
"type": "EMAIL",
"email": "email1@email.com"
}
}
]
}
}
{
"data": {
"transactionComplianceRequest": {}, //Use API reference for details
"merchantReference": "sampleMerchantReference",
"facility": "facilityjwt",
"items": [
{
"reference": "1234506948123",
"amount": "1.00",
"customParameters": {
"individualOrBusiness": "B",
"businessName": "Sample Business",
"abn": "51865934561",
"addressLine1": "Kent Street Seabridge House",
"suburb": "Sydney",
"state": "NSW",
"postcode": "1234",
"country": "AUS",
"emailAddress": "email@email.com",
"bankCode": "CBA",
"bsb": "063259",
"dob": "01/01/01",
"purpose": "Test Credit Transfer"
},
"notification": {
"notify" true,
"type": "EMAIL",
"email": "email1@email.com"
}
}
]
}
}
Sequence Diagram for Disbursements
The integrator can access API functions to process disbursements. First, the integrator should get all the disbursement facilities available to their account. After that, the integrator can submit disbursement instructions to the selected facility. The number of instructions for sending depends on the capability of the facility.
Once the instructions are submitted, the integrator can check the status of disbursement items from time to time. The integrator should be aware that each facility has different result codes.
{
"data": {
"transactionComplianceRequest": {}, //Use API reference for details
"merchantReference": "sampleMerchantReference",
"facility": "facilityjwt",
"items": [
{
"customParameters": {
"bankSwiftCode": "REVOGB61",
"city": "Sample City",
"country": "GB",
"customerId": "ABC1234567890",
"email": "john.doe@email.com",
"individual": {
"birthDate": "1990-01-01",
"birthPlace": "Birth Place",
"documentNumber": "AB123456",
"documentType": "passport",
"expirationDate": "2030-01-01",
"issuedBy": "US Deparment of State",
"issuedCountryCode": "GB",
"issueDate": "2020-01-01",
"firstName": "John",
"middleName": "Dee",
"lastName": "Doe"
},
"payeeType": "INDIVIDUAL",
"phone": "15555555555",
"purpose": "Test",
"state": "Test State",
"street": "123 St.",
"zip": "10001"
},
"reference": "GB12REVO05649328549678",
"amount": "1.00",
"notification": {
"notify": true,
"type": "email",
"email": "email@email.com"
}
}
]
}
}
{
"data": {
"transactionComplianceRequest": {}, //Use API reference for details
"merchantReference": "sampleMerchantReference",
"facility": "facilityjwt",
"items": [
{
"customParameters": {
"bankSwiftCode": "REVOGB61",
"city": "Sample City",
"corporate": {
"corporateName": "Sample Corp."
},
"country": "GB",
"customerId": "ABC1234567890",
"email": "email@email.com",
"payeeType": "CORPORATE",
"phone": "15555555555",
"purpose": "Test",
"state": "Test State",
"street": "123 St.",
"zip": "10001"
},
"reference": "GB12REVO05649328549678",
"amount": "1.00",
"notification": {
"notify": true,
"type": "email",
"email": "email1@email.com"
}
}
]
}
}
Sequence Diagram for Disbursements
The integrator can access API functions to process disbursements. First, the integrator should get all the disbursement facilities available to their account. After that, the integrator can submit disbursement instructions to the selected facility. The number of instructions for sending depends on the capability of the facility.
Once the instructions are submitted, the integrator can check the status of disbursement items from time to time. The integrator should be aware that each facility has different result codes.
{
"data": {
"transactionComplianceRequest": {}, //Use API reference for details
"merchantReference": "sampleMerchantReference",
"facility": "facilityjwt",
"items": [
{
"customParameters": {
"bankSwiftCode": "TRWIG12 XXX",
"city": "Test City",
"country": "GB",
"customerId": "P5022482B0",
"email": "email@email.com",
"individual": {
"birthDate": "1994-01-01",
"birthPlace": "Philippines",
"documentNumber": "P5422036B",
"expirationDate": "2030-01-01",
"firstName": "John",
"issuedBy": "DFA MANILA",
"issuedCountryCode": "PH",
"issuedDate": "2020-01-01",
"lastName": "Doe",
"middleName": "Dee"
},
"payeeType": "INDIVIDUAL",
"phone": "+123356746907",
"purpose": "Test",
"state": "UK",
"street": "61 Shoreditch High St.",
"zip": "E1 6JJ"
},
"reference": "GB51TRWI29456437732196",
"amount": "1.00",
"notification": {
"notify": true,
"type": "email",
"email": "email@email.com"
}
}
]
}
}
Sequence Diagram for Disbursements
The integrator can access API functions to process disbursements. First, the integrator should get all the disbursement facilities available to their account. After that, the integrator can submit disbursement instructions to the selected facility. The number of instructions for sending depends on the capability of the facility.
Once the instructions are submitted, the integrator can check the status of disbursement items from time to time. The integrator should be aware that each facility has different result codes.
Request Sample
{
"payload": "transactionPayloadJwt"
}
Response Samples
{
"timestamp": "2021-06-13 06:52:37 +0000",
"status": 200,
"message": "OK",
"path": "/disburse",
"data": {
"transactionReference": "210613065229SJF9939",
"statusCode": "OK.00.10",
"statusDescription": "Disbursement request successful"
}
}
{
"timestamp": "2021-06-13 07:11:19 +0000",
"status": 401,
"error": "Unauthorized",
"path": "/disburse"
}
Responses
200 Successful Response
400 Erroneous Response
