APappdirect
Payments v2

Retrieve transfer methods

Changed on

Retrieves the transfer methods associated with the requesting (authenticated) user

get/api/appMarket/v2/transferMethods

Request

Query parameters

includeBalanceboolean

Determines whether the response should include the transfer method balance

Response

OK

propertiesobject required

The transfer method properties

platformTypestring required

The transfer platform type

partyIdstring required

The ID of the transfer method's party

partyTypestring required

The type of the transfer method's party (USER, CHANNEL, and so on)

idstring required

The transfer method ID

displayNamestring required

The transfer method display name

Example response

[
  {
    "id": "619da695-42d6-4189-9cc2-cdc885a3a4f7",
    "properties": [
      {
        "property1": "property1 value"
      }
    ],
    "platformType": "stripe",
    "partyId": "1",
    "partyType": "USER",
    "balance": {
      "amount": "10.00",
      "currency": "USD"
    },
    "displayName": "****1234"
  }
]

Changes

  • 1fc240f06971Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added subschema #2: TransferMethodResponse to the response property allOf list for the response status