Retrieve a list of transfers.

Paymish Docs

Paymish
Transfer

Endpoint Overview

GET /api/transaction-service/external/v1/transfer/get-transfer-list Requires authentication

Purpose

Use this endpoint to retrieve a list of transfers. It belongs to the Transfer collection and is designed for backend integrations.

Request shape

4 parameters and 0 documented body fields using application/json.

Implementation Guide

Recommended workflow

Authenticate first and inject a valid bearer token or secret key before calling the endpoint.

Validate the input data, identifiers, and account state in your application before making the request.

Send the GET request from your backend using the required headers and the expected content type (application/json).

Persist the important identifiers returned in the response so later lookups, webhooks, or support actions can be linked correctly.

Implementation notes

Validate and encode query parameters before sending them so filters and pagination behave predictably.

Query Parameters

transferReference

string

The reference number of the transfer.

status

string

The status of the transfer. Possible values are Successful, Failed, Blocked, Rejected, Pending, Unverified.

limit required

integer

The maximum number of records to return.

page required

integer

The current page number for pagination.

Responses

200 A list of transfers retrieved successfully.

400 Bad request due to invalid query parameters.

401 Unauthorized - Bearer token is missing or invalid.

500 Internal server error.

Expected Outcomes

A list of transfers retrieved successfully.

{
  "status": "success",
  "message": "Record retrieved successfully",
  "data": {
    "reference": "PM-REF-12345",
    "status": "success"
  }
}

Bad request due to invalid query parameters.

{
  "status": "error",
  "message": "Requested record was not found.",
  "errors": {
    "reference": [
      "Check the identifier and merchant context before retrying."
    ]
  }
}

After the response:

Log the Paymish reference or request context returned by the API so support teams can trace the call later.
Retry only when the failure is safe to repeat; otherwise correct the payload or auth state first.
Store enough internal metadata to match the API response back to your order, payout, case, or checkout record.

Language Notes

Python

Use `requests` from a backend worker, service, or Django/Flask app and centralize headers in a reusable helper.

Node.js

Use `axios` or `fetch` from Node.js services only; do not place secret credentials in frontend bundles.

PHP

Wrap cURL usage in a small client class so auth headers, error handling, and logging stay consistent.

cURL

Use cURL for smoke testing and debugging, then move the final logic into your backend service code.

Code Examples

import requests

headers = {
    "Authorization": "Bearer YOUR_SECRET_KEY",
}
response = requests.get(
    "https://api.paymish.com/api/transaction-service/external/v1/transfer/get-transfer-list",
    headers=headers,
)

data = response.json()
print(data)

const axios = require("axios");

const response = await axios({
  method: "get",
  url: "https://api.paymish.com/api/transaction-service/external/v1/transfer/get-transfer-list",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
  }
});

console.log(response.data);

curl https://api.paymish.com/api/transaction-service/external/v1/transfer/get-transfer-list \
   \
  -H "Authorization: Bearer YOUR_SECRET_KEY"

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/transaction-service/external/v1/transfer/get-transfer-list");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_SECRET_KEY",
]);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);

Previous endpoint Initiate a single transfer to a user. Next endpoint Retrieve the balance.