Payments v2

Retrieves Transfer Method by ID

Changed on

Retrieves the Transfer Method for the given ID

get/api/appMarket/v2/transferMethods/{transferMethodId}

Request

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

    • info

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

    • info

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

    • info

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