Merchant.Orders (Merchant v0.2.0)

View Source

Module for orders.

Summary

Types

create_params()
refund_params()
update_params()

Functions

cancel(id)

Cancel a Merchant.Order object.

create(params)

Create a Merchant.Order object.

refund(id, refund_params)

Refund a Merchant.Order object.

retrieve(id)

Retrieve a Merchant.Order object.

retrieve_payments_list(id)

Retrieve payments list for a Merchant.Order object.

update(id, params)

Update a Merchant.Order object.

Types

create_params()

@type create_params() :: %{
  amount: integer(),
  currency: String.t(),
  description: String.t(),
  customer: Merchant.Customer.t(),
  enforce_challenge: String.t(),
  line_items: [Merchant.LineItem.t()],
  shipping: Merchant.Shipping.t(),
  capture_mode: String.t(),
  cancel_authorised_after: String.t(),
  location_id: String.t(),
  metadata: Merchant.Metadata.t(),
  industry_data:
    Merchant.AirlineData.t()
    | Merchant.CryptoTransactions.t()
    | Merchant.Events.t()
    | Merchant.Lodging.t()
    | Merchant.Marketplace.t(),
  merchant_order_data: Merchant.MerchantOrderData.t(),
  upcoming_payment_data: Merchant.UpcomingPayment.t(),
  redirect_url: String.t(),
  statement_descriptor_suffix: String.t()
}

refund_params()

@type refund_params() :: %{
  amount: integer(),
  currency: String.t(),
  merchant_order_data: Merchant.MerchantOrderData.t(),
  metadata: Merchant.Metadata.t(),
  description: String.t()
}

update_params()

@type update_params() :: %{
  amount: integer(),
  currency: String.t(),
  settlement_currency: String.t(),
  description: String.t(),
  customer: Merchant.Customer.t(),
  shipping: Merchant.Shipping.t(),
  enforce_challenge: String.t(),
  line_items: [Merchant.LineItem.t()],
  capture_mode: String.t(),
  cancel_authorised_after: String.t(),
  metadata: Merchant.Metadata.t(),
  industry_data:
    Merchant.AirlineData.t()
    | Merchant.CryptoTransactions.t()
    | Merchant.Events.t()
    | Merchant.Lodging.t()
    | Merchant.Marketplace.t(),
  merchant_order_data: Merchant.MerchantOrderData.t(),
  upcoming_payment_data: Merchant.UpcomingPayment.t(),
  redirect_url: String.t(),
  statement_descriptor_suffix: String.t()
}

Functions

cancel(id)

@spec cancel(String.t()) :: {:ok, Merchant.OrderV4.t()} | Merchant.Client.error()

Cancel a Merchant.Order object.

create(params)

@spec create(create_params()) :: {:ok, Merchant.OrderV4.t()} | Merchant.Client.error()

Create a Merchant.Order object.

refund(id, refund_params)

@spec refund(String.t(), refund_params()) ::
  {:ok, Merchant.OrderV4.t()} | Merchant.Client.error()

Refund a Merchant.Order object.

retrieve(id)

@spec retrieve(String.t()) :: {:ok, Merchant.OrderV4.t()} | Merchant.Client.error()

Retrieve a Merchant.Order object.

retrieve_payments_list(id)

@spec retrieve_payments_list(String.t()) ::
  {:ok, [Merchant.PaymentV2.t()]} | Merchant.Client.error()

Retrieve payments list for a Merchant.Order object.

update(id, params)

@spec update(String.t(), update_params()) ::
  {:ok, Merchant.OrderV4.t()} | Merchant.Client.error()

Update a Merchant.Order object.