GALANTHUS / ABI FUNCTION REFERENCE
gln_get_transaction_purpose
Declared in <galanthus/c_api/gln_capi.h>.
GLN_API const char* GLN_CALL gln_get_transaction_purpose(const gln_transaction_t* in_transaction);
Purpose
Returns the transaction purpose/remittance text.
Return
Returns remittance or purpose text stored on the row. MT940 reads structured purpose fragments from field :86:; CAMT and FinTS 4.1 read unstructured or structured remittance text where available.
| Type | Nullability | Ownership |
|---|---|---|
const char* | nullable | borrowed |
Parameters
| Name | Direction | Type | Nullability | Ownership |
|---|---|---|---|---|
in_transaction | input | const gln_transaction_t* | nullable | borrowed |
Payment Metadata
Returns remittance or purpose text stored on the row. MT940 reads structured purpose fragments from field :86:; CAMT and FinTS 4.1 read unstructured or structured remittance text where available.
An empty string means the source row did not provide purpose text. The pointer itself is non-null for a valid row.
Notes
Passing NULL for in_transaction is allowed and returns NULL.
Rows returned by the matching _at accessor carry this field as part of the materialized typed result.
The returned pointer is borrowed from the owning backend result envelope and becomes invalid when that envelope is destroyed.