GALANTHUS / ABI FUNCTION REFERENCE
gln_submit_instant_transfer
Declared in <galanthus/c_api/gln_capi.h>.
GLN_API gln_status_t GLN_CALL gln_submit_instant_transfer(
gln_backend_t* in_backend,
const gln_submit_instant_transfer_request_t* in_request,
gln_backend_result_t** out_result);
Purpose
gln_submit_instant_transfer submits an immediate-only FinTS instant transfer and returns a gln_backend_result_t envelope.
Backend support is operation-specific. Use gln_check_backend_operation_support to check whether a backend supports this operation before calling it. Unsupported operations return an envelope whose status is GLN_ERR_NOT_SUPPORTED.
When To Use
Use this operation only for immediate instant-transfer submission. It uses gln_submit_instant_transfer_request_t, which has no requested execution date field.
FinTS may require TAN, decoupled approval, or VoP confirmation before a success envelope exists.
Call Contract
GLN_OK from the function means an envelope was produced in *out_result; it does not mean the backend operation succeeded. Inspect the envelope with gln_get_backend_result_outcome, gln_get_backend_result_status, and gln_get_backend_result_kind.
out_result == NULL is the no-envelope invalid-argument case. In that case the function returns GLN_ERR_INVALID_ARG directly.
For gln_submit_instant_transfer_request_t, initialize the struct with gln_default_submit_instant_transfer_request. The request carries source identity, recipient identity, amount, currency, purpose, and optional end_to_end_reference_or_null; the default helper sets currency to EUR.
The parameter table is binding for required handles and output slots.
Return
Returns GLN_OK when the call produced a gln_backend_result_t envelope in out_result. Operation success, caller action, provider rejection, and operation errors are reported inside that envelope.
| Type | Nullability | Ownership |
|---|---|---|
gln_status_t | value | value |
Parameters
| Name | Direction | Type | Nullability | Ownership |
|---|---|---|---|---|
in_backend | input | gln_backend_t* | nonnull | borrowed |
in_request | input | const gln_submit_instant_transfer_request_t* | nonnull | borrowed |
out_result | output | gln_backend_result_t** | nonnull | transferred_out |
Success Result
Successful operation envelopes have outcome GLN_BACKEND_OUTCOME_SUCCESS, status GLN_OK, and kind GLN_BACKEND_RESULT_KIND_TRANSFER_SUBMISSION.
Borrow the typed success view with gln_get_backend_result_transfer_submission.
Use gln_get_backend_result_transfer_submission only when the envelope outcome is GLN_BACKEND_OUTCOME_SUCCESS and the kind is GLN_BACKEND_RESULT_KIND_TRANSFER_SUBMISSION.
Action-required envelopes carry interrupt details and a continuation instead of this typed success view. TAN and decoupled continuations can be resumed to produce a later success envelope; unsupported VoP confirmation resume paths return the envelope described under Outcomes.
Instant-transfer success submissions use the FinTS transfer submission shape: status and optional VoP fields are available, gln_get_transfer_submission_id returns NULL, and no provider-status rows are exposed.
Outcomes
GLN_BACKEND_OUTCOME_SUCCESS: read theGLN_BACKEND_RESULT_KIND_TRANSFER_SUBMISSIONtyped view.GLN_BACKEND_OUTCOME_ACTION_REQUIRED: FinTS instant-transfer flows can require caller action, usually a TAN, decoupled step, or VoP confirmation. TAN and decoupled continuations follow the normal resume path; unsupported VoP confirmation resume paths return an envelope fromgln_resume_continuationwith statusGLN_ERR_NOT_SUPPORTEDand issue typeunsupported_vop_confirmation_backend. Inspectgln_get_backend_result_interrupt_info. For TAN and decoupled action requirements, take the continuation withgln_take_backend_result_continuationand resume withgln_resume_continuation.GLN_BACKEND_OUTCOME_REJECTED: inspectgln_get_backend_result_statusandgln_get_backend_result_errorfor FinTS rejection details.GLN_BACKEND_OUTCOME_ERROR: inspectgln_get_backend_result_statusandgln_get_backend_result_error. Other backends use this outcome with statusGLN_ERR_NOT_SUPPORTED.
Ownership And Lifetime
The envelope returned through out_result is caller-owned and must be released with gln_destroy_backend_result.
Typed views, result rows or fields, borrowed strings, and the JSON string are borrowed from the envelope. They become invalid when the envelope is destroyed. Copy strings or row data before destroying the envelope when the caller needs to keep them.
For action-required envelopes, gln_get_backend_result_interrupt_info returns borrowed interrupt details. gln_take_backend_result_continuation transfers continuation ownership to the caller; destroy that continuation with gln_destroy_continuation after it has been saved or resumed.
Related Topics
See Also
gln_submit_transfergln_get_backend_result_outcomegln_get_backend_result_statusgln_get_backend_result_kindgln_get_backend_result_transfer_submissiongln_get_transfer_submission_statusgln_get_transfer_submission_vop_idgln_get_backend_result_interrupt_infogln_take_backend_result_continuationgln_resume_continuationgln_get_backend_result_errorgln_destroy_backend_resultgln_check_backend_operation_support- ABI function index