moip2 1.0.0 → 1.1.0

data/examples/ecommerce/payment-with-hash.rb

@@ -0,0 +1,101 @@
+# Tip: This setup section generally goes in other files,
+# and you access them in your controllers as globals,
+# instead of reinstantiating them every time.
+gem "moip2"
+
+auth = Moip2::Auth::Basic.new("TOKEN", "SECRET")
+
+client = Moip2::Client.new(:sandbox, auth)
+
+api = Moip2::Api.new(client)
+
+# If you want to persist your customer data and save later, now is
+# the time to create it.
+# TIP: Don't forget to generate your `own_id` or use one you already have
+
+customer = api.customer.create(
+  ownId: "meu_cliente_id_#{SecureRandom.hex(10)}",
+  fullname: "Integração Moip",
+  email: "integracaomoip@moip.com.br",
+  taxDocument: {
+    type: "CPF",
+    number: "22222222222",
+  },
+  phone: {
+    countryCode: "55",
+    areaCode: "11",
+    number: "66778899",
+  },
+  shippingAddress: {
+    city: "Sao Paulo",
+    complement: "8",
+    district: "Itaim",
+    street: "Avenida Faria Lima",
+    streetNumber: "2927",
+    zipCode: "01234000",
+    state: "SP",
+    country: "BRA",
+  },
+)
+
+# TIP: Now you can access the Moip ID to save it to your database, if you want
+# Ex.:
+# Customer.find_by(id: 123).update!(moip_id: customer.id)
+
+# Here we build the order data. You'll get the data from your database
+# given your controller input, but here we simplify things with a hardcoded
+# example
+
+order = api.order.create(
+  own_id: "meu_id_de_order_#{SecureRandom.hex(10)}",
+  items: [
+    {
+      product: "Nome do produto",
+      quantity: 1,
+      detail: "Mais info...",
+      price: 1000,
+    },
+  ],
+  customer: {
+    id: customer.id,
+  },
+)
+
+# Now with the order ID in hands, you can start creating payments
+# It is common to use the `hash` method if you are using client-side
+# encryption for card data.
+payment = api.payment.create(order.id,
+  installment_count: 1,
+  funding_instrument: {
+    method: "CREDIT_CARD",
+    credit_card: {
+      # You can generate the following hash using a Moip Javascript SDK
+      # where you use the customer credit_card data and your public key
+      # to create the hash.
+      # Read more about creating credit card hash here:
+      # https://github.com/moip/moip-sdk-js
+      hash: "your-hash",
+      holder: {
+        fullname: "Integração Moip",
+        birthdate: "1988-12-30",
+        taxDocument: {
+          type: "CPF",
+          number: "33333333333",
+        },
+        phone: {
+          countryCode: "55",
+          areaCode: "11",
+          number: "000000000",
+        },
+      },
+    },
+  })
+
+# Or a partial payment refunds, where the second parameter is
+# the value of the refunds:
+partial_payment_refund = api.refund.create(payment.id, amount: 2000)
+
+# TIP: To get your application synchronized to Moip's platform,
+# you should have a route that handles Webhooks.
+# For further information on the possible webhooks, please refer to the official docs
+# (https://dev.moip.com.br/v2.0/reference#lista-de-webhooks-disponíveis)

data/examples/marketplace/create-classical-account-company.rb

@@ -0,0 +1,74 @@
+# Here is an example of creating an Moip account using the Moip account API
+
+auth = Moip2::Auth::OAuth.new("oauth")
+
+client = Moip2::Client.new(:sandbox, auth)
+
+api = Moip2::Api.new(client)
+
+# Check if account exists
+api.accounts.exists?("978.443.610-85")
+
+# Create account
+
+account = api.accounts.create(
+  email: {
+    address: "dev.moip@labs.moip.com.br",
+  },
+  person: {
+    name: "Joaquim José",
+    lastName: "Silva Silva",
+    taxDocument: {
+      type: "CPF",
+      number: "978.443.610-85",
+    },
+    identityDocument: {
+      type: "RG",
+      number: "35.868.057-8",
+      issuer: "SSP",
+      issueDate: "2000-12-12",
+    },
+    birthDate: "1990-01-01",
+    phone: {
+      countryCode: "55",
+      areaCode: "11",
+      number: "965213244",
+    },
+    address: {
+      street: "Av. Brigadeiro Faria Lima",
+      streetNumber: "2927",
+      district: "Itaim",
+      zipCode: "01234-000",
+      city: "S\u00E3o Paulo",
+      state: "SP",
+      country: "BRA",
+    },
+  },
+  company: {
+    name: "Company Test",
+    businessName: "Razão Social Test",
+    address: {
+      street: "Av. Brigadeiro Faria Lima",
+      streetNumber: "4530",
+      district: "Itaim",
+      city: "São Paulo",
+      state: "SP",
+      country: "BRA",
+      zipCode: "01234000",
+    },
+    mainActivity: {
+      cnae: "82.91-1/00",
+      description: "Atividades de cobranças e informações cadastrais",
+    },
+    taxDocument: {
+      type: "CNPJ",
+      number: "61.148.461/0001-09",
+    },
+    phone: {
+      countryCode: "55",
+      areaCode: "11",
+      number: "975142244",
+    },
+  },
+  type: "MERCHANT",
+)

data/examples/marketplace/create-classical-account-without-company.rb

@@ -0,0 +1,47 @@
+# Here is an example of creating an Moip account using the Moip account API
+
+auth = Moip2::Auth::OAuth.new("oauth")
+
+client = Moip2::Client.new(:sandbox, auth)
+
+api = Moip2::Api.new(client)
+
+# Check if account exists
+api.accounts.exists?("978.443.610-85")
+
+# Create account
+account = api.accounts.create(
+  email: {
+    address: "dev.moip@labs.moip.com.br",
+  },
+  person: {
+    name: "Joaquim José",
+    lastName: "Silva Silva",
+    taxDocument: {
+      type: "CPF",
+      number: "978.443.610-85",
+    },
+    identityDocument: {
+      type: "RG",
+      number: "35.868.057-8",
+      issuer: "SSP",
+      issueDate: "2000-12-12",
+    },
+    birthDate: "1990-01-01",
+    phone: {
+      countryCode: "55",
+      areaCode: "11",
+      number: "965213244",
+    },
+    address: {
+      street: "Av. Brigadeiro Faria Lima",
+      streetNumber: "2927",
+      district: "Itaim",
+      zipCode: "01234-000",
+      city: "S\u00E3o Paulo",
+      state: "SP",
+      country: "BRA",
+    },
+  },
+  type: "MERCHANT",
+)

data/examples/marketplace/moip-connect.rb

@@ -0,0 +1,31 @@
+# We are going to create an oauth access token.
+# In order to create an oauth acess token, you must create an application on Moip.
+# Click on this link to go to Moip's dev docs and create your app:
+# https://dev.moip.com.br/v2.0/reference#criar-um-app
+
+gem "moip2"
+
+auth = Moip2::Auth::OAuth.new("oauth")
+
+client = Moip2::Client.new(:sandbox, auth)
+
+api = Moip2::Api.new(client)
+
+# Now you must require permission access:
+api.connect.authorize_url("APP-DVLBF0ANBO1S", "https://meusite.com", "RECEIVE_FUNDS, REFUND")
+# Read more here: https://dev.moip.com.br/v2.0/reference#solicitar-permissao
+
+# Once the seller has granted your required accesses, you use the code from
+# the response to generate the accessToken.
+
+# Generate acessToken:
+response = api.connect.authorize(
+  client_id: "your_id", # Ex.: APP-DVLBF0ANBO1S
+  client_secret: "your_secret",
+  code: "your_code",
+  redirect_uri: "https://meusite.com",
+  grant_type: "authorization_code",
+)
+
+# Get accessToken:
+response[:access_token]

data/examples/marketplace/payment-with-escrow.rb

@@ -0,0 +1,88 @@
+# Tip: This setup section generally goes in other files,
+# and you access them in your controllers as globals,
+# instead of reinstantiating them every time.
+gem "moip2"
+
+auth = Moip2::Auth::Basic.new("TOKEN", "SECRET")
+
+client = Moip2::Client.new(:sandbox, auth)
+
+api = Moip2::Api.new(client)
+
+# Here we build the order data. You'll get the data from your database
+# given your controller input, but here we simplify things with a hardcoded
+# example
+
+order = api.order.create(
+  own_id: "meu_id_de_order_#{SecureRandom.hex(10)}",
+  items: [
+    {
+      product: "Nome do produto",
+      quantity: 1,
+      detail: "Mais info...",
+      price: 1000,
+    },
+  ],
+  customer: {
+    ownId: "meu_cliente_id_#{SecureRandom.hex(10)}",
+    fullname: "Integração Moip",
+    email: "integracaomoip@moip.com.br",
+    taxDocument: {
+      type: "CPF",
+      number: "22222222222",
+    },
+    phone: {
+      countryCode: "55",
+      areaCode: "11",
+      number: "66778899",
+    },
+    shippingAddress: {
+      city: "Sao Paulo",
+      complement: "8",
+      district: "Itaim",
+      street: "Avenida Faria Lima",
+      streetNumber: "2927",
+      zipCode: "01234000",
+      state: "SP",
+      country: "BRA",
+    },
+  },
+)
+
+payment = api.payment.create(order.id,
+  installment_count: 1,
+  escrow: {
+    description: "Teste escrow",
+  },
+  funding_instrument: {
+    method: "CREDIT_CARD",
+    credit_card: {
+      # You can generate the following hash using a Moip Javascript SDK
+      # where you use the customer credit_card data and your public key
+      # to create the hash.
+      # Read more about creating credit card hash here:
+      # https://dev.moip.com.br/v2.0/docs/criptografia-de-cartao
+      hash: "kJHoKZ2bIVFjEFPSQQxbpXL6t5VCMoGTB4eJ4GLHmUz8f8Ny/LSL20yqbn+bZQymydVJyo3lL2DMT0dsWMzimYILQH4vAF24VwM0hKxX7nVwqGpGCXwBwSJGCwR57lqDiI4RVhKTVJpu7FySfu+Hm9JWSk4fzPXQO/FRqIS5TJQWJSywjLmGwyYtTGsmHTSCwvPFg+0GcG/EkYjPesMc/ycxPixibrEId9Wz03QnLsHYzSBCnPqg8xq8WKYDX2x3dHV3GNsB4TEfVz4psynddDEpX/VhIk2e8cXQ0EoXKkWdJEJB4KFmqj39OhNevCBkF5ADvzFp73J0IxnjOf1AQA==",
+      holder: {
+        fullname: "Integração Moip",
+        birthdate: "1988-12-30",
+        taxDocument: {
+          type: "CPF",
+          number: "33333333333",
+        },
+        phone: {
+          countryCode: "55",
+          areaCode: "11",
+          number: "000000000",
+        },
+      },
+    },
+  })
+
+# You can create a full payment refunds:
+full_payment_refund = api.refund.create(payment.id)
+
+# TIP: To get your application synchronized to Moip's platform,
+# you should have a route that handles Webhooks.
+# For further information on the possible webhooks, please refer to the official docs
+# (https://dev.moip.com.br/v2.0/reference#lista-de-webhooks-disponíveis)

data/examples/marketplace/payment-with-pre-authorization.rb

@@ -0,0 +1,87 @@
+# Tip: This setup section generally goes in other files,
+# and you access them in your controllers as globals,
+# instead of reinstantiating them every time.
+gem "moip2"
+
+auth = Moip2::Auth::Basic.new("TOKEN", "SECRET")
+
+client = Moip2::Client.new(:sandbox, auth)
+
+api = Moip2::Api.new(client)
+
+# Here we build the order data. You'll get the data from your database
+# given your controller input, but here we simplify things with a hardcoded
+# example
+
+order = api.order.create(
+  own_id: "meu_id_de_order_#{SecureRandom.hex(10)}",
+  items: [
+    {
+      product: "Nome do produto",
+      quantity: 1,
+      detail: "Mais info...",
+      price: 1000,
+    },
+  ],
+  customer: {
+    ownId: "meu_cliente_id_#{SecureRandom.hex(10)}",
+    fullname: "Integração Moip",
+    email: "integracaomoip@moip.com.br",
+    taxDocument: {
+      type: "CPF",
+      number: "22222222222",
+    },
+    phone: {
+      countryCode: "55",
+      areaCode: "11",
+      number: "66778899",
+    },
+    shippingAddress: {
+      city: "Sao Paulo",
+      complement: "8",
+      district: "Itaim",
+      street: "Avenida Faria Lima",
+      streetNumber: "2927",
+      zipCode: "01234000",
+      state: "SP",
+      country: "BRA",
+    },
+  },
+)
+
+# Create pre authorized payment
+payment = api.payment.create(order.id,
+  installment_count: 1,
+  delayCapture: true,
+  funding_instrument: {
+    method: "CREDIT_CARD",
+    credit_card: {
+      # You can generate the following hash using a Moip Javascript SDK
+      # where you use the customer credit_card data and your public key
+      # to create the hash.
+      # Read more about creating credit card hash here:
+      # https://dev.moip.com.br/v2.0/docs/criptografia-de-cartao
+      hash: "kJHoKZ2bIVFjEFPSQQxbpXL6t5VCMoGTB4eJ4GLHmUz8f8Ny/LSL20yqbn+bZQymydVJyo3lL2DMT0dsWMzimYILQH4vAF24VwM0hKxX7nVwqGpGCXwBwSJGCwR57lqDiI4RVhKTVJpu7FySfu+Hm9JWSk4fzPXQO/FRqIS5TJQWJSywjLmGwyYtTGsmHTSCwvPFg+0GcG/EkYjPesMc/ycxPixibrEId9Wz03QnLsHYzSBCnPqg8xq8WKYDX2x3dHV3GNsB4TEfVz4psynddDEpX/VhIk2e8cXQ0EoXKkWdJEJB4KFmqj39OhNevCBkF5ADvzFp73J0IxnjOf1AQA==",
+      holder: {
+        fullname: "Integração Moip",
+        birthdate: "1988-12-30",
+        taxDocument: {
+          type: "CPF",
+          number: "33333333333",
+        },
+        phone: {
+          countryCode: "55",
+          areaCode: "11",
+          number: "000000000",
+        },
+      },
+    },
+  })
+
+# Capture pre authorized payment
+api.payment.catpure(payment.id)
+
+# TIP: To get your application synchronized to Moip's platform,
+# you should have a route that handles Webhooks.
+# For further information on the possible webhooks, please refer to the official docs
+# (https://dev.moip.com.br/v2.0/reference#lista-de-webhooks-disponíveis)

data/examples/marketplace/shared-cart.rb

@@ -0,0 +1,220 @@
+# Tip: This setup section generally goes in other files,
+# and you access them in your controllers as globals,
+# instead of reinstantiating them every time.
+gem "moip2"
+
+auth = Moip2::Auth::OAuth.new("oauth")
+
+client = Moip2::Client.new(:sandbox, auth)
+
+api = Moip2::Api.new(client)
+
+# Here we build the multi order data. You'll get the data from your database
+# given your controller input, but here we simplify things with a hardcoded
+# example.
+
+# In this example, we create a multi order with two orders for two different
+# sellers and two different customers, where the first order of the multi order,
+# the seller is the primary receiver, and the second one, the seller is the
+# secondary receiver.
+
+multi_order = api.multi_order.create(
+  own_id: "meu_id_de_multi_order_#{SecureRandom.hex(10)}",
+  orders: [
+    {
+      own_id: "meu_id_de_order_#{SecureRandom.hex(10)}",
+      items: [
+        {
+          product: "Produto 1",
+          quantity: 1,
+          detail: "Mais info...",
+          price: 3000,
+        },
+      ],
+      customer: {
+        ownId: "id_do_cliente1_#{SecureRandom.hex(10)}",
+        fullname: "Joao Sousa",
+        email: "joao.sousa@email.com",
+        birthDate: "1988-12-30",
+        taxDocument: {
+          type: "CPF",
+          number: "22222222222",
+        },
+        phone: {
+          countryCode: "55",
+          areaCode: "11",
+          number: "66778899",
+        },
+        shippingAddress:  {
+          street: "Avenida Faria Lima",
+          streetNumber: 2927,
+          complement: 8,
+          district: "Itaim",
+          city: "Sao Paulo",
+          state: "SP",
+          country: "BRA",
+          zipCode: "01234000",
+        },
+      },
+      receivers: [
+        {
+          moipAccount: {
+            id:  "MPA-D63A62C73A92",
+          },
+          type: "PRIMARY",
+        },
+      ],
+    },
+    {
+      own_id: "meu_segundo_id_de_order_#{SecureRandom.hex(10)}",
+      items: [
+        {
+          product: "Produto 2",
+          quantity: 1,
+          detail: "Mais info...",
+          price: 2600,
+        },
+      ],
+      customer: {
+        ownId: "id_do_cliente2_#{SecureRandom.hex(10)}",
+        fullname: "Joao Sousa",
+        email: "joao.sousa@email.com",
+        birthDate: "1988-12-30",
+        taxDocument: {
+          type: "CPF",
+          number: "22222222222",
+        },
+        phone: {
+          countryCode: "55",
+          areaCode: "11",
+          number: "66778899",
+        },
+        shippingAddress:  {
+          street: "Avenida Faria Lima",
+          streetNumber: 2927,
+          complement: 8,
+          district: "Itaim",
+          city: "Sao Paulo",
+          state: "SP",
+          country: "BRA",
+          zipCode: "01234000",
+        },
+      },
+      receivers: [
+        {
+          moipAccount: {
+            id: "MPA-D63A62C73A92",
+          },
+          type: "PRIMARY",
+        },
+        {
+          moipAccount: {
+            id: "MPA-HBKKXIFCY1N3",
+          },
+          type: "SECONDARY",
+          amount: {
+            fixed: 55,
+          },
+        },
+      ],
+    },
+    {
+      own_id: "meu_terceiro_id_de_order_#{SecureRandom.hex(10)}",
+      items: [
+        {
+          product: "Produto 3",
+          quantity: 2,
+          detail: "Mais info...",
+          price: 4000,
+        },
+      ],
+      customer: {
+        ownId: "id_do_cliente3_#{SecureRandom.hex(10)}",
+        fullname: "Joao Sousa",
+        email: "joao.sousa@email.com",
+        birthDate: "1988-12-30",
+        taxDocument: {
+          type: "CPF",
+          number: "22222222222",
+        },
+        phone: {
+          countryCode: "55",
+          areaCode: "11",
+          number: "66778899",
+        },
+        shippingAddress:  {
+          street: "Avenida Faria Lima",
+          streetNumber: 2927,
+          complement: 8,
+          district: "Itaim",
+          city: "Sao Paulo",
+          state: "SP",
+          country: "BRA",
+          zipCode: "01234000",
+        },
+      },
+      receivers: [
+        {
+          moipAccount: {
+            id:  "MPA-D63A62C73A92",
+          },
+          type: "PRIMARY",
+        },
+        {
+          moipAccount: {
+            id: "MPA-HBKKXIFCY1N3",
+          },
+          type: "SECONDARY",
+          amount: {
+            percentual: 40,
+          },
+        },
+      ],
+    },
+  ],
+)
+
+# Now with the order ID in hands, you can start creating payments
+# It is common to use the `hash` method if you are using client-side
+# encryption for card data.
+multi_payment = api.multi_payment.create(
+  multi_order.id,
+  funding_instrument: {
+    method: "BOLETO",
+    boleto: {
+      expirationDate: "2020-01-01",
+      instructionLines: {
+        first: "First line of instructions",
+        second: "Second line of instructions",
+        third: "Third line of instructions",
+      },
+    },
+  },
+)
+
+# This is how you can create a boleto refund to a bank account:
+payment_refund = api.refund.create(
+  payment.id, refundingInstrument: {
+    method: "BANK_ACCOUNT",
+    bankAccount: {
+      bankNumber: "237",
+      agencyNumber: "12345",
+      agencyCheckNumber: "0",
+      accountNumber: "12345678",
+      accountCheckNumber: "7",
+      type: "CHECKING",
+      holder: {
+        taxDocument: {
+          type: "CPF",
+          number: "22222222222",
+        },
+        fullname: "Demo Moip",
+      },
+    },
+  }
+)
+
+# TIP: To get your application synchronized to Moip's platform,
+# you should have a route that handles Webhooks.
+# For further information on the possible webhooks, please refer to the official docs
+# (https://dev.moip.com.br/v2.0/reference#lista-de-webhooks-disponíveis)

data/lib/moip2/api.rb

@@ -14,6 +14,14 @@ module Moip2
       Moip2::PaymentApi.new(client)
     end
 
+    def balances
+      Moip2::BalancesApi.new(client)
+    end
+
+    def entries
+      Moip2::EntryApi.new(client)
+    end
+
     def invoice
       Moip2::InvoiceApi.new client
     end
@@ -42,9 +50,16 @@ module Moip2
       Moip2::AccountsApi.new(client)
     end
 
+    def bank_accounts
+      Moip2::BankAccountsApi.new(client)
+    end
+
+    def webhooks
+      Moip2::WebhooksApi.new(client)
+    end
+
     def connect
-      host = Moip2::ConnectApi.host(client.env)
-      connect_client = Client.new(client.env, client.auth, host, client.opts)
+      connect_client = Moip2::ConnectClient.new(client.env, client.auth, client.opts)
       Moip2::ConnectApi.new(connect_client)
     end
 

data/lib/moip2/balances_api.rb

@@ -0,0 +1,18 @@
+module Moip2
+  class BalancesApi
+    attr_reader :client
+
+    def initialize(client)
+      client.opts[:headers]["Accept"] = "application/json;version=2.1"
+      @client = client
+    end
+
+    def base_path
+      "/v2/balances"
+    end
+
+    def show
+      Resource::Balances.new(client, client.get(base_path))
+    end
+  end
+end