View Source Finix.Authorizations (Finix v0.1.2)

Authorizations

An Authorization (also known as a card hold) reserves a specific amount on a card to be captured (i.e. debited) at a later date, usually within seven days.

When an Authorization is captured it produces a Transfer resource.

Summary

Functions

Use a PUT request to capture an Authorization. If captured successfully, the transfer field of the Authorization will contain the ID of the Transfer resource that moves funds.

Create an Authorization to process a transaction.

Retrieve the details of a previously created Authorization.

Use a PUT request to void an Authorization. If voided successfully, funds get released and the transaction stops from completing. Additionally, voided Authorization can no longer be captured.

Functions

Link to this function

capture(authorization_id, body, client_opts \\ %{})

View Source

Use a PUT request to capture an Authorization. If captured successfully, the transfer field of the Authorization will contain the ID of the Transfer resource that moves funds.

Link to this function

create(body, client_opts \\ %{})

View Source

Create an Authorization to process a transaction.

Link to this function

fetch(authorization_id, client_opts \\ %{})

View Source

Retrieve the details of a previously created Authorization.

Link to this function

void(authorization_id, client_opts \\ %{})

View Source

Use a PUT request to void an Authorization. If voided successfully, funds get released and the transaction stops from completing. Additionally, voided Authorization can no longer be captured.