Class: Increase::Resources::CardPushTransfers

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/card_push_transfers.rb,
sig/increase/resources/card_push_transfers.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ CardPushTransfers

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of CardPushTransfers.

Parameters:



206
207
208
 
# File 'lib/increase/resources/card_push_transfers.rb', line 206

def initialize(client:)
  @client = client
end

Instance Method Details

#approve(card_push_transfer_id, request_options: {}) ⇒ Increase::Models::CardPushTransfer

Approves a Card Push Transfer in a pending_approval state.

Parameters:

  • card_push_transfer_id (String) —

    The identifier of the Card Push Transfer to approve.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



174
175
176
177
178
179
180
181
 
# File 'lib/increase/resources/card_push_transfers.rb', line 174

def approve(card_push_transfer_id, params = {})
  @client.request(
    method: :post,
    path: ["card_push_transfers/%1$s/approve", card_push_transfer_id],
    model: Increase::CardPushTransfer,
    options: params[:request_options]
  )
end

#cancel(card_push_transfer_id, request_options: {}) ⇒ Increase::Models::CardPushTransfer

Cancels a Card Push Transfer in a pending_approval state.

Parameters:

  • card_push_transfer_id (String) —

    The identifier of the pending Card Push Transfer to cancel.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



194
195
196
197
198
199
200
201
 
# File 'lib/increase/resources/card_push_transfers.rb', line 194

def cancel(card_push_transfer_id, params = {})
  @client.request(
    method: :post,
    path: ["card_push_transfers/%1$s/cancel", card_push_transfer_id],
    model: Increase::CardPushTransfer,
    options: params[:request_options]
  )
end

#create(business_application_identifier:, card_token_id:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_name_prefix:, merchant_postal_code:, merchant_state:, presentment_amount:, recipient_name:, sender_address_city:, sender_address_line1:, sender_address_postal_code:, sender_address_state:, sender_name:, source_account_number_id:, merchant_legal_business_name: nil, merchant_street_address: nil, recipient_address_city: nil, recipient_address_line1: nil, recipient_address_postal_code: nil, recipient_address_state: nil, require_approval: nil, request_options: {}) ⇒ Increase::Models::CardPushTransfer

Create a Card Push Transfer

Parameters:

  • business_application_identifier (Symbol, Increase::Models::CardPushTransferCreateParams::BusinessApplicationIdentifier) —

    The Business Application Identifier describes the type of transaction being performed. Your program must be approved for the specified Business Application Identifier in order to use it.

  • card_token_id (String) —

    The Increase identifier for the Card Token that represents the card number you're pushing funds to.

  • merchant_category_code (String) —

    The merchant category code (MCC) of the merchant (generally your business) sending the transfer. This is a four-digit code that describes the type of business or service provided by the merchant. Your program must be approved for the specified MCC in order to use it.

  • merchant_city_name (String) —

    The city name of the merchant (generally your business) sending the transfer.

  • merchant_name (String) —

    The merchant name shows up as the statement descriptor for the transfer. This is typically the name of your business or organization.

  • merchant_name_prefix (String) —

    For certain Business Application Identifiers, the statement descriptor is merchant_name_prefix*sender_name, where the merchant_name_prefix is a one to four character prefix that identifies the merchant.

  • merchant_postal_code (String) —

    The postal code of the merchant (generally your business) sending the transfer.

  • merchant_state (String) —

    The state of the merchant (generally your business) sending the transfer.

  • presentment_amount (Increase::Models::CardPushTransferCreateParams::PresentmentAmount) —

    The amount to transfer. The receiving bank will convert this to the cardholder's currency. The amount that is applied to your Increase account matches the currency of your account.

  • recipient_name (String) —

    The name of the funds recipient.

  • sender_address_city (String) —

    The city of the sender.

  • sender_address_line1 (String) —

    The address line 1 of the sender.

  • sender_address_postal_code (String) —

    The postal code of the sender.

  • sender_address_state (String) —

    The state of the sender.

  • sender_name (String) —

    The name of the funds originator.

  • source_account_number_id (String) —

    The identifier of the Account Number from which to send the transfer.

  • merchant_legal_business_name (String) —

    The legal business name of the merchant (generally your business) sending the transfer. Required if the card is issued in Canada.

  • merchant_street_address (String) —

    The street address of the merchant (generally your business) sending the transfer. Required if the card is issued in Canada.

  • recipient_address_city (String) —

    The city of the recipient. Required if the card is issued in Canada.

  • recipient_address_line1 (String) —

    The first line of the recipient's address. Required if the card is issued in Canada.

  • recipient_address_postal_code (String) —

    The postal code of the recipient. Required if the card is issued in Canada.

  • recipient_address_state (String) —

    The state or province of the recipient. Required if the card is issued in Canada.

  • require_approval (Boolean) —

    Whether the transfer requires explicit approval via the dashboard or API.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



92
93
94
95
96
97
98
99
100
101
 
# File 'lib/increase/resources/card_push_transfers.rb', line 92

def create(params)
  parsed, options = Increase::CardPushTransferCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "card_push_transfers",
    body: parsed,
    model: Increase::CardPushTransfer,
    options: options
  )
end

#list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::CardPushTransfer>

List Card Push Transfers

Parameters:

  • account_id (String) —

    Filter Card Push Transfers to ones belonging to the specified Account.

  • created_at (Increase::Models::CardPushTransferListParams::CreatedAt)
  • cursor (String) —

    Return the page of entries after this one.

  • idempotency_key (String) —

    Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

  • limit (Integer) —

    Limit the size of the list that is returned. The default (and maximum) is 100 objects.

  • status (Increase::Models::CardPushTransferListParams::Status)
  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/increase/resources/card_push_transfers.rb', line 150

def list(params = {})
  parsed, options = Increase::CardPushTransferListParams.dump_request(params)
  query = Increase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "card_push_transfers",
    query: query,
    page: Increase::Internal::Page,
    model: Increase::CardPushTransfer,
    options: options
  )
end

#retrieve(card_push_transfer_id, request_options: {}) ⇒ Increase::Models::CardPushTransfer

Retrieve a Card Push Transfer

Parameters:

  • card_push_transfer_id (String) —

    The identifier of the Card Push Transfer.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



114
115
116
117
118
119
120
121
 
# File 'lib/increase/resources/card_push_transfers.rb', line 114

def retrieve(card_push_transfer_id, params = {})
  @client.request(
    method: :get,
    path: ["card_push_transfers/%1$s", card_push_transfer_id],
    model: Increase::CardPushTransfer,
    options: params[:request_options]
  )
end