TAG LINE
SMALL TITLE

Payment Method

(API Version v3)


What can you do with PaymentMethod?


Properties

Property Details
id
"id": 4
Type: Number
This is the unique numeric identifier for the PaymentMethod
ownerId
"ownerId": 12
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
paymentTypeId
"paymentTypeId": 18
Type: Number
Unique identifier for the associated PaymentType object.
accountId
"accountId": 25
Type: Number
Unique identifier for the associated Account object.
description
"description": "Hello World"
Type: String
paymentMethodToken
"paymentMethodToken": "Hello World"
Type: String
paymentMethodIdentifier
"paymentMethodIdentifier": "Hello World"
Type: String
isActive
"isActive": true
Type: Boolean
autopay
"autopay": true
Type: Boolean
transactionToken
"transactionToken": "Hello World"
Type: String


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • paymentTypeId
  • accountId
  • description
  • paymentMethodToken
  • paymentMethodIdentifier
  • isActive
  • autopay
  • transactionToken

DataFlow PATCH objects:


End Points

DELETEapi/v3/PaymentMethod/{id:int}
Delete an instance of the PaymentMethod object.
GETapi/v3/PaymentMethod
Retrieve all of the PaymentMethod objects.
GETapi/v3/PaymentMethod/Paged
Retreive all of the PaymentMethod objects in a paged fashion.
GETapi/v3/PaymentMethod/{id:int}
Retrieve an instance of the PaymentMethod object by it's ID.
{id:int}Unique identifier for the PaymentMethod object.
POSTapi/v3/PaymentMethod/BankAccount
Create a new instance of the PaymentMethod object.
POSTapi/v3/PaymentMethod/CreditCard
Create a new instance of the PaymentMethod object.
POSTapi/v3/PaymentMethod/Import
Create a new instance of the PaymentMethod object.
PUTapi/v3/PaymentMethod/{id:int}
Update an existing instance of the PaymentMethod object.