> 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. # Get Transactions GET https://disbursement-api-stg.epaygames.io/v1/api/disbursement/transactions ### Get Transactions The **Get Transactions** endpoint retrieves a list of all disbursement transactions associated with your account. You can use this to check the status of a specific payout. **Possible Statuses:** - `pending` - `completed` - `cancelled` > A payout is marked as `cancelled` if it failed or was cancelled — there is no separate `failed` status. No funds are transferred for a `cancelled` payout. #### Usage Tips Always filter by `reference_no` to look up the one payout you care about — unfiltered or broadly-filtered listing is discouraged and being phased out. Prefer webhooks (`callback_webhook_url`) over polling for routine status tracking. Reference: https://docs.epaygames.io/disbursement-api/disbursement/get-transactions ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: disbursement version: 1.0.0 paths: /v1/api/disbursement/transactions: get: operationId: Get Transactions summary: Get Transactions description: >- ### Get Transactions The **Get Transactions** endpoint retrieves a list of all disbursement transactions associated with your account. You can use this to check the status of a specific payout. **Possible Statuses:** - `pending` - `completed` - `cancelled` > A payout is marked as `cancelled` if it failed or was cancelled — there is no separate `failed` status. No funds are transferred for a `cancelled` payout. #### Usage Tips Always filter by `reference_no` to look up the one payout you care about — unfiltered or broadly-filtered listing is discouraged and being phased out. Prefer webhooks (`callback_webhook_url`) over polling for routine status tracking. tags: - disbursement parameters: - name: reference_no in: query description: >- Recommended. Look up a single transaction by the `reference_no` you supplied when creating it. This is the intended way to check a transaction's status — avoid unfiltered listing. required: false schema: type: string - name: provider_reference_no in: query description: >- Filter by the upstream provider's reference number, when you have it. required: false schema: type: string - name: channel in: query description: Filter by channel code (see Get Channels). required: false schema: type: string - name: status in: query description: Filter by transaction status. required: false schema: $ref: >- #/components/schemas/V1ApiDisbursementTransactionsGetParametersStatus - name: date_from in: query description: >- Start of a date-range filter. Use sparingly — avoid combining date ranges with unbounded pagination for routine polling. required: false schema: type: string - name: date_to in: query description: End of a date-range filter. Use sparingly — see `date_from`. required: false schema: type: string - name: page in: query description: >- Legacy pagination. Works today, but don't build new integration logic around browsing pages of results — look up by `reference_no` instead. required: false schema: type: integer - name: per_page in: query description: Legacy pagination page size (max 100). See `page`. required: false schema: type: integer - name: Authorization in: header description: >- Bearer token obtained from the Create Access Token endpoint. Tokens are valid for ~60 minutes — cache and reuse a token for its full lifetime instead of re-authenticating per request. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/Disbursement API_Disbursement_Get Transactions_Response_200 '401': description: Unauthorized — missing, invalid, or expired bearer token. content: application/json: schema: $ref: >- #/components/schemas/GetV1ApiDisbursementTransactionsRequestUnauthorizedError servers: - url: https://disbursement-api.epaygames.io description: Production - url: https://disbursement-api-stg.epaygames.io description: Staging/Sandbox components: schemas: V1ApiDisbursementTransactionsGetParametersStatus: type: string enum: - pending - completed - cancelled title: V1ApiDisbursementTransactionsGetParametersStatus V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaDataTransactionsItemsStatus: type: string enum: - pending - completed - cancelled title: >- V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaDataTransactionsItemsStatus V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaDataTransactionsItemsChannel: type: object properties: name: type: string description: description: Any type slug: type: string code: type: string required: - name - slug - code title: >- V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaDataTransactionsItemsChannel V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaDataTransactionsItems: type: object properties: reference_no: type: string subtotal_amount: type: integer service_fee: type: integer total_amount: type: integer status: $ref: >- #/components/schemas/V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaDataTransactionsItemsStatus date: type: string format: date-time channel: $ref: >- #/components/schemas/V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaDataTransactionsItemsChannel required: - reference_no - subtotal_amount - service_fee - total_amount - status - date - channel title: >- V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaDataTransactionsItems V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaDataMeta: type: object properties: current_page: type: integer from: type: integer last_page: type: integer per_page: type: integer to: type: integer total: type: integer required: - current_page - from - last_page - per_page - to - total title: >- V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaDataMeta V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaData: type: object properties: transactions: type: array items: $ref: >- #/components/schemas/V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaDataTransactionsItems meta: $ref: >- #/components/schemas/V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaDataMeta required: - transactions - meta title: >- V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaData Disbursement API_Disbursement_Get Transactions_Response_200: type: object properties: message: type: string data: $ref: >- #/components/schemas/V1ApiDisbursementTransactionsGetResponsesContentApplicationJsonSchemaData required: - message - data title: Disbursement API_Disbursement_Get Transactions_Response_200 GetV1ApiDisbursementTransactionsRequestUnauthorizedError: type: object properties: message: type: string required: - message title: GetV1ApiDisbursementTransactionsRequestUnauthorizedError securitySchemes: bearerAuth: type: http scheme: bearer description: >- Bearer token obtained from the Create Access Token endpoint. Tokens are valid for ~60 minutes — cache and reuse a token for its full lifetime instead of re-authenticating per request. ``` ## Examples **Response** ```json { "message": "", "data": { "transactions": [ { "reference_no": "TESTOYHVPFFEIKTSC3VIOFHP", "subtotal_amount": 15, "service_fee": 0, "total_amount": 15, "status": "cancelled", "date": "2025-09-15T19:01:43+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } }, { "reference_no": "TESTCG2DTLVWHROVLBNDSN7R", "subtotal_amount": 1, "service_fee": 0, "total_amount": 1, "status": "completed", "date": "2025-06-26T08:57:12+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } }, { "reference_no": "TESTQZUBBEV8F19PT7MPRIGV", "subtotal_amount": 1, "service_fee": 0, "total_amount": 1, "status": "completed", "date": "2025-06-20T05:25:41+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } }, { "reference_no": "TEST2WJJR3PXDAL7N8V956QR", "subtotal_amount": 1, "service_fee": 0, "total_amount": 1, "status": "completed", "date": "2025-06-20T05:21:20+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } }, { "reference_no": "TESTDPKMQJCLJLBEMVZV3WJQ", "subtotal_amount": 1, "service_fee": 0, "total_amount": 1, "status": "cancelled", "date": "2025-06-20T05:18:56+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } }, { "reference_no": "TESTCBJ053SAGS0FDDSGPZEV", "subtotal_amount": 1, "service_fee": 0, "total_amount": 1, "status": "cancelled", "date": "2025-06-20T05:15:08+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } }, { "reference_no": "TEST5KNT0I9ULXGO3S87DOBD", "subtotal_amount": 1, "service_fee": 0, "total_amount": 1, "status": "cancelled", "date": "2025-06-18T14:18:13+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } }, { "reference_no": "TESTKI7TBEPXOKUDNVKMSWO8", "subtotal_amount": 1, "service_fee": 0, "total_amount": 1, "status": "completed", "date": "2025-06-18T12:21:04+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } }, { "reference_no": "TESTE3KGF35MQCN9JPFM8BXQ", "subtotal_amount": 1, "service_fee": 0, "total_amount": 1, "status": "completed", "date": "2025-06-18T10:35:40+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } }, { "reference_no": "TESTPUUVXO5NGI9HWDFHGJKU", "subtotal_amount": 1, "service_fee": 0, "total_amount": 1, "status": "cancelled", "date": "2024-11-22T03:52:43+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } }, { "reference_no": "TESTUXBJMDGJJURENRK7ENZI", "subtotal_amount": 1, "service_fee": 0, "total_amount": 1, "status": "completed", "date": "2024-04-11T14:09:24+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } }, { "reference_no": "TESTQ7Z6BTCOMCYP7ANFTCND", "subtotal_amount": 100, "service_fee": 0, "total_amount": 100, "status": "cancelled", "date": "2024-04-10T11:47:07+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } }, { "reference_no": "TEST29USFB0RTLJR7X1SSXSZ", "subtotal_amount": 1, "service_fee": 0, "total_amount": 1, "status": "completed", "date": "2024-04-10T11:29:53+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } }, { "reference_no": "TESTPOCXONQ6ESRUJV8ZHJXH", "subtotal_amount": 1, "service_fee": 0, "total_amount": 1, "status": "completed", "date": "2024-04-04T10:59:20+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } }, { "reference_no": "TEST8VEUQUY0XWZUETZRH9DG", "subtotal_amount": 1, "service_fee": 0, "total_amount": 1, "status": "completed", "date": "2024-04-04T10:58:23+08:00", "channel": { "name": "InstaPay", "slug": "instapay", "code": "INSTAPAY" } } ], "meta": { "current_page": 1, "from": 1, "last_page": 7, "per_page": 15, "to": 15, "total": 92 } } } ``` **SDK Code** ```python Disbursement API_Disbursement_Get Transactions_example import requests url = "https://disbursement-api-stg.epaygames.io/v1/api/disbursement/transactions" querystring = {"reference_no":"TESTINGREFNO01"} headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript Disbursement API_Disbursement_Get Transactions_example const url = 'https://disbursement-api-stg.epaygames.io/v1/api/disbursement/transactions?reference_no=TESTINGREFNO01'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Disbursement API_Disbursement_Get Transactions_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://disbursement-api-stg.epaygames.io/v1/api/disbursement/transactions?reference_no=TESTINGREFNO01" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") 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_Get Transactions_example require 'uri' require 'net/http' url = URI("https://disbursement-api-stg.epaygames.io/v1/api/disbursement/transactions?reference_no=TESTINGREFNO01") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java Disbursement API_Disbursement_Get Transactions_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://disbursement-api-stg.epaygames.io/v1/api/disbursement/transactions?reference_no=TESTINGREFNO01") .header("Authorization", "Bearer ") .asString(); ``` ```php Disbursement API_Disbursement_Get Transactions_example request('GET', 'https://disbursement-api-stg.epaygames.io/v1/api/disbursement/transactions?reference_no=TESTINGREFNO01', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp Disbursement API_Disbursement_Get Transactions_example using RestSharp; var client = new RestClient("https://disbursement-api-stg.epaygames.io/v1/api/disbursement/transactions?reference_no=TESTINGREFNO01"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift Disbursement API_Disbursement_Get Transactions_example import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://disbursement-api-stg.epaygames.io/v1/api/disbursement/transactions?reference_no=TESTINGREFNO01")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers 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() ```