APappdirect
Payments v2

Create transfer methods

Changed on

Creates a new Transfer Method for the requesting (authenticated) user

post/api/appMarket/v2/transferMethods

Request

Request body

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)

Example request

{
  "platformType": "stripe",
  "partyId": "1",
  "partyType": "USER",
  "properties": {
    "account_id": "123456"
  }
}

Response

The transfer method request has been created successfully

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

      added subschema #2: TransferMethodRequest to the request body allOf list

    • 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