KYkyshi
Transfers

List beneficiaries

Changed on

Returns your saved payout beneficiaries.

get/v1/transfer/beneficiaries

Request

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.

accountNumberstring

Filter by beneficiary account number.

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

  • 4aed77604588Revision changes
    • breaking

      for the query request parameter limit, default value 100 was removed

    • breaking

      for the query request parameter order, default value DESC was removed

    • breaking

      for the query request parameter page, default value 1 was removed

    • 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 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