GALANTHUS / ABI FUNCTION REFERENCE
gln_get_backend_result_interrupt_info
Declared in <galanthus/c_api/gln_capi.h>.
GLN_API const gln_interrupt_info_t* GLN_CALL gln_get_backend_result_interrupt_info(
const gln_backend_result_t* in_result);
Purpose
Returns borrowed interrupt details from an action-required backend result envelope.
The accessor returns NULL when the envelope outcome is not GLN_BACKEND_OUTCOME_ACTION_REQUIRED.
Return
Returns the borrowed interrupt detail stored in an action-required backend result envelope when one is available.
| Type | Nullability | Ownership |
|---|---|---|
const gln_interrupt_info_t* | nullable | borrowed |
Parameters
| Name | Direction | Type | Nullability | Ownership |
|---|---|---|---|---|
in_result | input | const gln_backend_result_t* | nullable | borrowed |
Notes
Passing NULL for in_result is allowed and returns NULL.
Use the returned gln_interrupt_info_t to decide which caller action is required before calling gln_resume_continuation.
The pointer is borrowed from the result envelope and becomes invalid when gln_destroy_backend_result releases that envelope. Copy needed fields before destroying the envelope if the caller will keep them.
Interrupt Fields
kind selects the active union-style sub-struct. GLN_INTERRUPT_TAN_REQUIRED populates tan.challenge, tan.challenge_html, optional tan.challenge_hhduc_or_null, optional tan.tan_medium_name_or_null, and optional tan.task_reference_or_null.
GLN_INTERRUPT_DECOUPLED_PENDING populates the same challenge fields under decoupled_poll and also sets decoupled_poll.retry_after_seconds when the bank supplied a suggested polling delay; otherwise the value is 0.
GLN_INTERRUPT_VOP_CONFIRMATION_REQUIRED populates vop_confirm.vop_id_or_null, vop_confirm.result_code_or_null, vop_confirm.alternate_name_or_null, and vop_confirm.explanatory_text_or_null from the normalized Verification of Payee response. Supported VoP confirmation resume paths confirm the VoP id stored in the continuation.
Provider status rows attached to any interrupt kind are read with gln_get_interrupt_info_provider_status_count and gln_get_interrupt_info_provider_status_at. For the broader action-required flow, see Backend Results, Continuations, and TAN and Resume.