mangopay

v0.1.0

mangopay v0.1.0 MangoPay.KycDocument

Functions for MangoPay kyc document.

Link to this section Summary

Functions

all(query \\ %{})

List all kyc_documents

all!(query \\ %{})

List all kyc documents

all_by_user(user_id, query \\ %{})

All kyc documents for a user

all_by_user!(user_id, query \\ %{})

All kyc documents for a user

create(user_id, params)

Create a kyc document for a user

create!(user_id, params)

Create a kyc document for a user

create_page(user_id, kyc_document_id, params)

Create a page for a kyc document and user

create_page!(user_id, kyc_document_id, params)

Create a page for a kyc document and user

get(id)

Get a kyc document

get!(id)

Get a kyc document

path()

Get path called

path(id)

Get path called

submit(user_id, kyc_document_id, params)

Submit a kyc document for a user and kyc document

submit!(user_id, kyc_document_id, params)

Submit a kyc document for a user and kyc document

Link to this section Functions

Link to this function all(query \\ %{})

List all kyc_documents.

Examples 

query                = %{
                         "Page": 1,
                         "Per_Page": 25,
                         "Sort": "CreationDate:DESC",
                         "BeforeDate": 1463440221,
                         "AfterDate": 1431817821,
                         "Status": "CREATED, SUCCEEDED",
                         "Type": "IDENTITY_PROOF,ADDRESS_PROOF"
}
{:ok, kyc_documents} = MangoPay.KycDocuments.all(query)
Link to this function all!(query \\ %{})

List all kyc documents.

Examples 

query         = %{
                  "Page": 1,
                  "Per_Page": 25,
                  "Sort": "CreationDate:DESC",
                  "BeforeDate": 1463440221,
                  "AfterDate": 1431817821,
                  "Status": "CREATED, SUCCEEDED",
                  "Type": "IDENTITY_PROOF,ADDRESS_PROOF"
}
kyc_documents = MangoPay.KycDocuments.all!(query)
Link to this function all_by_user(user_id, query \\ %{})

All kyc documents for a user.

Examples 

user_id       = Id of a user object
query         = %{
                  "Page": 1,
                  "Per_Page": 25,
                  "Sort": "CreationDate:DESC",
                  "BeforeDate": 1463440221,
                  "AfterDate": 1431817821,
                  "Status": "CREATED, SUCCEEDED",
}
{:ok, kyc_documents} = MangoPay.KycDocument.all_by_user(user_id, query)
Link to this function all_by_user!(user_id, query \\ %{})

All kyc documents for a user.

Examples 

user_id       = Id of a user object
query         = %{
                  "Page": 1,
                  "Per_Page": 25,
                  "Sort": "CreationDate:DESC",
                  "BeforeDate": 1463440221,
                  "AfterDate": 1431817821,
                  "Status": "CREATED, SUCCEEDED",
}
kyc_documents = MangoPay.KycDocument.all_by_user!(user_id, query)
Link to this function create(user_id, params)

Create a kyc document for a user.

Examples 

user_id             = Id of a user object
params              = %{
  "Tag": "custom meta",
  "Type": "IDENTITY_PROOF"
}
{:ok, kyc_document} = MangoPay.KycDocument.create(user_id, params)
Link to this function create!(user_id, params)

Create a kyc document for a user.

Examples 

user_id      = Id of a user object
params       = %{
  "Tag": "custom meta",
  "Type": "IDENTITY_PROOF"
}
kyc_document = MangoPay.KycDocument.create!(user_id, params)
Link to this function create_page(user_id, kyc_document_id, params)

Create a page for a kyc document and user.

Examples 

user_id             = Id of a user object
kyc_document_id     = Id of a kyc document object
params              = %{
                        "Tag": "custom meta",
                        "Type": "IDENTITY_PROOF"
}
{:ok, kyc_document} = MangoPay.KycDocument.create_page(user_id, kyc_document_id, params)
Link to this function create_page!(user_id, kyc_document_id, params)

Create a page for a kyc document and user.

Examples 

params      = %{
  "Tag": "custom meta",
  "Type": "IDENTITY_PROOF"
}
kyc_document = MangoPay.KycDocument.create_page!("user_id", "kyc_document_id", params)
Link to this function get(id)

Get a kyc document.

Examples 

id                  = Id of a kyc document object
{:ok, kyc_document} = MangoPay.KycDocument.get(id)
Link to this function get!(id)

Get a kyc document.

Examples 

id           = Id of a kyc document object
kyc_document = MangoPay.KycDocument.get!(id)
Link to this function path()

Get path called.

Examples 

"/users" = MangoPay.User.path()
Link to this function path(id)

Get path called.

Examples 

"/users/id" = MangoPay.User.path(id)
Link to this function submit(user_id, kyc_document_id, params)

Submit a kyc document for a user and kyc document.

Examples 

user_id             = Id of a user object
params              = %{
  "Tag": "custom meta",
  "Status": "VALIDATION_ASKED"
}
{:ok, kyc_document} = MangoPay.KycDocument.submit(user_id, params)
Link to this function submit!(user_id, kyc_document_id, params)

Submit a kyc document for a user and kyc document.

Examples 

user_id             = Id of a user object
params      = %{
  "Tag": "custom meta",
  "Status": "VALIDATION_ASKED"
}
kyc_document = MangoPay.KycDocument.submit!("user_id", params)