google_api_content v0.9.0 GoogleApi.Content.V2.Api.Orderpayments View Source

API calls for all endpoints tagged Orderpayments.

Link to this section Summary

Link to this section Functions

Link to this function

content_orderpayments_notifyauthapproved(connection, merchant_id, order_id, optional_params \\ [], opts \\ []) View Source

Notify about successfully authorizing user's payment method for a given amount.

Parameters

  • connection (GoogleApi.Content.V2.Connection): Connection to server
  • merchant_id (String.t): The ID of the account that manages the order. This cannot be a multi-client account.
  • order_id (String.t): The ID of the order for for which payment authorization is happening.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (OrderpaymentsNotifyAuthApprovedRequest):

Returns

{:ok, %GoogleApi.Content.V2.Model.OrderpaymentsNotifyAuthApprovedResponse{}} on success {:error, info} on failure

Link to this function

content_orderpayments_notifyauthdeclined(connection, merchant_id, order_id, optional_params \\ [], opts \\ []) View Source

Notify about failure to authorize user's payment method.

Parameters

  • connection (GoogleApi.Content.V2.Connection): Connection to server
  • merchant_id (String.t): The ID of the account that manages the order. This cannot be a multi-client account.
  • order_id (String.t): The ID of the order for which payment authorization was declined.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (OrderpaymentsNotifyAuthDeclinedRequest):

Returns

{:ok, %GoogleApi.Content.V2.Model.OrderpaymentsNotifyAuthDeclinedResponse{}} on success {:error, info} on failure

Link to this function

content_orderpayments_notifycharge(connection, merchant_id, order_id, optional_params \\ [], opts \\ []) View Source

Notify about charge on user's selected payments method.

Parameters

  • connection (GoogleApi.Content.V2.Connection): Connection to server
  • merchant_id (String.t): The ID of the account that manages the order. This cannot be a multi-client account.
  • order_id (String.t): The ID of the order for which charge is happening.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (OrderpaymentsNotifyChargeRequest):

Returns

{:ok, %GoogleApi.Content.V2.Model.OrderpaymentsNotifyChargeResponse{}} on success {:error, info} on failure

Link to this function

content_orderpayments_notifyrefund(connection, merchant_id, order_id, optional_params \\ [], opts \\ []) View Source

Notify about refund on user's selected payments method.

Parameters

  • connection (GoogleApi.Content.V2.Connection): Connection to server
  • merchant_id (String.t): The ID of the account that manages the order. This cannot be a multi-client account.
  • order_id (String.t): The ID of the order for which charge is happening.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (OrderpaymentsNotifyRefundRequest):

Returns

{:ok, %GoogleApi.Content.V2.Model.OrderpaymentsNotifyRefundResponse{}} on success {:error, info} on failure