Update an existing HouseAccountPayment

patch

https://qa2.revelup.com/resources/HouseAccountPayment/{HouseAccountPaymentId}/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

HouseAccountPaymentId

int64

required

ID of HouseAccountPayment to return

Body Params

HouseAccountPayment object that needs to be updated

amount

number

required

Amount of HouseAccountPayment object

amount_authorized

number

Amount of HouseAccountPayment object that is authorized

bill

integer

ID of the bill type for this payment

card_surcharge

number

Amount of card surcharge included in this payment

card_type

integer

ID of the card type provided this payment

cc_first_name

string

Credit Card owner first name information

cc_last_name

string

Credit Card owner last name information

change

number

Amount of change for this HouseAccountPayment object

created_date

date-time

required

Date and time when HouseAccountPayment object is created

customer_id

integer

Id of the customer that is attached to this HouseAccountPayment object

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 HouseAccountPayment, 'true' if executed

first_4_cc_digits

string

First 4 digits of the credit card PAN

gratuity

number

Amount of gratuity included in this payment

invoice_transition_date

date-time

Date and time when the invoice transited

is_billed

boolean

Defaults to false

If 'true' HouseAccountPayment is is billed

is_paid

boolean

Defaults to false

If 'true' HouseAccountPayment is is paid

last_4_cc_digits

string

required

Last 4 digits of the credit card PAN

online

boolean

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

order

uri

required

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

order_local_id

string

Local id of the Order in this HouseAccountPayment

payer_id

integer

Id of the person paying HouseAccountPayment

payment_date

date-time

required

Date and time when the HouseAccountPayment occurs

payment_type

integer

enum

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 HouseAccountPayment processor accepted HouseAccountPayment or not, 'true' if accepted

processor_response

string

Response returned by the HouseAccountPayment processor

receipt_email

string

Email that should recive receipt

refund_transaction_id

string

Transaction ID of the refunding this HouseAccountPayment

refunded

boolean

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

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)

tip

number

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

required

HouseAccountPayment transaction ID

transaction_status

uri

Response received and representing HouseAccountPayment transaction status

updated_date

date-time

required

Date and time when the HouseAccountPayment updated

uuid

uri

required

UUID of this HouseAccountPayment object

Responses

202

successful operation

400

Invalid input

401

authorization required

404

not found

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here!