dwolla v1.0.1

View Source Dwolla.Document (dwolla v1.0.1)

Functions for documents endpoint.

Link to this section Summary

Types

error()
id()
location()
t()
token()

Functions

create(token, customer_id, document_type, file)

Upload a document for a customer.

get(token, id)

Get a document.

list(token, customer_id)

List a customer's documents.

Link to this section Types

Link to this type

error()

View Source

Specs

error() :: HTTPoison.Error.t() | Dwolla.Errors.t() | tuple()
Link to this type

id()

View Source

Specs

id() :: String.t()
Link to this type

location()

View Source

Specs

location() :: %{id: String.t()}
Link to this type

t()

View Source

Specs

t() :: %Dwolla.Document{
  created: String.t(),
  failure_reason: String.t(),
  id: String.t(),
  status: String.t(),
  type: String.t()
}
Link to this type

token()

View Source

Specs

token() :: String.t()

Link to this section Functions

Link to this function

create(token, customer_id, document_type, file)

View Source

Specs

create(token(), id(), String.t(), String.t()) ::
  {:ok, location()} | {:error, error()}

Upload a document for a customer.

Accepted document type values:

  • passport
  • license
  • idCard
  • other
Link to this function

get(token, id)

View Source

Specs

get(token(), id()) :: {:ok, t()} | {:error, error()}

Get a document.

Link to this function

list(token, customer_id)

View Source

Specs

list(token(), id()) :: {:ok, [t()]} | {:error, error()}

List a customer's documents.