Class: StickyIoRestfulApiV2025731::ChargebackController

Inherits:
BaseController
  • Object
show all
Defined in:
lib/sticky_io_restful_api_v2025731/controllers/chargeback_controller.rb

Overview

ChargebackController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#initialize, #new_parameter, #new_request_builder, #new_response_handler, user_agent, user_agent_parameters

Constructor Details

This class inherits a constructor from StickyIoRestfulApiV2025731::BaseController

Instance Method Details

#add_representment(platform_key, body, domain, v2_ext) ⇒ ApiResponse

Create one or multiple representment cases. **Request Data** Request parameters expected during this API call: | Field | Requirement | Default | Data Type | Description | | — | — | — | — | — | | representments | Required | - | Array | Array of representment objects. | | representments.*.provider_transaction_id | Required | - | String | The transaction ID in the provider. | | representments.*.provider_mid | Optional | - | String | The MID in the provider. | | representments.*.provider_alias | Optional | - | String | The alias of the provider. | | representments.*.gateway_id | Optional | - | Integer | Gateway ID associated to the transaction. | | representments.*.order_id | Required | - | String | The order ID associated to the transaction in sticky. | | representments.*.reason_code | Required | - | String | The reason code associated with the transaction. | | representments.*.reason_category | Optional | - | String | The reason category. | | representments.*.case_number | Optional | - | String | The case number associated to the transaction. | | representments.*.posted_date_in | Optional | - | String: Date format(‘Y-m-d`) | The date the transaction was posted. | | representments.*.transaction_date_in | Optional | - | String: Date format(`Y-m-d`) | The date the transaction was created. | | representments.*.dispute_amount | Optional | - | Float | The amount being disputed. | | representments.*.first_name | Optional | - | String | The first name of the customer. | | representments.*.last_name | Optional | - | String | The last name of the customer. | | representments.*.billing_address_1 | Optional | - | String | The billing address 1 of the customer. | | representments.*.billing_city | Optional | - | String | The billing city of the customer. | | representments.*.billing_state | Optional | - | String | The billing state of the customer. | | representments.*.billing_zip | Optional | - | String | The billing zip of the customer. | | representments.*.currency | Optional | - | String | The currency of the transaction. | | representments.*.ip_address | Optional | - | String | The ip address of the customer. | | representments.*.provider_status | Optional | - | String | The status of the case. | | representments.*.provider_verdict | Optional | - | String | The verdict of the case. | | representments.*.case_type | Optional | - | String | The type of case. | here description here

Parameters:

  • platform_key (String) —

    Required parameter: TODO: type description

  • body (AddRepresentmentRequest) —

    Required parameter: TODO: type

  • domain (String) —

    Required parameter: TODO: type description here

  • v2_ext (String) —

    Required parameter: TODO: type description here

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/sticky_io_restful_api_v2025731/controllers/chargeback_controller.rb', line 67

def add_representment(platform_key,
                      body,
                      domain,
                      v2_ext)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/.{domain}{v2_ext}providers/chargeback/add-representments',
                                 Server::SERVER_1)
               .header_param(new_parameter(platform_key, key: 'Platform-Key')
                              .is_required(true))
               .body_param(new_parameter(body)
                            .is_required(true))
               .template_param(new_parameter(domain, key: 'domain')
                                .is_required(true)
                                .should_encode(true))
               .template_param(new_parameter(v2_ext, key: 'v2_ext')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json; charset=utf-8', key: 'content-type'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('basic')))
    .response(new_response_handler
                .is_response_void(true)
                .is_api_response(true))
    .execute
end