Transfers

List transfers

Changed on Nov 3, 2026

Returns your payouts. Look a payout up by your own reference before retrying one that timed out, to avoid sending twice.

get/v1/transfer

Request

Base URL
https://api.kyshi.co
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/docs/v1/transfer/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pageinteger

Page to retrieve. Defaults to 1.

limitinteger

Records per page. Maximum 100.

order'ASC' | 'DESC'

Sort direction. Defaults to DESC.

sortstring

Field to sort by.

querystring

Free-text search.

currencyObject

Filter by currency code.

beneficiaryIdstring

Filter by beneficiary ID.

statusstring

Filter by transfer status.

Response

Success.

statusboolean required

true on success.

messagestring required

codenumber required

Mirrors the HTTP status code.

Example response

{
  "status": true,
  "message": "Success",
  "code": 200,
  "data": {}
}

Changes

Nov 3, 20264aed77604588 Revision changes
- breaking
  for the query request parameter limit, default value 100 was removed
- breaking
  for the query request parameter page, default value 1 was removed
- breaking
  removed the enum value APPROVED from the query request parameter status
- breaking
  removed the enum value PENDING_APPROVAL from the query request parameter status
- breaking
  the response's body type changed from object to no type for status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  the endpoint scheme security ApiKeyAuth was added to the API
- info
  added the new optional query request parameter currency
- info
  added the new optional query request parameter order
- info
  added the new optional query request parameter query
- info
  added the new optional query request parameter sort
- info
  for the query request parameter beneficiaryId, the format was generalized from uuid to no format
- info
  added subschema #2 to the response body allOf list for the response status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history