Disburse Money

Depending on the disbursement facility to be used, to disburse money, send the request headers and body parameters via POST.

POST/disburse

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.

Disburse to Gcash

{
   "data":{
      "merchantReference":"DIZTEST1512210001",
      "facility":"{jwtString}",
      "items":[
         {
            "reference":"{mobileNumber}",
            "amount":"1",
                "notification":{
                  "notify":"{true/false}",
                  "type":"email",
                  "email":"{receiverEmail}"
                }
         }
      ]
   }
}

See API Reference > Transaction Body Payload Data for a more guided requirement.

Request Samples

PayloadcURL

{
  "data":{
      "merchantReference":"DIZTEST1512210001",
      "facility":"{jwtString}",
      "items":[
        {
            "reference":"{mobileNumber}",
            "amount":"1.00",
            "notification":{
              "notify":"{true/false}",
              "type":"email",
              "email":"{receiverEmail}"
            }
        }
      ]
  }
}

curl 
-X POST "https://test-api-dbm.tlpe.io/disburse" \
-H "Content-Type: application/json" \
-H "Authorization: {integratorToken}" \
-d "{
      "payload": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.ew0KICAiZGF0YSI6IHsNCiAgICAgIm1lcmNoYW50UmVmZXJlbmNlIjogIkRCTVRFU1QxNTEyMjEwMDAxIiwNCiAgImZhY2lsaXR5IjogImV5SjBlWEFpT2lKS1YxUWlMQ0poYkdjaU9pSklVekkxTmlKOS5leUpwYzNNaU9pSkVRazBpTENKemRXSWlPaUpFYVhOaWRYSnpaVzFsYm5RZ0tFUkNUU2tnUVhWMGFHVnVkR2xqWVhScGIyNGlMQ0poZFdRaU9pSkVhWE5pZFhKelpXMWxiblFnS0VSQ1RTa2lMQ0psZUhBaU9qRTJNemszTURnM01USXNJbWxoZENJNk1UWXpPVGN3TmpreE1pd2lhblJwSWpvaU5HUm1ZMlE1WXpndE5EVXdaUzAwTmpobExUZ3pNR1l0TXpJek0yTmpZek01T1Rka0lpd2ljR2xrSWpvaVpXUmlNRE5pT1RZdE0yWTBNaTAwWkRreExUZ3lZekF0WWpSbFlUazBORFF6TkRVekluMC5GaENzbEZOa0pfT2p6Zmx0Tjh0dmQ5UjZfWEQ3WVJPOEs4TlpjQzBKTjBNIiwNCiAgIml0ZW1zIjogWw0KICAgIHsNCiAgICAgICJyZWZlcmVuY2UiOiAiMDk2NjU4NDkwMjEiLA0KICAgICAgImFtb3VudCI6ICIxIg0KICAgIH0NCiAgXQ0KICB9DQogIA0KfQ._t5OR92eYiY5HhUUjG7K51Qj3x4fkydnLCSODIrSAeI"
    }

Responses

200 Successful Response

400 Erroneous Response

Response Samples

200401

{
  "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"
}