Cielo.Transaction (Cielo v0.1.8) View Source

This module makes a transactions calls for credit, debit, bankslips and recurrent payments.

Cielo API reference:

Link to this section Summary

Functions

bankslip(params)

Create a bankslip transaction if passed attributes satisfy a validation criteria

cancel_payment(payment_id)

Cancel a card payment

cancel_payment(payment_id, amount)

Cancel a card payment

capture(payment_id)

Capture an uncaptured credit card transaction

capture(payment_id, params)

Capture an uncaptured credit card transaction with partial capture

credit(params)

Create a credit transaction if passed attributes satisfy a validation criteria

deactivate_recurrent_payment(recurrent_payment_id)

Deactivate a recurrent payment transaction

debit(params)

Create a debit transaction if passed attributes satisfy a validation criteria

recurrent(params)

(DEPRECATED) This function was moved to Cielo.Recurrency.create_payment/1

Link to this section Functions

bankslip(params)

Specs

bankslip(map()) :: {:ok, map()} | {:error, map(), list()} | {:error, any()}

Create a bankslip transaction if passed attributes satisfy a validation criteria

Successfull transaction

iex(1)> attrs = %{
  customer: %{
    address: %{
      city: "Rio de Janeiro",
      complement: "Sala 934",
      country: "BRA",
      district: "Centro",
      number: "160",
      state: "RJ",
      street: "Avenida Marechal Câmara",
      zip_code: "22750012"
    },
    identity: "1234567890",
    name: "Comprador Teste Boleto"
  },
  merchant_order_id: "2014111706",
  payment: %{
    address: "Rua Teste",
    amount: 15700,
    assignor: "Empresa Teste",
    boleto_number: "123",
    demonstrative: "Desmonstrative Teste",
    expiration_date: "2020-12-31",
    identification: "11884926754",
    instructions: "Aceitar somente até a data de vencimento, após essa data juros de 1% dia.",
    provider: "INCLUIR PROVIDER",
    type: "Boleto"
  }
}
iex(2)> Cielo.Transaction.bankslip(attrs)
{:ok,
  %{
    customer: %{
      address: %{
        city: "Rio de Janeiro",
        complement: "Sala 934",
        country: "BRA",
        district: "Centro",
        number: "160",
        state: "RJ",
        street: "Avenida Marechal Câmara",
        zip_code: "22750012"
      },
      identity: "1234567890",
      name: "Comprador Teste Boleto"
    },
    merchant_order_id: "2014111706",
    payment: %{
      address: "Rua Teste",
      amount: 15700,
      assignor: "Empresa Teste",
      bank: 0,
      bar_code_number: "00092848600000157009999250000000012399999990",
      boleto_number: "123-2",
      country: "BRA",
      currency: "BRL",
      demonstrative: "Desmonstrative Teste",
      digitable_line: "00099.99921 50000.000013 23999.999909 2 84860000015700",
      expiration_date: "2020-12-31",
      identification: "11884926754",
      instructions: "Aceitar somente até a data de vencimento, após essa data juros de 1% dia.",
      is_splitted: false,
      links: [
        %{
          href: "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/...",
          method: "GET",
          rel: "self"
        }
      ],
      payment_id: "8a946b9a-a9ab-4c16-bebb-0565d11b88f3",
      provider: "Simulado",
      received_date: "2020-10-18 18:18:29",
      status: 1,
      type: "Boleto",
      url: "https://transactionsandbox.pagador.com.br/post/pagador/reenvia.asp/..."
    }
  }}

Warning

Consult the provider list to check if your bank are integrated by cielo in this API

cancel_payment(payment_id)

Specs

cancel_payment(binary()) :: {:error, any()} | {:ok, map()}

Cancel a card payment

Successfull transaction

iex(1)> Cielo.Transaction.cancel_payment("26e5da86-d975-4e2f-aa25-862b5a43e9f4")
{:ok,
%{
  authorization_code: "693066",
  links: [
    %{
      href: "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}",
      method: "GET",
      rel: "self"
    }
  ],
  proof_of_sale: "4510712",
  return_code: "9",
  return_message: "Operation Successful",
  status: 10,
  tid: "0719094510712"
}}

cancel_payment(payment_id, amount)

Specs

cancel_payment(binary(), non_neg_integer()) :: {:error, any()} | {:ok, map()}

Cancel a card payment

Successfull transaction

iex(1)> Cielo.Transaction.cancel_payment("26e5da86-d975-4e2f-aa25-862b5a43e9f4", 1000)
{:ok,
%{
  authorization_code: "693066",
  links: [
    %{
      href: "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}",
      method: "GET",
      rel: "self"
    }
  ],
  proof_of_sale: "4510712",
  return_code: "0",
  return_message: "Operation Successful",
  status: 2,
  tid: "0719094510712"
}}

capture(payment_id)

Specs

capture(binary()) :: {:error, any()} | {:error, any(), any()} | {:ok, map()}

Capture an uncaptured credit card transaction

Successfull transaction

iex(1)> Cielo.Transaction.capture("26e5da86-d975-4e2f-aa25-862b5a43e9f4")
{:ok,
%{
  authorization_code: "214383",
  links: [
    %{
      href: "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/...",
      method: "GET",
      rel: "self"
    },
    %{
      href: "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/.../void",
      method: "PUT",
      rel: "void"
    }
  ],
  proof_of_sale: "793143",
  provider_return_code: "6",
  provider_return_message: "Operation Successful",
  reason_code: 0,
  reason_message: "Successful",
  return_code: "6",
  return_message: "Operation Successful",
  status: 2,
  tid: "1020082643193"
}}
iex(2)> Cielo.Transaction.capture("26e5da86-d975-4e2f-aa25-862b5a43e9f4")
{:error, :bad_request, [%{code: 308, message: "Transaction not available to capture"}]}

capture(payment_id, params)

Specs

capture(binary(), map()) ::
  {:error, any()} | {:error, any(), any()} | {:ok, map()}

Capture an uncaptured credit card transaction with partial capture

valid option amount

Successfull transaction

iex(1)> Cielo.Transaction.capture("26e5da86-d975-4e2f-aa25-862b5a43e9f4", %{amount: 5000})
{:ok,
%{
  authorization_code: "214383",
  links: [
    %{
      href: "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/...",
      method: "GET",
      rel: "self"
    },
    %{
      href: "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/.../void",
      method: "PUT",
      rel: "void"
    }
  ],
  proof_of_sale: "793143",
  provider_return_code: "6",
  provider_return_message: "Operation Successful",
  reason_code: 0,
  reason_message: "Successful",
  return_code: "6",
  return_message: "Operation Successful",
  status: 2,
  tid: "1020082643193"
}}
iex(2)> Cielo.Transaction.capture("26e5da86-d975-4e2f-aa25-862b5a43e9f4")
{:error, :bad_request, [%{code: 308, message: "Transaction not available to capture"}]}

credit(params)

Specs

credit(map()) :: {:ok, map()} | {:error, map(), list()} | {:error, any()}

Create a credit transaction if passed attributes satisfy a validation criteria

Successfull transaction

iex(1)> attrs = %{
  customer: %{name: "Comprador crédito simples"},
  merchant_order_id: "2014111703",
  payment: %{
    amount: 15700,
    credit_card: %{
      brand: "Visa",
      card_number: "1234123412341231",
      card_on_file: %{reason: "Unscheduled", usage: "Used"},
      expiration_date: "12/2030",
      holder: "Teste Holder",
      security_code: "123"
    },
    installments: 1,
    is_crypto_currency_negotiation: true,
    soft_descriptor: "123456789ABCD",
    type: "CreditCard"
  }
}
iex(2)> Cielo.Transaction.credit(attrs)
{:ok,
%{
  customer: %{name: "Comprador crédito simples"},
  merchant_order_id: "2014111703",
  payment: %{
    amount: 15700,
    authenticate: false,
    authorization_code: "437560",
    capture: false,
    country: "BRA",
    credit_card: ...
    links: [
      %{
        href: "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/...",
        method: "GET",
        rel: "self"
      },
      %{
        href: "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/.../capture",
        method: "PUT",
        rel: "capture"
      },
      %{
        href: "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/.../void",
        method: "PUT",
        rel: "void"
      }
    ],
    payment_id: "26e5da86-d975-4e2f-aa25-862b5a43e9f4",
    ...
    type: "CreditCard"
  }
}}

Failed transaction

iex(1)> attrs = %{
  customer: %{name: "Comprador crédito simples"},
  merchant_order_id: "2014111703",
  payment: %{
    amount: 15700,
    credit_card: %{
      brand: "Visa",
      card_number: "1234123412341231",
      card_on_file: %{reason: "Unscheduled", usage: "Used"},
      expiration_date: "12/2030",
      holder: "Teste Holder"
    },
    installments: 1,
    is_crypto_currency_negotiation: true,
    soft_descriptor: "123456789ABCD",
    type: "CreditCard"
  }
}
iex(2)> Cielo.Transaction.credit(attrs)
{:error,
  %{
    errors: [
      payment: %{
        errors: [credit_card: %{errors: [security_code: "can't be blank"]}]
      }
    ]
  }}

deactivate_recurrent_payment(recurrent_payment_id)

Specs

deactivate_recurrent_payment(binary()) ::
  {:error, any()} | {:error, any(), any()} | {:ok, any()}

Deactivate a recurrent payment transaction

(DEPRECATED) This function was moved to Cielo.Recurrency.deactivate/1 or main module Cielo.deactivate_recurrent/1

Successfull transaction

iex(1)> Cielo.Transaction.deactivate_recurrent_payment("26e5da86-d975-4e2f-aa25-862b5a43e9f4")
{:ok, ""}

debit(params)

Specs

debit(map()) :: {:ok, map()} | {:error, map(), list()} | {:error, any()}

Create a debit transaction if passed attributes satisfy a validation criteria

Successfull transaction

iex(1)> attrs = %{
  customer: %{name: "Comprador Cartão de débito"},
  merchant_order_id: "2014121201",
  payment: %{
    amount: 15700,
    authenticate: true,
    debit_card: %{
      brand: "Visa",
      card_number: "4551870000000183",
      expiration_date: "12/2030",
      holder: "Teste Holder",
      security_code: "123"
    },
    is_crypto_currency_negotiation: true,
    return_url: "http://www.cielo.com.br",
    type: "DebitCard"
  }
}
iex(2)> Cielo.Transaction.debit(attrs)
{:ok,
%{
  customer: %{name: "Comprador Cartão de débito"},
  merchant_order_id: "2014121201",
  payment: %{
    amount: 15700,
    authenticate: true,
    authentication_url: "https://authenticationmocksandbox.cieloecommerce.cielo.com.br/CardAuthenticator/Receive/...",
    country: "BRA",
    currency: "BRL",
    debit_card: %{
      brand: "Visa",
      card_number: "455187******0183",
      expiration_date: "12/2030",
      holder: "Teste Holder",
      save_card: false
    },
    is_crypto_currency_negotiation: true,
    is_splitted: false,
    links: [
      %{
        href: "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/...",
        method: "GET",
        rel: "self"
      }
    ],
    payment_id: "dde3931d-4dd4-4ab9-8d87-73cbfb1c513a",
    proof_of_sale: "430002",
    provider: "Simulado",
    received_date: "2020-10-18 17:53:42",
    recurrent: false,
    return_code: "1",
    return_url: "http://www.cielo.com.br",
    status: 0,
    tid: "1018055342725",
    type: "DebitCard"
  }
}}

Failed transaction

iex(1)> attrs = %{
  customer: %{name: "Comprador crédito simples"},
  merchant_order_id: "2014111703",
  payment: %{
    amount: 15700,
    credit_card: %{
      brand: "Visa",
      card_number: "1234123412341231",
      card_on_file: %{reason: "Unscheduled", usage: "Used"},
      holder: "Teste Holder"
    },
    installments: 1,
    is_crypto_currency_negotiation: true,
    soft_descriptor: "123456789ABCD",
    type: "CreditCard"
  }
}
iex(2)> Cielo.Transaction.credit(attrs)
{:error,
%{
  errors: [
    payment: %{
      errors: [debit_card: %{errors: [expiration_date: "can't be blank"]}]
    }
  ]
}}

recurrent(params)

Specs

recurrent(map()) :: {:ok, map()} | {:error, map(), list()} | {:error, any()}

(DEPRECATED) This function was moved to Cielo.Recurrency.create_payment/1

Also, you can use main module Cielo.recurrent_transaction/1