Adds new Payment object

post https://qa2.revelup.com/resources/Payment/

Body Params

Payment object that needs to be added

amount

string

required

Amount of payment is done

amount_authorized

string

Amount of payment is authorized

bill

integer

ID of the bill type for this payment

card_surcharge

string

Amount of card surcharge for this payment

card_type

integer

ID of the card type provided this payment

cash_drawer

integer

ID of the cash drawer related to this payment

cc_first_name

string

Credit Card owner first name information

cc_last_name

string

Credit Card owner last name information

change

string

Amount of change for this payment

created_by

uri

required

URI of an User API object which is responsible for this payment creation

created_date

date-time

required

Date and time when payment is created

currency_amount

string

Amount of given currency

currency_tip

string

Amount of tips in given currency

currency_type

integer

ID of the currency type used for this payment

deleted

boolean

Flag value specifying deletion status of the payment, 'true' if deleted

establishment

uri

required

URI of an Establishment API object which is responsible for this payment

exchanged

boolean

Flag value specifying exchange status of the payment, 'true' if exchanged

executed

boolean

Flag value specifying execution status of the payment, 'true' if executed

first_4_cc_digits

string

First 4 digits of the credit card PAN

gratuity

float

Amount of gratuity included in this payment

house_account

uri

URI of an HouseAccount API object related to this payment

int64

ID of the payment (unique)

invoice_transition_date

date-time

Date and time when the invoice transited

last_4_cc_digits

string

Last 4 digits of the credit card PAN

online

boolean

Flag value specifying whether the payment online or not, 'true' if online

order

uri

URI of an Order API object for which this payment is created

other_payment_type

integer

Extra information about type of the payment, used for integration for payments which could not be fit into existing model (defining in Settings/Payments and Establishment/Stations)

payer_id

integer

ID of the payer for this payment

payment_date

date-time

required

Date and time when the payment occurs

payment_type

integer

required

ID of the payment type, i.e. cash, credit card, gift, paypal, etc (defining in Settings/Payments and Establishment/Stations)

Payment Types:

0 - OTHER
1 - CASH
2 - CREDIT
3 - CHECK
4 - GIFT
5 - CREDITMANUAL
6 - CREDITPLUS
7 - EXTERNALLEVELUP
8 - DEBIT
9 - BADGE
10 - INDEX
11 - PAYPAL
12 - EBT_FOODSTAMP
13 - BITCOIN
14 - EBT_CASH
15 - ZAPPER
16 - SSMC
17 - SALE_LOSS_DRIVE_OFF
18 - FLEET_CARD
19 - FLEET_CARD_MANUAL
20 - WORAPAY
21 - STORE_CREDIT
22 - COMO
23 - LOYALTYPLANT
24 - VOUCHER
25 - RABBIT
26 - LINEPAY
27 - WECHAT_ALIPAY
28 - LCMS_VOUCHER
29 - NETS
30 - LEVELUP_GIFT
31 - SERVICECHARGE
32 - DEPOSIT

processor_accepted

boolean

Flag value specifying whether payment processor accepted payment or not, 'true' if accepted

processor_response

string

Response returned by the payment processor

rate

string

Payment rate amount

receipt_email

string

Email address for sending payment receipt

refund_transaction_id

string

Transaction ID of the refunding this payment

refunded

boolean

Flag value specifying whether payment refunded or not, 'true' if refunded

resource_uri

uri

URI of this Payment API object

rounding_delta

float

Value of the delta in rounding operations

signature_img_url

string

URL to the image containg signature of payer for this payment

source_type

integer

ID of payment source type (defining in Settings/Payments and Establishment/Stations)

station

uri

URI of an PosStation API object related to the POS processing this payment

till_owner

uri

URI of an User API object which is owner of this payment till

tip

string

required

Amount of tips included in this payment

transaction_captured

boolean

Flag value specifying whether payment transaction captured or not, 'true' if captured

transaction_data

string

Extra transaction data which could not be fit into existing model or added for system integration

transaction_id

string

Payment transaction ID

transaction_status

uri

Response received and representing payment transaction status

updated_by

uri

required

URI of an User API object which is responsible for this payment update

updated_date

date-time

required

Date and time when the payment updated

uuid

uri

required

UUID of this payment

Responses

201

Successful operation

401

Authorization required

405

Invalid input