Zuora::PaymentsApi

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

Method	HTTP request	Description
delete_payment	DELETE /v1/payments/{paymentId}	Delete payment
get_payment	GET /v1/payments/{paymentId}	Get payment
get_payment_item_part	GET /v1/payments/{paymentId}/parts/{partid}/itemparts/{itempartid}	Get payment part item
get_payment_item_parts	GET /v1/payments/{paymentId}/parts/{partid}/itemparts	Get payment part items
get_payment_part	GET /v1/payments/{paymentId}/parts/{partid}	Get payment part
get_payment_parts	GET /v1/payments/{paymentId}/parts	Get payment parts
get_retrieve_all_payments	GET /v1/payments	Get all payments
object_delete_payment	DELETE /v1/object/payment/{id}	CRUD: Delete payment
object_get_payment	GET /v1/object/payment/{id}	CRUD: Get payment
object_post_payment	POST /v1/object/payment	CRUD: Create payment
object_put_payment	PUT /v1/object/payment/{id}	CRUD: Update payment
post_create_payment	POST /v1/payments	Create payment
post_refund_payment	POST /v1/payments/{paymentId}/refunds	Refund payment
put_apply_payment	PUT /v1/payments/{paymentId}/apply	Apply payment
put_cancel_payment	PUT /v1/payments/{paymentId}/cancel	Cancel payment
put_transfer_payment	PUT /v1/payments/{paymentId}/transfer	Transfer payment
put_unapply_payment	PUT /v1/payments/{paymentId}/unapply	Unapply payment
put_update_payment	PUT /v1/payments/{paymentId}	Update payment

delete_payment

CommonResponseType delete_payment(payment_id, opts)

Delete payment

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Deletes a payment. Only payments with the Cancelled status can be deleted.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

payment_id = "payment_id_example" # String | The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. 

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
  result = api_instance.delete_payment(payment_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->delete_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
payment_id	String	The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.
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

GETARPaymentType get_payment(payment_id, opts)

Get payment

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves the information about one specific payment.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

payment_id = "payment_id_example" # String | The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. 

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
  #Get payment
  result = api_instance.get_payment(payment_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->get_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
payment_id	String	The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.
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

GETARPaymentType

Authorization

No authorization required

HTTP request headers

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

get_payment_item_part

GETPaymentItemPartType get_payment_item_part(partid, itempartid, payment_id, opts)

Get payment part item

Note: The Invoice Item Settlement feature is in Limited Availability, and it must be used together with other Advanced AR Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves the information about a specific payment part item. A payment part item is a single line item in a payment part. A payment part can consist of several different types of items.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

partid = "partid_example" # String | The unique ID of a specific payment part. You can get the payment part ID from the response of [Get payment parts](https://www.zuora.com/developer/api-reference/#operation/GET_PaymentParts). 

itempartid = "itempartid_example" # String | The unique ID of a specific payment part item. You can get the payment part item ID from the response of [Get payment part items](https://www.zuora.com/developer/api-reference/#operation/GET_PayemntItemParts). 

payment_id = "payment_id_example" # String | The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. 

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
  #Get payment part item
  result = api_instance.get_payment_item_part(partid, itempartid, payment_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->get_payment_item_part: #{e}"
end

Parameters

Name	Type	Description	Notes
partid	String	The unique ID of a specific payment part. You can get the payment part ID from the response of Get payment parts.
itempartid	String	The unique ID of a specific payment part item. You can get the payment part item ID from the response of Get payment part items.
payment_id	String	The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.
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

GETPaymentItemPartType

Authorization

No authorization required

HTTP request headers

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

get_payment_item_parts

GETPaymentItemPartCollectionType get_payment_item_parts(partid, payment_id, opts)

Get payment part items

Note: The Invoice Item Settlement feature is in Limited Availability, and it must be used together with other Advanced AR Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves the information about all items of a payment part. A payment part item is a single line item in a payment part. A payment part can consist of several different types of items.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

partid = "partid_example" # String | The unique ID of a specific payment part. You can get the payment part ID from the response of [Get payment parts](https://www.zuora.com/developer/api-reference/#operation/GET_PaymentParts). 

payment_id = "payment_id_example" # String | The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. 

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 part items
  result = api_instance.get_payment_item_parts(partid, payment_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->get_payment_item_parts: #{e}"
end

Parameters

Name	Type	Description	Notes
partid	String	The unique ID of a specific payment part. You can get the payment part ID from the response of Get payment parts.
payment_id	String	The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.
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

GETPaymentItemPartCollectionType

Authorization

No authorization required

HTTP request headers

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

get_payment_part

GETPaymentPartType get_payment_part(partid, payment_id, opts)

Get payment part

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves the information about a specific payment part. A payment can consist of an unapplied part, and several parts applied to invoices and debit memos.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

partid = "partid_example" # String | The unique ID of a specific payment part. You can get the payment part ID from the response of [Get payment parts](https://www.zuora.com/developer/api-reference/#operation/GET_PaymentParts). 

payment_id = "payment_id_example" # String | The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. 

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
  #Get payment part
  result = api_instance.get_payment_part(partid, payment_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->get_payment_part: #{e}"
end

Parameters

Name	Type	Description	Notes
partid	String	The unique ID of a specific payment part. You can get the payment part ID from the response of Get payment parts.
payment_id	String	The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.
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

GETPaymentPartType

Authorization

No authorization required

HTTP request headers

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

get_payment_parts

GETPaymentPartsCollectionType get_payment_parts(payment_id, opts)

Get payment parts

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves the information about all parts of a payment. A payment can consist of an unapplied part, and several parts applied to invoices and debit memos. You can use this operation to get all the applied and unapplied portions of a payment.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

payment_id = "payment_id_example" # String | The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. 

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 parts
  result = api_instance.get_payment_parts(payment_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->get_payment_parts: #{e}"
end

Parameters

Name	Type	Description	Notes
payment_id	String	The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.
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

GETPaymentPartsCollectionType

Authorization

No authorization required

HTTP request headers

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

get_retrieve_all_payments

PaymentCollectionResponseType get_retrieve_all_payments(opts)

Get all payments

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves the information about all payments from all your customer accounts.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

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. 
  fields_filterable: "fields_filterable_example", # String | This parameter restricts the data returned in the response. You can use this parameter to supply a dimension you want to filter on.   A single filter uses the following form:   *fieldsFilterable* `=` *field_value*              Filters can be combined by using `&`. For example: *fieldsFilterable* `=` *field_value* & *fieldsFilterable* `=` *field_value*  *fieldsFilterable* indicates the name of a supported field that you can use to filter the response data. The supported filterable fields of this operation are as below:    - number   - status   - type   - accountId   - amount   - appliedAmount   - unappliedAmount   - refundAmount   - creditBalanceAmount   - currency   - effectiveDate   - createdDate   - createdById   - updatedDate   - updatedById   *field_value* indicates a valid value of the filterable field. If the type of the field value is string, you can set the field to `null` value for filtering. Then, you can get the response data with this field value being 'null'. For more information about these fields, see the field descriptions in the **Responses** section.     Examples:  - /payments?status=Processed  - /payments?currency=USD&status=Processed  - /payments?status=Processed&type=External&sort=+number 
  sort: "sort_example" # String | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.  A sortable field uses the following form:   *operator* *field_name*  You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  *operator* *field_name*, *operator* *field_name*    *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.    - The `-` operator indicates an ascending order.   - The `+` operator indicates a descending order.  By default, the response data is displayed in descending order by payment number.  *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:    - number   - accountId   - amount   - appliedAmount   - unappliedAmount   - refundAmount   - creditBalanceAmount   - effectiveDate   - createdDate   - createdById   - updatedDate   - updatedById    Examples:  - /payments?sort=+number  - /payments?status=Processed&sort=-number,+amount 
}

begin
  #Get all payments
  result = api_instance.get_retrieve_all_payments(opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->get_retrieve_all_payments: #{e}"
end

Parameters

Name	Type	Description	Notes
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]
fields_filterable	String	This parameter restricts the data returned in the response. You can use this parameter to supply a dimension you want to filter on. A single filter uses the following form: fieldsFilterable `=` field_value Filters can be combined by using `&`. For example: fieldsFilterable `=` field_value & fieldsFilterable `=` field_value fieldsFilterable indicates the name of a supported field that you can use to filter the response data. The supported filterable fields of this operation are as below: - number - status - type - accountId - amount - appliedAmount - unappliedAmount - refundAmount - creditBalanceAmount - currency - effectiveDate - createdDate - createdById - updatedDate - updatedById field_value indicates a valid value of the filterable field. If the type of the field value is string, you can set the field to `null` value for filtering. Then, you can get the response data with this field value being 'null'. For more information about these fields, see the field descriptions in the Responses section. Examples: - /payments?status=Processed - /payments?currency=USD&status=Processed - /payments?status=Processed&type=External&sort=+number	[optional]
sort	String	This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: operator field_name You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: operator field_name, operator field_name operator is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by payment number. field_name indicates the name of a sortable field. The supported sortable fields of this operation are as below: - number - accountId - amount - appliedAmount - unappliedAmount - refundAmount - creditBalanceAmount - effectiveDate - createdDate - createdById - updatedDate - updatedById Examples: - /payments?sort=+number - /payments?status=Processed&sort=-number,+amount	[optional]

Return type

PaymentCollectionResponseType

Authorization

No authorization required

HTTP request headers

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

object_delete_payment

ProxyDeleteResponse object_delete_payment(id, opts)

CRUD: Delete payment

Deletes a payment. Only payments with the Cancelled status can be deleted.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

id = "id_example" # String | The unique ID of the payment to be deleted. For example, 2c92c0f85d4e95ae015d4f7e5d690622. 

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
  result = api_instance.object_delete_payment(id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->object_delete_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The unique ID of the payment to be deleted. For example, 2c92c0f85d4e95ae015d4f7e5d690622.
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

ProxyGetPayment object_get_payment(id, opts)

CRUD: Get payment

Retrives the information about one specific payment.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

id = "id_example" # String | The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352. 

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: Get payment
  result = api_instance.object_get_payment(id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->object_get_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352.
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

ProxyGetPayment

Authorization

No authorization required

HTTP request headers

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

object_post_payment

ProxyCreateOrModifyResponse object_post_payment(create_request, opts)

CRUD: Create payment

Creates a payment.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

create_request = Zuora::ProxyCreatePayment.new # ProxyCreatePayment | 

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
  result = api_instance.object_post_payment(create_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->object_post_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
create_request	ProxyCreatePayment
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

ProxyCreateOrModifyResponse object_put_payment(id, modify_request, opts)

CRUD: Update payment

Updates a payment.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

id = "id_example" # String | The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352. 

modify_request = Zuora::ProxyModifyPayment.new # ProxyModifyPayment | 

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
  result = api_instance.object_put_payment(id, modify_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->object_put_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352.
modify_request	ProxyModifyPayment
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_create_payment

GETARPaymentType post_create_payment(body, opts)

Create payment

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Creates a payment for the following scenarios: - A full payment on an invoice or debit memo - A partial payment - A payment for several invoices and debit memos - An unapplied payment If you do not know to which customer account the payment belongs, you can create a payment without specifying a customer account. For more information, see Create Payments and Create Payments Without Specifying Customer Accounts.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

body = Zuora::CreatePaymentType.new # CreatePaymentType | 

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
  result = api_instance.post_create_payment(body, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->post_create_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
body	CreatePaymentType
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

GETARPaymentType

Authorization

No authorization required

HTTP request headers

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

post_refund_payment

GETRefundPaymentType post_refund_payment(body, payment_id, opts)

Refund payment

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Refunds a full or partial unapplied payment to your customers. To refund applied payments, you must unapply the applied payments from the invoices or debit memos, and then refund the unapplied payments to customers. For more information, see Refund Payments.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

body = Zuora::PostRefundType.new # PostRefundType | 

payment_id = "payment_id_example" # String | The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. 

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
  #Refund payment
  result = api_instance.post_refund_payment(body, payment_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->post_refund_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
body	PostRefundType
payment_id	String	The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.
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

GETRefundPaymentType

Authorization

No authorization required

HTTP request headers

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

put_apply_payment

GETARPaymentType put_apply_payment(body, payment_id, opts)

Apply payment

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Applies an unapplied payment to invoices and debit memos. For more information, see Apply Unapplied Payments to Invoices and Debit Memos.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

body = Zuora::ApplyPaymentType.new # ApplyPaymentType | 

payment_id = "payment_id_example" # String | The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. 

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
  #Apply payment
  result = api_instance.put_apply_payment(body, payment_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->put_apply_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
body	ApplyPaymentType
payment_id	String	The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.
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

GETARPaymentType

Authorization

No authorization required

HTTP request headers

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

put_cancel_payment

GETARPaymentType put_cancel_payment(payment_id, opts)

Cancel payment

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Cancels a payment.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

payment_id = "payment_id_example" # String | The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. 

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
  #Cancel payment
  result = api_instance.put_cancel_payment(payment_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->put_cancel_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
payment_id	String	The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.
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

GETARPaymentType

Authorization

No authorization required

HTTP request headers

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

put_transfer_payment

GETARPaymentType put_transfer_payment(body, payment_id, opts)

Transfer payment

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Transfers an unapplied payment. For more information, see Transfer Unapplied Payments.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

body = Zuora::TransferPaymentType.new # TransferPaymentType | 

payment_id = "payment_id_example" # String | The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. 

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
  #Transfer payment
  result = api_instance.put_transfer_payment(body, payment_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->put_transfer_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
body	TransferPaymentType
payment_id	String	The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.
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

GETARPaymentType

Authorization

No authorization required

HTTP request headers

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

put_unapply_payment

GETARPaymentType put_unapply_payment(body, payment_id, opts)

Unapply payment

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Unapplies an applied payment from invoices and debit memos. For more information, see Unapply Payments from Invoices and Debit Memos.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

body = Zuora::UnapplyPaymentType.new # UnapplyPaymentType | 

payment_id = "payment_id_example" # String | The unique ID of an applied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. 

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
  #Unapply payment
  result = api_instance.put_unapply_payment(body, payment_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->put_unapply_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
body	UnapplyPaymentType
payment_id	String	The unique ID of an applied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.
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

GETARPaymentType

Authorization

No authorization required

HTTP request headers

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

put_update_payment

GETARPaymentType put_update_payment(body, payment_id, opts)

Update payment

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Updates a payment.

Example

# load the gem
require 'zuora'

api_instance = Zuora::PaymentsApi.new

body = Zuora::UpdatePaymentType.new # UpdatePaymentType | 

payment_id = "payment_id_example" # String | The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. 

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
  result = api_instance.put_update_payment(body, payment_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling PaymentsApi->put_update_payment: #{e}"
end

Parameters

Name	Type	Description	Notes
body	UpdatePaymentType
payment_id	String	The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.
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

GETARPaymentType

Authorization

No authorization required

HTTP request headers

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

Files

PaymentsApi.md

Latest commit

History

PaymentsApi.md

File metadata and controls

Zuora::PaymentsApi

delete_payment

Example

Parameters

Return type

Authorization

HTTP request headers

get_payment

Example

Parameters

Return type

Authorization

HTTP request headers

get_payment_item_part

Example

Parameters

Return type

Authorization

HTTP request headers

get_payment_item_parts

Example

Parameters

Return type

Authorization

HTTP request headers

get_payment_part

Example

Parameters

Return type

Authorization

HTTP request headers

get_payment_parts

Example

Parameters

Return type

Authorization

HTTP request headers

get_retrieve_all_payments

Example

Parameters

Return type

Authorization

HTTP request headers

object_delete_payment

Example

Parameters

Return type

Authorization

HTTP request headers

object_get_payment

Example

Parameters

Return type

Authorization

HTTP request headers

object_post_payment

Example

Parameters

Return type

Authorization

HTTP request headers

object_put_payment

Example

Parameters

Return type

Authorization

HTTP request headers

post_create_payment

Example

Parameters

Return type

Authorization

HTTP request headers

post_refund_payment