Authorize a credit card transaction.

Function to authorize a transaction for the specified amount. It needs to be followed up with a capture/3 transaction to transfer the funds to merchant account.

For this transaction Authorize.Net returns a transId which can be use for:

• capture/3 an authorized transaction.
• void/2 a transaction.

Optional Fields

opts = [
  order: %{invoice_number: String, description: String},
  ref_id: String,
  lineitems: %{
    item_id: String, name: String, description: String,
    quantity: Integer, unit_price: Float
  },
  tax: %{amount: Float, name: String, description: String},
  duty: %{amount: String, name: String, description: String},
  shipping: %{amount: String, name: String, description: String},
  po_number: String,
  customer: %{id: String},
  bill_to: %{ 
    first_name: String, last_name: String, company: String,
    address: String, city: String, state: String, zip: String, 
    country: String 
  },
  ship_to: %{
    first_name: String, last_name: String, company: String, address: String,
    city: String, state: String, zip: String, country: String
  },
  customer_ip: String
]

Example

iex> opts = [
  ref_id: "123456",
  order: %{invoice_number: "INV-12345", description: "Product Description"}, 
  lineitems: %{itemId: "1", name: "vase", description: "Cannes logo", quantity: "18", unit_price: "45.00"}
]
iex> card = %CreditCard{number: "5424000000000015", year: 2020, month: 12, verification_code: "999"}
iex> amount = 5
iex> result = Gringotts.authorize(Gringotts.Gateways.AuthorizeNet, amount, card, opts)

Capture a transaction.

Function to capture an amount for an authorized transaction.

For this transaction Authorize.Net returns a transId which can be use to:

• refund/3 a settled transaction.
• void/2 a transaction.

Quirks

• If a capture transaction needs to void then it should be done before it is settled. For AuthorieNet all the transactions are settled after 24 hours.

• AuthorizeNet supports partical capture of the authorized amount. But it is advisable to use one authorization code only once.

Optional Fields

opts = [
  order: %{invoice_number: String, description: String},
  ref_id: String
]

Example

iex> opts = [
  ref_id: "123456"
]
iex> amount = 5
iex> id = "123456"
iex> result = Gringotts.capture(Gringotts.Gateways.AuthorizeNet, id, amount, opts)

Charge a credit card.

Function to charge a user credit card for the specified amount. It performs authorize and capture at the same time. For this transaction Authorize.Net returns transId which can be used to:

• refund/3 a settled transaction.
• void/2 a transaction.

Optional Fields

opts = [
  order: %{invoice_number: String, description: String},
  ref_id: String,
  lineitems: %{
    item_id: String, name: String, description: String,
    quantity: Integer, unit_price: Float
  },
  tax: %{amount: Float, name: String, description: String},
  duty: %{amount: String, name: String, description: String},
  shipping: %{amount: String, name: String, description: String},
  po_number: String,
  customer: %{id: String},
  bill_to: %{
    first_name: String, last_name: String, company: String,
    address: String, city: String, state: String, zip: String, 
    country: String 
  },
  ship_to: %{
    first_name: String, last_name: String, company: String, address: String,
    city: String, state: String, zip: String, country: String
  },
  customer_ip: String
]

Example

iex> opts = [
  ref_id: "123456",
  order: %{invoice_number: "INV-12345", description: "Product Description"}, 
  lineitems: %{itemId: "1", name: "vase", description: "Cannes logo", quantity: "18", unit_price: "45.00"}
]
iex> card = %CreditCard{number: "5424000000000015", year: 2020, month: 12, verification_code: "999"}
iex> amount = 5
iex> result = Gringotts.purchase(Gringotts.Gateways.AuthorizeNet, amount, card, opts)

Refund amount for a settled transaction referenced by id.

Use this method to refund a customer for a transaction that was already settled, requires transId of the transaction. The payment field in the opts is used to set the mode of payment. The card field inside payment needs the information of the credit card to be passed in the specified fields so as to refund to that particular card.

Required fields

opts = [
  payment: %{card: %{number: String, year: Integer, month: Integer}}
]

Optional fields

opts = [ref_id: String]

Example

iex> opts = [
  payment: %{card: %{number: "5424000000000015", year: 2020, month: 12}}
  ref_id: "123456"
]
iex> id = "123456"
iex> amount = 5
iex> result = Gringotts.refund(Gringotts.Gateways.AuthorizeNet, amount, id, opts)

Store a customer payment profile.

Use this function to store the customer card information by creating a customer profile which also creates a payment profile if card inofrmation is provided, and in case the customer profile exists without a payment profile, the merchant can create customer payment profile by passing the customer_profile_id in the opts. The gateway also provide a provision for a validation mode, there are two modes liveMode and testMode, to know more about modes see.

Quirks

• The current version of this library supports only credit card as the payment profile.
• If a customer profile is created without the card info, then to create a payment profile card info needs to be passed alongwith cutomer_profile_id to create it.

Required Fields

opts = [
  profile: %{merchant_customer_id: String, description: String, email: String}
]

Optional Fields

opts = [
  validation_mode: String,
  billTo: %{
    first_name: String, last_name: String, company: String, address: String,
    city: String, state: String, zip: String, country: String
  },
  customer_type: String,
  customer_profile_id: String
]

Example

iex> opts = [
  profile: %{merchant_customer_id: 123456, description: "test store", email: "test@gmail.com"},
  validation_mode: "testMode"
]
iex> card = %CreditCard{number: "5424000000000015", year: 2020, month: 12, verification_code: "999"}
iex> result = Gringotts.store(Gringotts.Gateways.AuthorizeNet, card, opts)

Remove a customer profile from the payment gateway.

Use this function to unstore the customer card information by deleting the customer profile present. Requires the customer profile id.

Example

iex> id = "123456"
iex> opts = []
iex> result = Gringotts.store(Gringotts.Gateways.AuthorizeNet, id, opts)

Validates the config dynamically depending on what is the value of required_config

To void a transaction

Use this method to cancel either an original transaction that is not settled or an entire order composed of more than one transaction. It can be submitted against ‘purchase’, authorize and capture. Requires the transId of a transaction.

Optional fields

opts = [ref_id: String]

Example

iex> opts = [
  ref_id: "123456"
]
iex> id = "123456"
iex> result = Gringotts.void(Gringotts.Gateways.AuthorizeNet, id, opts)