create new ticket
check ticket statusGetting Started
If you are new to the HTML document/canned email tag system, you can get an overview of tags, objects and loops here.
Accessing The Payment Object
Access to this object is dependent on what document or canned email type you are trying to access the object from. Start by finding the document or canned email type you are working with from the links provided below. Follow the chart for your specified document or canned email type to see if the object is accessible, and if so, where it is located. You may need to use a combination of loops and/or chaining to access this object.
Accessing The Payment Tags
Assuming you have access to the Payment object, you must do one of the following:
1. Prefix the object's name to the required tag
2. If the tag contains an 'Additional Sub Object', then the tag must prefix the sub-object tag and suffix the object
3. If the tag is a list type, then the tag must be looped. The sub-object tags should be nested within the loop.
4. If the object itself is a list type, then the object must be looped. The tags and/or sub-object tags should be nested within the loop.
5. If the object itself and the sub-object are list types, then both objects must be looped. The sub-sub-objects tags and/or objects should be nested within the loop.
Here is a chart displaying these use cases.
| Syntax | Example | |
1 | {{Payment.TagName}} | {{Payment.Amount}} |
2 | {{Payment.TagName.SubObjectTagName}} | {{Payment.Customer.Name}} |
3 | <!-- {{#each Payment.TagName}} --> {{SubObjectTagName}} <br /> <!-- {{/each}} --> | <!-- {{#each Payment.OrderPayments}} --> {{Amount}} <br /> <!-- {{/each}} --> |
4 | <!-- {{#each Payments}} --> {{TagName}} <br /> <!-- {{/each}} --> | <!-- {{#each Payments}} --> {{Amount}} <br /> <!-- {{/each}} --> |
| 5 | <!-- {{#each Payments}} --> <!-- {{#each TagName}} --> {{SubObjectTagName}} <br /> <!-- {{/each}} --> <!-- {{/each}} --> | <!-- {{#each Payments}} --> <!-- {{#each OrderPayments}} --> {{Amount}} <br /> <!-- {{/each}} --> <!-- {{/each}} --> |
Overview
| Tag Name | Description | Type | Additional Sub Object |
| Amount | The total amount of the payment | Decimal Value | |
| CashDate | The date of the payment | Date/Time | |
| CreatedDate | The actual date the payment was created in the system. | Date/Time | |
| CreditCardExpiryDate | The expiration date of the credit card. | String | |
| CreditCardType | The type of credit card | String | |
| CustomerId | The id of the customer that owns this payment, it can be found in the url. | Guid | |
| Customer | The tags relating to a customer can be accessed for the customer on this payment. | Text | Customer Tags |
| Deposit | The tags relating to a deposit can be accessed for the deposit this payment is in. | Deposit Tags | |
| DepositId | The id of the deposit that holds this payment, it can be found in the url. | Guid | |
| Id | The id of payment. | Guid | |
| LastFourCreditCardDigits | The last four digits of the credit card number. | String | |
| OrderPayments | The tags relating to an order payment can be accessed for the order payment was applied to. | List | Order Payment Tags |
| ReferenceNumber | This the reference number that can be entered on the payment. | Text | |
| TransactionNumber | This is the transaction number that is returned when completing a payment through a credit processing integration. | Text | |
| Type | This is the type of payment that has been selected on the payment. | Text |