Module: PaypalAPI::PaymentTokens::APIs

Included in:
PaypalAPI::PaymentTokens, PaypalAPI::PaymentTokens
Defined in:
lib/paypal-api/api_collections/payment_tokens.rb

Overview

Common methods for PaypalAPI::PaymentTokens class and client.payment_tokens instance

Instance Method Summary collapse

Instance Method Details

#create(query: nil, body: nil, headers: nil) ⇒ Response

Create payment token for a given payment source

Parameters:

  • query (Hash, nil) (defaults to: nil) —

    Request query parameters

  • body (Hash, nil) (defaults to: nil) —

    Request body parameters

  • headers (Hash, nil) (defaults to: nil) —

    Request headers

Returns:

See Also:



27
28
29
 
# File 'lib/paypal-api/api_collections/payment_tokens.rb', line 27

def create(query: nil, body: nil, headers: nil)
  client.post("/v3/vault/payment-tokens", query: query, body: body, headers: headers)
end

#delete(id, query: nil, body: nil, headers: nil) ⇒ Response

Delete payment token

Parameters:

  • id (String) —

    ID of the payment token

  • query (Hash, nil) (defaults to: nil) —

    Request query parameters

  • body (Hash, nil) (defaults to: nil) —

    Request body parameters

  • headers (Hash, nil) (defaults to: nil) —

    Request headers

Returns:

See Also:



62
63
64
 
# File 'lib/paypal-api/api_collections/payment_tokens.rb', line 62

def delete(id, query: nil, body: nil, headers: nil)
  client.delete("/v3/vault/payment-tokens/#{encode(id)}", query: query, body: body, headers: headers)
end

#list(query: nil, body: nil, headers: nil) ⇒ Response

List all payment tokens

Parameters:

  • query (Hash, nil) (defaults to: nil) —

    Request query parameters

  • body (Hash, nil) (defaults to: nil) —

    Request body parameters

  • headers (Hash, nil) (defaults to: nil) —

    Request headers

Returns:

See Also:



38
39
40
 
# File 'lib/paypal-api/api_collections/payment_tokens.rb', line 38

def list(query: nil, body: nil, headers: nil)
  client.get("/v3/vault/payment-tokens", query: query, body: body, headers: headers)
end

#show(id, query: nil, body: nil, headers: nil) ⇒ Response

Retrieve a payment token

Parameters:

  • id (String) —

    ID of the payment token.

  • query (Hash, nil) (defaults to: nil) —

    Request query parameters

  • body (Hash, nil) (defaults to: nil) —

    Request body parameters

  • headers (Hash, nil) (defaults to: nil) —

    Request headers

Returns:

See Also:



50
51
52
 
# File 'lib/paypal-api/api_collections/payment_tokens.rb', line 50

def show(id, query: nil, body: nil, headers: nil)
  client.get("/v3/vault/payment-tokens/#{encode(id)}", query: query, body: body, headers: headers)
end