Create

Create

Create

Adds a payment type to an account.

Request

Method
URL
POST

Path Parameters

Name
Required
Type
Description
accountUniqueId

Guid
The unique ID of the account.

Headers

Name
Required
Type
Description
APIKey

Guid
A valid API key with a scope of AccountLists

Body

Name
Required
Type
Description
paymentType

Text
The name of the payment type. Maximum length is 32 characters and it cannot be empty.
active
Boolean
Indicates if the payment type is active or inactive. The default is active.
creditOrDebit
Boolean
Indicates whether this payment type represents a credit/debit card payment (true) versus something else such as cash or check (false). The default is false.
{
"paymentType": "Visa/Mastercard",
"active": true,
"creditOrDebit": true
}

Remarks

paymentType is required, cannot be empty, and cannot exceed 32 characters.
A payment type's name must be unique within an account. If a payment type with the same name already exists for the account, the request will fail with a 409 Conflict.
If active is omitted, the payment type is created as active. If creditOrDebit is omitted, the payment type is created as false (not a credit/debit card payment).

Response

Headers

Location — the URL of the newly created payment type.

Status Code

Code
Description
201 Created
The payment type was created.
400 Bad Request
The payment type was not created. This occurs if paymentType is missing, empty, or exceeds 32 characters.
401 Unauthorized
The API key is missing, invalid, disabled, or does not have the correct scope.
403 Forbidden
The API key does not belong to this account, the account does not have the API-keys feature, or the key does not have the required scope.
409 Conflict
A payment type with that name already exists for this account.

Body

Name
Type
Description
uniqueId
Guid
The unique ID of the payment type.
paymentType
Text
The name of the payment type.
active
Boolean
Indicates if the payment type is active or inactive.
creditOrDebit
Boolean
Indicates whether this payment type represents a credit/debit card payment (true) or something else (false).