Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
PaymentType

Retrieve a payment type

Get a payment type for the specified business id and payment type id.

get/api/business/{businessId}/paymenttype/{paymentTypeId}

Path parameters

businessIdstring required
paymentTypeIdstring required

Response

Specified payment type retrieved

paymentTypeIdstring

Unique id for the paymentType

namestring

The customTypeName given to the payment type.

codestring

Unique code for payment type

archivedboolean

Payment type is archived

builtInboolean

System built in payment type - CASH, CARD, ACCOUNT etc.

bankedboolean

Payment type is banked

Example response

{
  "paymentTypeId": "mWkA6EjdLDyTGL7APWsPxw",
  "name": "Cash",
  "code": "AC"
}