GALANTHUS / ABI FUNCTION REFERENCE
gln_get_standing_order_reference
Declared in <galanthus/c_api/gln_capi.h>.
GLN_API const char* GLN_CALL gln_get_standing_order_reference(const gln_standing_order_t* in_standing_order);
Purpose
Returns the bank order reference when available.
Return
Returns the bank or provider order reference attached to the materialized standing-order row when one is available. Returns NULL when the optional field is not materialized or when the input handle is NULL.
| Type | Nullability | Ownership |
|---|---|---|
const char* | nullable | borrowed |
Parameters
| Name | Direction | Type | Nullability | Ownership |
|---|---|---|---|---|
in_standing_order | input | const gln_standing_order_t* | nullable | borrowed |
Order Identity
Returns the bank or provider order reference attached to the materialized standing-order row when one is available.
Use this value as the order reference for modify or delete requests; the C API modify and delete requests require a non-empty order reference. NULL means no order reference was materialized for the row.
Notes
Passing NULL for in_standing_order is allowed and returns NULL.
NULL means the provider did not supply this optional field for the row.
The returned pointer is borrowed from the owning backend result envelope and becomes invalid when that envelope is destroyed.