> For the complete documentation index, see [llms.txt](https://teos-docs.coreledger.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://teos-docs.coreledger.net/white-label-portal/admin-user-guide/portal-configuration/features-configuration/redemption-functionality/template-for-redemption-details.md).

# Template for redemption details

Please, prepare a word document which will follow the rules described below. You should send this template to CL manager to apply it. Based on this template PDF with redemption details of each redemption will be generated and attached to the email sent to user.

### How to prepare layout

You can use any layout of the document. You can insert your company logo, any header and footer. All texts and images will be used exactly like you'll provide in the template except for the properties variables (described below).

All colors will be used as is. So do not put any color if you do not need it 

Any modification/extension of the template should be provided to CL.

### Properties variables

Using these variables, you will operate with the order specific data.

* Keywords (mapped to properties) are surrounded by <>.  Therefore, avoid using <> in the template except for mappings or if you open one “<” then close it by “>”. If the application cannot find a mapping for a found keyword between <>, it will not change it. &#x20;
* If two keywords are together (ex: \<ZIP>\<TOWN>) think of a white space between them unless you want them to be one word: 6300Zug&#x20;
* Some keywords are available depending on the redemption method

#### Available for all redemption methods

| \<referencecode>                  | Redemption reference code                                              |
| --------------------------------- | ---------------------------------------------------------------------- |
| \<netamountpayoutunits>           | How much the user really receives, taking into account all commissions |
| \<grossamountpayoutunits>         | Gross amount = net amount + fees                                       |
| \<currency>                       | transfer currency                                                      |
| \<grossamountinredeemassetsparks> | How much user pays in asset sparks in total                            |
| \<grossamountinredeemassetunits>  | How much user pays in asset units in total                             |
| \<asset.name>                     | Name of the asset                                                      |
| \<asset.unitofmeasure>            | Unit of measurement of the asset (kg, m3, and so on)                   |
| \<redemptionmethod>               | Name of the selected redemption method                                 |

#### Bank details&#x20;

Available only for redemption by bank transfer. If some of the optional properties values will be empty, nothing will be added to PDF

| \<bank.name>                                                                                                                                                                                                               | Beneficiary's bank name                                       |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| \<bank.country>                                                                                                                                                                                                            | Beneficiary’s bank country                                    |
| \<bank.stateOrRegion>                                                                                                                                                                                                      | Beneficiary’s bank state or region                            |
| \<bank.city>                                                                                                                                                                                                               | Beneficiary’s bank city                                       |
| \<bank.addressline>                                                                                                                                                                                                        | Beneficiary’s bank address                                    |
| \<bank.zipcode>                                                                                                                                                                                                            | Beneficiary’s bank zip code                                   |
| \<bank.iban>                                                                                                                                                                                                               | Beneficiary 's account                                        |
| \<bank.swift>                                                                                                                                                                                                              | Beneficiary 's bank Swift code                                |
| \<bank.bic>                                                                                                                                                                                                                | Beneficiary 's bank BIC code (local bank identification code) |
| \<intermediaryBank.name>\<intermediaryBank.country>\<intermediaryBank.city>\<intermediaryBank.stateOrRegion> \<intermediaryBank.addressline> \<intermediaryBank.zipcode> \<intermediaryBank.iban>\<intermediaryBank.swift> | Intermediary (correspondent) bank details                     |

#### Beneficiary details&#x20;

Available for all redemption types.&#x20;

| \<beneficiary.firstname>   | Beneficiary's first name |
| -------------------------- | ------------------------ |
| \<beneficiary.lastname>    | Beneficiary's last name  |
| \<beneficiary.country>     | Beneficiary's country    |
| \<beneficiary.city>        | Beneficiary's city       |
| \<beneficiary.addressline> | Beneficiary's address    |
| \<beneficiary.zipcode>     | Beneficiary’s zip code   |

#### Beneficiary details&#x20;

Available for Bitcoin, Ethereum and ERC-20 redemptions&#x20;

| \<walletaddress> | Beneficiary’s wallet address |
| ---------------- | ---------------------------- |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://teos-docs.coreledger.net/white-label-portal/admin-user-guide/portal-configuration/features-configuration/redemption-functionality/template-for-redemption-details.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.