mangopay

v0.1.0

mangopay v0.1.0 MangoPay.BankAccount

Functions for MangoPay bank account API.

Link to this section Summary

Functions

all_by_user(id, query \\ %{})

List all bank account for a user

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

List all bank account for a user

create_ca(id, params)

Create a CA bank account

create_ca!(id, params)

Create a CA bank account

create_gb(id, params)

Create a GB bank account

create_gb!(id, params)

Create a GB bank account

create_iban(user_id, params)

Create a iban bank account

create_iban!(user_id, params)

Create a iban bank account

create_other(id, params)

Create an other type of bank account

create_other!(id, params)

Create an other type of bank account

create_us(id, params)

Create a US bank account

create_us!(id, params)

Create a US bank account

deactivate(user_id, bank_account_id, params)

Deactivate a bank account of a user

deactivate!(user_id, bank_account_id, params)

Deactivate a bank account of a user

get_by_user(user_id, bank_account_id)

Get a bank account of a user

get_by_user!(user_id, bank_account_id)

Get a bank account of a user

path()

Get path called

path(id)

Get path called

Link to this section Functions

Link to this function all_by_user(id, query \\ %{})

List all bank account for a user.

Examples 

{:ok, bank_accounts} = MangoPay.BankAccount.all_by_user("user_id")
Link to this function all_by_user!(id, query \\ %{})

List all bank account for a user.

Examples 

bank_accounts = MangoPay.BankAccount.all_by_user!("user_id")
Link to this function create_ca(id, params)

Create a CA bank account.

Examples 

params              = %{
  "Tag": "custom meta",
  "OwnerAddress": %{
    "AddressLine1": "1 Mangopay Street",
    "AddressLine2": "The Loop",
    "City": "Paris",
    "Region": "Ile de France",
    "PostalCode": "75001",
    "Country": "FR"
  },
  "OwnerName": "Joe Blogs",
  "BranchCode": "00152",
  "InstitutionNumber": "614",
  "AccountNumber": "11696419",
  "BankName": "The Big Bank"
}
{:ok, bank_account} = MangoPay.BankAccount.create_ca("user_id", params)
Link to this function create_ca!(id, params)

Create a CA bank account.

Examples 

params              = %{
  "Tag": "custom meta",
  "OwnerAddress": %{
    "AddressLine1": "1 Mangopay Street",
    "AddressLine2": "The Loop",
    "City": "Paris",
    "Region": "Ile de France",
    "PostalCode": "75001",
    "Country": "FR"
  },
  "OwnerName": "Joe Blogs",
  "BranchCode": "00152",
  "InstitutionNumber": "614",
  "AccountNumber": "11696419",
  "BankName": "The Big Bank"
}
bank_account = MangoPay.BankAccount.create_ca!("user_id", params)
Link to this function create_gb(id, params)

Create a GB bank account.

Examples 

params              = %{
  "Tag": "custom meta",
  "OwnerAddress": %{
    "AddressLine1": "1 Mangopay Street",
    "AddressLine2": "The Loop",
    "City": "Paris",
    "Region": "Ile de France",
    "PostalCode": "75001",
    "Country": "FR"
  },
  "OwnerName": "Joe Blogs",
  "SortCode": "010039",
  "AccountNumber": "11696419"
}
{:ok, bank_account} = MangoPay.BankAccount.create_gb("user_id", params)
Link to this function create_gb!(id, params)

Create a GB bank account.

Examples 

params              = %{
  "Tag": "custom meta",
  "OwnerAddress": %{
    "AddressLine1": "1 Mangopay Street",
    "AddressLine2": "The Loop",
    "City": "Paris",
    "Region": "Ile de France",
    "PostalCode": "75001",
    "Country": "FR"
  },
  "OwnerName": "Joe Blogs",
  "SortCode": "010039",
  "AccountNumber": "11696419"
}
bank_account = MangoPay.BankAccount.create_gb!("user_id", params)
Link to this function create_iban(user_id, params)

Create a iban bank account.

Examples 

params              = %{
  "Tag": "custom meta",
  "OwnerAddress": %{
    "AddressLine1": "1 Mangopay Street",
    "AddressLine2": "The Loop",
    "City": "Paris",
    "Region": "Ile de France",
    "PostalCode": "75001",
    "Country": "FR"
  },
  "OwnerName": "Joe Blogs",
  "IBAN": "FR7630004000031234567890143",
  "BIC": "CRLYFRPP"
}
{:ok, bank_account} = MangoPay.BankAccount.create_iban("user_id", params)
Link to this function create_iban!(user_id, params)

Create a iban bank account.

Examples 

params              = %{
  "Tag": "custom meta",
  "OwnerAddress": %{
    "AddressLine1": "1 Mangopay Street",
    "AddressLine2": "The Loop",
    "City": "Paris",
    "Region": "Ile de France",
    "PostalCode": "75001",
    "Country": "FR"
  },
  "OwnerName": "Joe Blogs",
  "IBAN": "FR7630004000031234567890143",
  "BIC": "CRLYFRPP"
}
bank_account = MangoPay.BankAccount.create_iban!("user_id", params)
Link to this function create_other(id, params)

Create an other type of bank account.

Examples 

params              = %{
  "Tag": "custom meta",
  "OwnerAddress": %{
    "AddressLine1": "1 Mangopay Street",
    "AddressLine2": "The Loop",
    "City": "Paris",
    "Region": "Ile de France",
    "PostalCode": "75001",
    "Country": "FR"
  },
  "OwnerName": "Joe Blogs",
  "Country": "FR",
  "BIC": "CRLYFRPP",
  "AccountNumber": "11696419"
}
{:ok, bank_account} = MangoPay.BankAccount.create_other("user_id", params)
Link to this function create_other!(id, params)

Create an other type of bank account.

Examples 

params              = %{
  "Tag": "custom meta",
  "OwnerAddress": %{
    "AddressLine1": "1 Mangopay Street",
    "AddressLine2": "The Loop",
    "City": "Paris",
    "Region": "Ile de France",
    "PostalCode": "75001",
    "Country": "FR"
  },
  "OwnerName": "Joe Blogs",
  "Country": "FR",
  "BIC": "CRLYFRPP",
  "AccountNumber": "11696419"
}
bank_account = MangoPay.BankAccount.create_other!("user_id", params)
Link to this function create_us(id, params)

Create a US bank account.

Examples 

params              = %{
  "Tag": "custom meta",
  "OwnerAddress": %{
    "AddressLine1": "1 Mangopay Street",
    "AddressLine2": "The Loop",
    "City": "Paris",
    "Region": "Ile de France",
    "PostalCode": "75001",
    "Country": "FR"
  },
  "OwnerName": "Joe Blogs",
  "AccountNumber": "11696419",
  "ABA": "071000288",
  "DepositAccountType": "CHECKING"
}
{:ok, bank_account} = MangoPay.BankAccount.create_us("user_id", params)
Link to this function create_us!(id, params)

Create a US bank account.

Examples 

params              = %{
  "Tag": "custom meta",
  "OwnerAddress": %{
    "AddressLine1": "1 Mangopay Street",
    "AddressLine2": "The Loop",
    "City": "Paris",
    "Region": "Ile de France",
    "PostalCode": "75001",
    "Country": "FR"
  },
  "OwnerName": "Joe Blogs",
  "AccountNumber": "11696419",
  "ABA": "071000288",
  "DepositAccountType": "CHECKING"
}
bank_account = MangoPay.BankAccount.create_us!("user_id", params)
Link to this function deactivate(user_id, bank_account_id, params)

Deactivate a bank account of a user.

Examples 

params              = %{
  "Active": false
}
{:ok, bank_account} = MangoPay.BankAccount.deactivate("user_id", "bank_account", params)
Link to this function deactivate!(user_id, bank_account_id, params)

Deactivate a bank account of a user.

Examples 

params              = %{
  "Active": false
}
{:ok, bank_account} = MangoPay.BankAccount.deactivate("user_id", "bank_account", params)
Link to this function get_by_user(user_id, bank_account_id)

Get a bank account of a user.

Examples 

{:ok, client} = MangoPay.BankAccount.get_by_user("user_id")
Link to this function get_by_user!(user_id, bank_account_id)

Get a bank account of a user.

Examples 

client = MangoPay.BankAccount.get_by_user!("user_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)