APappdirect
AppResellerPaymentMethod

Create payment method

Changed on

Creates a payment method on behalf of the specified user

post/appReseller/v1/paymentMethods

Request

Request body

ownerIdstring required

ID of the user for whom to create the payment method

companyIdstring required

ID of the user's company

paymentMethodTypestring required

Payment method types supported by AppReseller

propertiesobject

List of payment method properties. Varies by payment method type

Example request

{
  "ownerId": "833d4c99-1939-0000-0000-6fb7ae30000",
  "companyId": "6b4bd452-895d-0000-0000-e6046b230000",
  "paymentMethodType": "CARD",
  "properties": {
    "cardHolderName": "John Jordan",
    "number": "0000-0000-0000-0000",
    "securityCode": "000",
    "expirationMonth": "10",
    "expirationYear": "2100",
    "brand": "VISA"
  },
  "billingAddress": {
    "street1": "Alden",
    "city": "Beverly Hills",
    "country": "US",
    "zip": "94203",
    "state": "CA"
  }
}

Response

Success

idstring required

Payment method ID

accountDisplaystring

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

defaultboolean required

Indicates whether this is the user's default payment method

paymentMethodTypestring required

Payment method types supported by AppReseller

propertiesobject

List of payment method properties. Varies by payment method type

Example response

{
  "billingAddress": {
    "street1": "Alden",
    "city": "Beverly Hills",
    "country": "US",
    "zip": "94203",
    "state": "CA"
  },
  "owner": {
    "id": "2c061df6-4313-45e0-8709-a0ca19b0aaa3",
    "firstName": "Michael",
    "lastName": "Jordan"
  }
}

Changes

  • 1fc240f06971Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

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

    • info

      added the new optional request property

    • 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 required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status