APappdirect
Payment Methods

List payment methods for a user

Changed on

Returns all available payment methods for the specified user in the specified company.

get/appMarket/v2/paymentMethods

Request

Query parameters

ownerIdstring required

ID of the user whose payment method you want to retrieve

companyIdstring required

ID of the company of which the user is a member

Response

OK

paymentMethodTypestring required

The type of payment method, such as CARD, BANKACCOUNT, and so on.

propertiesobject required

The properties of the payment method, as listed in getPaymentMethodTypes

idstring required

Id of the payment method.

accountDisplaystring required

Account display text, such as the last 4 digits of the credit card number.

defaultboolean

Indicates whether this is the default payment method.

Example response

[
  {
    "id": "e35c2f85-ef92-4a8f-89f0-45b62fb95fa7",
    "accountDisplay": "1111",
    "default": false,
    "paymentMethodType": "CARD",
    "properties": {
      "cardHolderName": "John Smith",
      "expirationMonth": "5",
      "expirationYear": "2019",
      "brand": "VISA"
    },
    "billingAddress": {
      "street1": "279 Prince St",
      "city": "Montreal",
      "state": "Quebec",
      "country": "CA",
      "zip": "H3C 2N4"
    }
  }
]

Changes

  • 1fc240f06971Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status