Payments
- Joel Morgan Kearney (Unlicensed)
- Andrew Forster
- Lucy Barber (Unlicensed)
- Joel Kearney
These are the endpoints that are available under the /payments path, which lists all the different payments on an account.
| Endpoint | Description |
|---|---|
| GET /payments/invoice/{invoiceId} | Returns all payment objects which represent payments or refunds that have been recorded to specified invoice in array format. |
| GET /payments/paymentMethods | Returns an array of strings that represent the current acceptable payment methods. Has acceptable values "Cash", "Check", "Visa", "Master Card", "Amex", "Discover". |
| GET /payments/cashRegister | Returns all payment that have the gateway property set to MANUAL and have paymentMode set to "Cash". |
| GET /payments/giftCard/{giftCardUUID} | Returns all payment objects that have been made with specified gift card in array format. |
| POST /payments/manualPayment | Creates a new payment object on an invoice. Request body/payload: Must pass a payment object in request body/payload, and must set the gateway field to "MANUAL". For these calls, you need to pass a payments object with all required fields and any fields you want to set filled in the body of the payload. We have an example of a payments object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
| POST /invoicePaymentMap/{invoiceId} | Returns a payment portal object that contains a redirectUrl and a postUrl. If the redirectUrl is not null, then the payment portal has an embeddable page that you can display in the modal window (true for Square, Stripe, Authorize.net). If the redirectUrl is null, then a postUrl will be provided that can be used along with the map property returned from this POST response to create a form post and pass the user’s browser to the external URL (true for PayPal). Request body/payload: Must pass amount to be charged in request body/payload. |
| POST /invoice/charge/stripe/{invoiceId}/{clientId} | This endpoint can only be used when the client object's stripeCustomerId property is filled in. Request body/payload: Must pass amount to be charged in request body/payload. |
| POST /payments/payByGiftCard | Creates a new payment object on an invoice that has paymentMode = "GiftCard". Request body/payload: Must pass a payment object with giftCardUUID property filled in request body/payload. |
| DELETE /payments/{paymentId} | Deletes a payment or refund object previously recorded to an invoice from your account by setting its active property to false. |
There are no parameters included with payments calls.
The objects below represent the minimum viable objects to pass that are needed to create or update a payments object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.
Property Name | Data Type | Required | Description |
|---|---|---|---|
| amount | integer | Yes | Displays the monetary amount recorded as paid or refunded. |
| avsAddress | string | ||
| avsZipCode | |||
| businessId | integer | Yes | Provides unique numeric ID for the business issuing the invoice for which you are recording the specified payment/refund. |
| calendarId | integer | Provides unique numeric ID for the calendar of the business issuing the invoice for which you are recording the specified payment/refund. | |
| cardExpirationDate | string | Displays the expiration date of the credit card used in the specified payment in MM-DD-YYYY form. | |
| cardNumber | string | Repurposed to record and display comments added while recording payment/refund in the TimeTap UI. | |
| cardType | string | Displays as the type of credit card used to make the specified payment/refund. | |
| client | object | Client object for client of the specified payment - for more info, see Clients API page. | |
| clientId | integer | Provides unique numeric ID for the client that made the specified payment/refund. | |
| createdDate | integer | Displays as the date the specified payment/refund was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
| createdUser | string | Displays as username of the user who created the specified payment/refund. | |
| currency | string | Displays the ISO 4217 currency code for the currency used to make the specified payment/refund. | |
| gateway | string | Displays as plain-text identifier to specify which payment gateway was used to record the specified payment/refund. | |
| gatewayChargeId | string | Provides unique alphanumeric ID for the gateway charged. | |
| gatewayId | integer | Provides unique numeric ID for the payment gateway used to record the specified payment/refund. | |
| giftcardUUID | string | Provides unique alphanumeric ID for the specified gift card. | |
| invoiceId | integer | Yes | Provides unique numeric ID for the invoice to which you are applying the specified payment/refund. |
| modifiedDate | integer | Displays as date on which the specified payment/refund was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
| modifiedUser | string | Displays as username of the user who last modified the specified payment/refund. | |
| mwToken | string | Provides a unique system identifier. | |
| paymentDate | integer | Displays as date on which the specified payment object was created. | |
| paymentHistory | string | Displays the payment history for the specified payment/refund. | |
| paymentId | integer | Provides unique numeric ID for the specified payment object. | |
| paymentMode | string | Displays as plain-text identifier used to specify which method of payment was used to record the specified payment/refund. | |
| paymentType | string | Displays as the payment type of the specified payment. Has acceptable values Sale, | |
| professionalId | integer | Provides unique numeric ID for the staff member recording the specified payment/refund. | |
| rawData | string | Displays the payment data as a JSON. | |
| salesForceId | string | Provides unique alphanumeric ID for the SalesForce account associated with the specified payment/refund. | |
| status | string | Displays as status of the specified payment. Has acceptable values OPEN, CLOSED, VOID, DELETED. | |
| statusSummary | string |