Class: Increase::Resources::Cards

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Cards

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 Cards.

Parameters:



223
224
225
 
# File 'lib/increase/resources/cards.rb', line 223

def initialize(client:)
  @client = client
end

Instance Method Details

#create(account_id:, authorization_controls: nil, billing_address: nil, cardholder_name: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {}) ⇒ Increase::Models::Card

Create a Card

Parameters:

  • account_id (String) —

    The Account the card should belong to.

  • authorization_controls (Increase::Models::CardCreateParams::AuthorizationControls) —

    Controls that restrict how this card can be used.

  • billing_address (Increase::Models::CardCreateParams::BillingAddress) —

    The card's billing address.

  • cardholder_name (Increase::Models::CardCreateParams::CardholderName) —

    The name of the cardholder. Used to respond to Account Name Inquiry requests from acquirers in Card Validations.

  • description (String) —

    The description you choose to give the card.

  • digital_wallet (Increase::Models::CardCreateParams::DigitalWallet) —

    The contact information used in the two-factor steps for digital wallet card creation. To add the card to a digital wallet, you may supply an email or phone number with this request. Otherwise, subscribe and then action a Real Time Decision with the category digital_wallet_token_requested or digital_wallet_authentication_requested.

  • entity_id (String) —

    The Entity the card belongs to. You only need to supply this in rare situations when the card is not for the Account holder.

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

Returns:

See Also:



39
40
41
42
 
# File 'lib/increase/resources/cards.rb', line 39

def create(params)
  parsed, options = Increase::CardCreateParams.dump_request(params)
  @client.request(method: :post, path: "cards", body: parsed, model: Increase::Card, options: options)
end

#create_details_iframe(card_id, physical_card_id: nil, request_options: {}) ⇒ Increase::Models::CardIframeURL

Create an iframe URL for a Card to display the card details. More details about styling and usage can be found in the documentation.

Parameters:

  • card_id (String) —

    The identifier of the Card to create an iframe for.

  • physical_card_id (String) —

    The identifier of the Physical Card to create an iframe for. This will inform the appearance of the card rendered in the iframe.

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

Returns:

See Also:



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/increase/resources/cards.rb', line 164

def create_details_iframe(card_id, params = {})
  parsed, options = Increase::CardCreateDetailsIframeParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["cards/%1$s/create_details_iframe", card_id],
    body: parsed,
    model: Increase::CardIframeURL,
    options: options
  )
end

#details(card_id, request_options: {}) ⇒ Increase::Models::CardDetails

Sensitive details for a Card include the primary account number, expiry, card verification code, and PIN.

Parameters:

  • card_id (String) —

    The identifier of the Card to retrieve details for.

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

Returns:

See Also:



187
188
189
190
191
192
193
194
 
# File 'lib/increase/resources/cards.rb', line 187

def details(card_id, params = {})
  @client.request(
    method: :get,
    path: ["cards/%1$s/details", card_id],
    model: Increase::CardDetails,
    options: params[:request_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::Card>

List Cards

Parameters:

  • account_id (String) —

    Filter Cards to ones belonging to the specified Account.

  • created_at (Increase::Models::CardListParams::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.

    Defaults to 100.

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

Returns:

See Also:



134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/increase/resources/cards.rb', line 134

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

#retrieve(card_id, request_options: {}) ⇒ Increase::Models::Card

Retrieve a Card

Parameters:

  • card_id (String) —

    The identifier of the Card.

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

Returns:

See Also:



55
56
57
58
59
60
61
62
 
# File 'lib/increase/resources/cards.rb', line 55

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

#update(card_id, authorization_controls: nil, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, status: nil, request_options: {}) ⇒ Increase::Models::Card

Update a Card

Parameters:

Returns:

See Also:



94
95
96
97
98
99
100
101
102
103
 
# File 'lib/increase/resources/cards.rb', line 94

def update(card_id, params = {})
  parsed, options = Increase::CardUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["cards/%1$s", card_id],
    body: parsed,
    model: Increase::Card,
    options: options
  )
end

#update_pin(card_id, pin:, request_options: {}) ⇒ Increase::Models::CardDetails

Update a Card's PIN

Parameters:

  • card_id (String) —

    The identifier of the Card to update the PIN for.

  • pin (String) —

    The 4-digit PIN for the card, for use with ATMs.

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

Returns:

See Also:



209
210
211
212
213
214
215
216
217
218
 
# File 'lib/increase/resources/cards.rb', line 209

def update_pin(card_id, params)
  parsed, options = Increase::CardUpdatePinParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["cards/%1$s/update_pin", card_id],
    body: parsed,
    model: Increase::CardDetails,
    options: options
  )
end