Zuora::PaymentMethodsApi

All URIs are relative to https://rest.zuora.com

Method	HTTP request	Description
delete_payment_methods	DELETE /v1/payment-methods/{payment-method-id}	Delete payment method
get_payment_methods	GET /v1/payment-methods/credit-cards/accounts/{account-key}	Get payment methods
object_delete_payment_method	DELETE /v1/object/payment-method/{id}	CRUD: Delete payment method
object_get_payment_method	GET /v1/object/payment-method/{id}	CRUD: Get payment method
object_post_payment_method	POST /v1/object/payment-method	CRUD: Create payment method
object_put_payment_method	PUT /v1/object/payment-method/{id}	CRUD: Update payment method
post_payment_methods	POST /v1/payment-methods/credit-cards	Create payment method
post_payment_methods_decryption	POST /v1/payment-methods/decryption	Create payment method decryption
put_payment_methods	PUT /v1/payment-methods/credit-cards/{payment-method-id}	Update payment method
put_verify_payment_methods	PUT /v1/payment-methods/{payment-method-id}/verify	Verify payment method

delete_payment_methods

CommonResponseType delete_payment_methods(payment_method_id, opts)

Delete payment method

Deletes a credit card payment method from the specified customer account. If the specified payment method is the account's default payment method, the request will fail. In that case, you must first designate a different payment method for that customer to be the default.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentMethodsApi.new

payment_method_id = "payment_method_id_example" # String | Unique identifier of a payment method. (Since this ID is unique, and linked to a customer account in the system, no customer identifier is needed.)

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Delete payment method
  result = api_instance.delete_payment_methods(payment_method_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentMethodsApi->delete_payment_methods: #{e}"
end

Parameters

Name	Type	Description	Notes
payment_method_id	String	Unique identifier of a payment method. (Since this ID is unique, and linked to a customer account in the system, no customer identifier is needed.)
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

CommonResponseType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_payment_methods

GETPaymentMethodsType get_payment_methods(account_key, opts)

Get payment methods

This REST API reference describes how to retrieve all credit card information for the specified customer account. ## Notes The response includes details credit or debit cards for the specified customer account. Card numbers are masked, e.g., "************1234". Cards are returned in reverse chronological order of last update. You can send requests for bank transfer payment methods types. The response will not include bank transfer details. The response only includes payment details on payment methods that are credit or debit cards.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentMethodsApi.new

account_key = "account_key_example" # String | Account number or account ID.

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  page_size: 20 # Integer | Number of rows returned per page. 
}

begin
  #Get payment methods
  result = api_instance.get_payment_methods(account_key, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentMethodsApi->get_payment_methods: #{e}"
end

Parameters

Name	Type	Description	Notes
account_key	String	Account number or account ID.
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
page_size	Integer	Number of rows returned per page.	[optional] [default to 20]

Return type

GETPaymentMethodsType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

object_delete_payment_method

ProxyDeleteResponse object_delete_payment_method(id, opts)

CRUD: Delete payment method

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentMethodsApi.new

id = "id_example" # String | Object id

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #CRUD: Delete payment method
  result = api_instance.object_delete_payment_method(id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentMethodsApi->object_delete_payment_method: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	Object id
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

ProxyDeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

object_get_payment_method

ProxyGetPaymentMethod object_get_payment_method(id, opts)

CRUD: Get payment method

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentMethodsApi.new

id = "id_example" # String | Object id

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  fields: "fields_example" # String | Object fields to return
}

begin
  #CRUD: Get payment method
  result = api_instance.object_get_payment_method(id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentMethodsApi->object_get_payment_method: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	Object id
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
fields	String	Object fields to return	[optional]

Return type

ProxyGetPaymentMethod

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

object_post_payment_method

ProxyCreateOrModifyResponse object_post_payment_method(create_request, opts)

CRUD: Create payment method

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentMethodsApi.new

create_request = Zuora::ProxyCreatePaymentMethod.new # ProxyCreatePaymentMethod | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #CRUD: Create payment method
  result = api_instance.object_post_payment_method(create_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentMethodsApi->object_post_payment_method: #{e}"
end

Parameters

Name	Type	Description	Notes
create_request	ProxyCreatePaymentMethod
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

ProxyCreateOrModifyResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

object_put_payment_method

ProxyCreateOrModifyResponse object_put_payment_method(id, modify_request, opts)

CRUD: Update payment method

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentMethodsApi.new

id = "id_example" # String | Object id

modify_request = Zuora::ProxyModifyPaymentMethod.new # ProxyModifyPaymentMethod | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #CRUD: Update payment method
  result = api_instance.object_put_payment_method(id, modify_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentMethodsApi->object_put_payment_method: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	Object id
modify_request	ProxyModifyPaymentMethod
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

ProxyCreateOrModifyResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

post_payment_methods

POSTPaymentMethodResponseType post_payment_methods(request, opts)

Create payment method

This REST API reference describes how to create a new credit card payment method for a customer account. ## Notes This API call is CORS Enabled. Use client-side JavaScript to invoke the call.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentMethodsApi.new

request = Zuora::POSTPaymentMethodType.new # POSTPaymentMethodType | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Create payment method
  result = api_instance.post_payment_methods(request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentMethodsApi->post_payment_methods: #{e}"
end

Parameters

Name	Type	Description	Notes
request	POSTPaymentMethodType
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

POSTPaymentMethodResponseType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

post_payment_methods_decryption

POSTPaymentMethodResponseDecryption post_payment_methods_decryption(request, opts)

Create payment method decryption

The decryption API endpoint can conditionally perform 3 tasks in one atomic call: * Decrypt Apple Pay Payment token * Create Credit Card Payment Method in Zuora with decrypted Apple Pay information * Process Payment on a specified Invoice (optional)

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentMethodsApi.new

request = Zuora::POSTPaymentMethodDecryption.new # POSTPaymentMethodDecryption | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Create payment method decryption
  result = api_instance.post_payment_methods_decryption(request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentMethodsApi->post_payment_methods_decryption: #{e}"
end

Parameters

Name	Type	Description	Notes
request	POSTPaymentMethodDecryption
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

POSTPaymentMethodResponseDecryption

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

put_payment_methods

PUTPaymentMethodResponseType put_payment_methods(payment_method_id, request, opts)

Update payment method

Updates an existing credit card payment method for the specified customer account.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentMethodsApi.new

payment_method_id = "payment_method_id_example" # String | Unique ID of the payment method to update.

request = Zuora::PUTPaymentMethodType.new # PUTPaymentMethodType | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Update payment method
  result = api_instance.put_payment_methods(payment_method_id, request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentMethodsApi->put_payment_methods: #{e}"
end

Parameters

Name	Type	Description	Notes
payment_method_id	String	Unique ID of the payment method to update.
request	PUTPaymentMethodType
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

PUTPaymentMethodResponseType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

put_verify_payment_methods

PUTVerifyPaymentMethodResponseType put_verify_payment_methods(payment_method_id, body)

Verify payment method

Sends an authorization request to the corresponding payment gateway to verify the payment method, even though no changes are made for the payment method. Supported payment methods are Credit Cards and Paypal. Zuora now supports performing a standalone zero dollar verification or one dollar authorization for credit cards. It also supports a billing agreement status check on PayPal payment methods. If a payment method is created by Hosted Payment Pages and is not assigned to any billing account, the payment method cannot be verified through this operation.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentMethodsApi.new

payment_method_id = "payment_method_id_example" # String | The ID of the payment method to be verified. 

body = Zuora::PUTVerifyPaymentMethodType.new # PUTVerifyPaymentMethodType | 


begin
  #Verify payment method
  result = api_instance.put_verify_payment_methods(payment_method_id, body)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentMethodsApi->put_verify_payment_methods: #{e}"
end

Parameters

Name	Type	Description	Notes
payment_method_id	String	The ID of the payment method to be verified.
body	PUTVerifyPaymentMethodType

Return type

PUTVerifyPaymentMethodResponseType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

Files

PaymentMethodsApi.md

Latest commit

History

PaymentMethodsApi.md

File metadata and controls

Zuora::PaymentMethodsApi

delete_payment_methods

Example

Parameters

Return type

Authorization

HTTP request headers

get_payment_methods

Example

Parameters

Return type

Authorization

HTTP request headers

object_delete_payment_method

Example

Parameters

Return type

Authorization

HTTP request headers

object_get_payment_method

Example

Parameters

Return type

Authorization

HTTP request headers

object_post_payment_method

Example

Parameters

Return type

Authorization

HTTP request headers

object_put_payment_method

Example

Parameters

Return type

Authorization

HTTP request headers

post_payment_methods

Example

Parameters

Return type

Authorization

HTTP request headers

post_payment_methods_decryption

Example

Parameters

Return type

Authorization

HTTP request headers

put_payment_methods

Example

Parameters

Return type

Authorization

HTTP request headers

put_verify_payment_methods

Example

Parameters

Return type

Authorization

HTTP request headers