Amount of payments that have been refunded to the customer
Sale Types
Value
Description
virtual_terminal
Created by merchant in Point of Sale
online_store
Created by customer in Online Store
recurring_payment
Created by recurring payment
payment_plan
Created by payment plan
invoice
Created by paying invoice
api
Created via API 4
ios
Created by mobile app using device running Apple iOS
android
Created by mobile app using device running Android
batch
Created by import batch
subscription
Created by billing schedule
order_details
Created by merchant from order details page
embeddable
Created by embeddable such as buy now button
Address Properties
Property
Type
Description
company_name
string
Company name of address
address1
string
Street address line one
address2
string
Street address line two
city
string
City
state
string
State
zip_code
string
Postal code
address_types
array
Type of address. Values: shipping, service
Order Status Types
Value
Description
paid
Order is fully paid.
unpaid
No succesful payments have been made on the order and there is an outstanding balance due.
cancelled
Order cancelled. No more payments can be collected on the order.
partially_paid
Successful payment(s) have been made on the order, however there is still an outstanding balance due.
Payment Status Types
Value
Description
no_payment_required
Order created at checkout had only items scheduled for the future, thus no payment was required ($0 amount due).
unknown
The initial stage for every transaction sent for authorization. The system assigns this status while waiting for an authorization response. In some rare cases, if communication is disrupted before the system gets a response, the transaction will remain in the unknown status.
posted
Credit Card and ACH payments that have been entered in the system, but not yet settled. This is the initial status for an authorized but unsettled ACH transaction.
settled
A settled ACH or Credit Card payment.
failed
Attempted transactions that were never authorized or completed.
voided
A voided ACH or Credit Card transaction.
reversed
A transaction that has been reversed (refunded). When a settled transaction is refunded, the status of that transaction changes to reversed. Displays as status "Refunded" in the PaySimple UI.
reverse_posted
The credit transaction generated when a settled ACH transaction is refunded. When the refund settles, the status changes to refund_settled. Displays as "Refund (Posted)" in the PaySimple UI.
chargeback
An ACH payment being disputed by the customer.
authorized
Credit card payments and refunds that have been authorized, but not yet submitted for processing.
returned
ACH payments that were initially posted but ultimately unsuccessful for any reason other than non-sufficient funds or chargeback.
reverse_n_s_f
An ACH transaction that failed because the customer had insufficient funds in the account to cover the payment. Displays as "Returned (NSF)" in the PaySimple UI.
refund_settled
A settled Credit Card or ACH refund transaction. Displays as "Refund Settled" in the PaySimple UI.
refund_scheduled
A refund is scheduled for the future
Order Item Properties
Property
Type
Description
offering_id
string
Unique identifier of the offering (catalog item).
name
string
Name of item purchased as defined in the catalog.
quantity
integer
Number of items purchased
price
decimal
Price of one item
amount_subtotal
decimal
Total amount charged for catalog item, adding fees and subtracting discounts (not including taxes)