> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.epaygames.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.epaygames.io/_mcp/server. # Process Disbursement POST https://v1/api/disbursement/process Content-Type: application/json ### Process Disbursement The **Process Disbursement** endpoint submits a new payout request to a recipient via the specified disbursement channel. This is the primary endpoint for initiating cash-out and withdrawal transactions. After submission, the transaction is created with a `pending` status. Monitor the final status via **Get Transactions** or listen for webhook callbacks on your `callback_webhook_url`. > Ensure the recipient details, channel, and amount are validated before calling this endpoint. Reference: https://docs.epaygames.io/epaygames-payments-disbursement-api/disbursement-api/disbursement/process-disbursement ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /v1/api/disbursement/process: post: operationId: Process Disbursement summary: Process Disbursement description: >- ### Process Disbursement The **Process Disbursement** endpoint submits a new payout request to a recipient via the specified disbursement channel. This is the primary endpoint for initiating cash-out and withdrawal transactions. After submission, the transaction is created with a `pending` status. Monitor the final status via **Get Transactions** or listen for webhook callbacks on your `callback_webhook_url`. > Ensure the recipient details, channel, and amount are validated before calling this endpoint. tags: - disbursement responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/Disbursement API_Disbursement_Process Disbursement_Response_200 requestBody: content: application/json: schema: type: object properties: channel: type: string amount: type: integer reference_no: type: string callback_webhook_url: type: string format: uri fields: $ref: >- #/components/schemas/V1ApiDisbursementProcessPostRequestBodyContentApplicationJsonSchemaFields required: - channel - amount - reference_no - callback_webhook_url - fields servers: - url: https:/ description: https://{payments_api_host} components: schemas: V1ApiDisbursementProcessPostRequestBodyContentApplicationJsonSchemaFieldsSender: type: object properties: first_name: type: string middle_name: type: string last_name: type: string suffix: type: string required: - first_name - middle_name - last_name - suffix title: >- V1ApiDisbursementProcessPostRequestBodyContentApplicationJsonSchemaFieldsSender V1ApiDisbursementProcessPostRequestBodyContentApplicationJsonSchemaFieldsReceiver: type: object properties: account_name: type: string account_number: type: string type: type: string mobile_number: type: string email: type: string format: email address: type: string barangay: type: string city: type: string zip_code: type: string gender: type: string required: - account_name - account_number - type - mobile_number - email - address - barangay - city - zip_code - gender title: >- V1ApiDisbursementProcessPostRequestBodyContentApplicationJsonSchemaFieldsReceiver V1ApiDisbursementProcessPostRequestBodyContentApplicationJsonSchemaFields: type: object properties: mobile_number: type: string bank_code: type: string sender: $ref: >- #/components/schemas/V1ApiDisbursementProcessPostRequestBodyContentApplicationJsonSchemaFieldsSender receiver: $ref: >- #/components/schemas/V1ApiDisbursementProcessPostRequestBodyContentApplicationJsonSchemaFieldsReceiver required: - mobile_number - bank_code - sender - receiver title: >- V1ApiDisbursementProcessPostRequestBodyContentApplicationJsonSchemaFields V1ApiDisbursementProcessPostResponsesContentApplicationJsonSchemaDataChannel: type: object properties: name: type: string description: description: Any type slug: type: string code: type: string required: - name - slug - code title: >- V1ApiDisbursementProcessPostResponsesContentApplicationJsonSchemaDataChannel V1ApiDisbursementProcessPostResponsesContentApplicationJsonSchemaData: type: object properties: reference_no: type: string subtotal_amount: type: integer service_fee: type: integer total_amount: type: integer status: type: string channel: $ref: >- #/components/schemas/V1ApiDisbursementProcessPostResponsesContentApplicationJsonSchemaDataChannel required: - reference_no - subtotal_amount - service_fee - total_amount - status - channel title: V1ApiDisbursementProcessPostResponsesContentApplicationJsonSchemaData Disbursement API_Disbursement_Process Disbursement_Response_200: type: object properties: message: type: string data: $ref: >- #/components/schemas/V1ApiDisbursementProcessPostResponsesContentApplicationJsonSchemaData required: - message - data title: Disbursement API_Disbursement_Process Disbursement_Response_200 ``` ## Examples **Request** ```json { "channel": "maya", "amount": 1, "reference_no": "{{randomString}}", "callback_webhook_url": "https://webhook.site/be6460ac-b4ab-4856-a721-1663d43b585e", "fields": { "mobile_number": "+639193890579", "bank_code": "161414", "sender": { "first_name": "John", "middle_name": "Sins", "last_name": "Doe", "suffix": "Jr." }, "receiver": { "account_name": "John Sins Doe", "account_number": "09123456789", "type": "INDIVIDUAL", "mobile_number": "+639000000000", "email": "johndoes@example.com", "address": "Lakambini Street.", "barangay": "San Mateo", "city": "Cabanatuan", "zip_code": "6969", "gender": "MALE" } } } ``` **Response** ```json { "message": "Transaction has been sent for processing.", "data": { "reference_no": "TESTINGREFNO01", "subtotal_amount": 1, "service_fee": 0, "total_amount": 1, "status": "pending", "channel": { "name": "PESONet", "slug": "pesonet", "code": "PESONET" } } } ``` **SDK Code** ```python Disbursement API_Disbursement_Process Disbursement_example import requests url = "https://https/v1/api/disbursement/process" payload = { "channel": "maya", "amount": 1, "reference_no": "{{randomString}}", "callback_webhook_url": "https://webhook.site/be6460ac-b4ab-4856-a721-1663d43b585e", "fields": { "mobile_number": "+639193890579", "bank_code": "161414", "sender": { "first_name": "John", "middle_name": "Sins", "last_name": "Doe", "suffix": "Jr." }, "receiver": { "account_name": "John Sins Doe", "account_number": "09123456789", "type": "INDIVIDUAL", "mobile_number": "+639000000000", "email": "johndoes@example.com", "address": "Lakambini Street.", "barangay": "San Mateo", "city": "Cabanatuan", "zip_code": "6969", "gender": "MALE" } } } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Disbursement API_Disbursement_Process Disbursement_example const url = 'https://https/v1/api/disbursement/process'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"channel":"maya","amount":1,"reference_no":"{{randomString}}","callback_webhook_url":"https://webhook.site/be6460ac-b4ab-4856-a721-1663d43b585e","fields":{"mobile_number":"+639193890579","bank_code":"161414","sender":{"first_name":"John","middle_name":"Sins","last_name":"Doe","suffix":"Jr."},"receiver":{"account_name":"John Sins Doe","account_number":"09123456789","type":"INDIVIDUAL","mobile_number":"+639000000000","email":"johndoes@example.com","address":"Lakambini Street.","barangay":"San Mateo","city":"Cabanatuan","zip_code":"6969","gender":"MALE"}}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Disbursement API_Disbursement_Process Disbursement_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/v1/api/disbursement/process" payload := strings.NewReader("{\n \"channel\": \"maya\",\n \"amount\": 1,\n \"reference_no\": \"{{randomString}}\",\n \"callback_webhook_url\": \"https://webhook.site/be6460ac-b4ab-4856-a721-1663d43b585e\",\n \"fields\": {\n \"mobile_number\": \"+639193890579\",\n \"bank_code\": \"161414\",\n \"sender\": {\n \"first_name\": \"John\",\n \"middle_name\": \"Sins\",\n \"last_name\": \"Doe\",\n \"suffix\": \"Jr.\"\n },\n \"receiver\": {\n \"account_name\": \"John Sins Doe\",\n \"account_number\": \"09123456789\",\n \"type\": \"INDIVIDUAL\",\n \"mobile_number\": \"+639000000000\",\n \"email\": \"johndoes@example.com\",\n \"address\": \"Lakambini Street.\",\n \"barangay\": \"San Mateo\",\n \"city\": \"Cabanatuan\",\n \"zip_code\": \"6969\",\n \"gender\": \"MALE\"\n }\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Disbursement API_Disbursement_Process Disbursement_example require 'uri' require 'net/http' url = URI("https://https/v1/api/disbursement/process") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Content-Type"] = 'application/json' request.body = "{\n \"channel\": \"maya\",\n \"amount\": 1,\n \"reference_no\": \"{{randomString}}\",\n \"callback_webhook_url\": \"https://webhook.site/be6460ac-b4ab-4856-a721-1663d43b585e\",\n \"fields\": {\n \"mobile_number\": \"+639193890579\",\n \"bank_code\": \"161414\",\n \"sender\": {\n \"first_name\": \"John\",\n \"middle_name\": \"Sins\",\n \"last_name\": \"Doe\",\n \"suffix\": \"Jr.\"\n },\n \"receiver\": {\n \"account_name\": \"John Sins Doe\",\n \"account_number\": \"09123456789\",\n \"type\": \"INDIVIDUAL\",\n \"mobile_number\": \"+639000000000\",\n \"email\": \"johndoes@example.com\",\n \"address\": \"Lakambini Street.\",\n \"barangay\": \"San Mateo\",\n \"city\": \"Cabanatuan\",\n \"zip_code\": \"6969\",\n \"gender\": \"MALE\"\n }\n }\n}" response = http.request(request) puts response.read_body ``` ```java Disbursement API_Disbursement_Process Disbursement_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/v1/api/disbursement/process") .header("Content-Type", "application/json") .body("{\n \"channel\": \"maya\",\n \"amount\": 1,\n \"reference_no\": \"{{randomString}}\",\n \"callback_webhook_url\": \"https://webhook.site/be6460ac-b4ab-4856-a721-1663d43b585e\",\n \"fields\": {\n \"mobile_number\": \"+639193890579\",\n \"bank_code\": \"161414\",\n \"sender\": {\n \"first_name\": \"John\",\n \"middle_name\": \"Sins\",\n \"last_name\": \"Doe\",\n \"suffix\": \"Jr.\"\n },\n \"receiver\": {\n \"account_name\": \"John Sins Doe\",\n \"account_number\": \"09123456789\",\n \"type\": \"INDIVIDUAL\",\n \"mobile_number\": \"+639000000000\",\n \"email\": \"johndoes@example.com\",\n \"address\": \"Lakambini Street.\",\n \"barangay\": \"San Mateo\",\n \"city\": \"Cabanatuan\",\n \"zip_code\": \"6969\",\n \"gender\": \"MALE\"\n }\n }\n}") .asString(); ``` ```php Disbursement API_Disbursement_Process Disbursement_example request('POST', 'https://https/v1/api/disbursement/process', [ 'body' => '{ "channel": "maya", "amount": 1, "reference_no": "{{randomString}}", "callback_webhook_url": "https://webhook.site/be6460ac-b4ab-4856-a721-1663d43b585e", "fields": { "mobile_number": "+639193890579", "bank_code": "161414", "sender": { "first_name": "John", "middle_name": "Sins", "last_name": "Doe", "suffix": "Jr." }, "receiver": { "account_name": "John Sins Doe", "account_number": "09123456789", "type": "INDIVIDUAL", "mobile_number": "+639000000000", "email": "johndoes@example.com", "address": "Lakambini Street.", "barangay": "San Mateo", "city": "Cabanatuan", "zip_code": "6969", "gender": "MALE" } } }', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Disbursement API_Disbursement_Process Disbursement_example using RestSharp; var client = new RestClient("https://https/v1/api/disbursement/process"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"channel\": \"maya\",\n \"amount\": 1,\n \"reference_no\": \"{{randomString}}\",\n \"callback_webhook_url\": \"https://webhook.site/be6460ac-b4ab-4856-a721-1663d43b585e\",\n \"fields\": {\n \"mobile_number\": \"+639193890579\",\n \"bank_code\": \"161414\",\n \"sender\": {\n \"first_name\": \"John\",\n \"middle_name\": \"Sins\",\n \"last_name\": \"Doe\",\n \"suffix\": \"Jr.\"\n },\n \"receiver\": {\n \"account_name\": \"John Sins Doe\",\n \"account_number\": \"09123456789\",\n \"type\": \"INDIVIDUAL\",\n \"mobile_number\": \"+639000000000\",\n \"email\": \"johndoes@example.com\",\n \"address\": \"Lakambini Street.\",\n \"barangay\": \"San Mateo\",\n \"city\": \"Cabanatuan\",\n \"zip_code\": \"6969\",\n \"gender\": \"MALE\"\n }\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Disbursement API_Disbursement_Process Disbursement_example import Foundation let headers = ["Content-Type": "application/json"] let parameters = [ "channel": "maya", "amount": 1, "reference_no": "{{randomString}}", "callback_webhook_url": "https://webhook.site/be6460ac-b4ab-4856-a721-1663d43b585e", "fields": [ "mobile_number": "+639193890579", "bank_code": "161414", "sender": [ "first_name": "John", "middle_name": "Sins", "last_name": "Doe", "suffix": "Jr." ], "receiver": [ "account_name": "John Sins Doe", "account_number": "09123456789", "type": "INDIVIDUAL", "mobile_number": "+639000000000", "email": "johndoes@example.com", "address": "Lakambini Street.", "barangay": "San Mateo", "city": "Cabanatuan", "zip_code": "6969", "gender": "MALE" ] ] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://https/v1/api/disbursement/process")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```