Skip to content

Latest commit

 

History

History
31 lines (28 loc) · 4.74 KB

ProxyCreatePayment.md

File metadata and controls

31 lines (28 loc) · 4.74 KB
Raw

Zuora::ProxyCreatePayment

Properties

Name Type Description Notes
account_id String The unique account ID for the customer that the payment is for.
accounting_code String The aacccounting code for the payment. Accounting codes group transactions that contain similar accounting attributes. [optional]
amount Float The amount of the payment. [optional]
applied_credit_balance_amount Float The amount of the payment to apply to a credit balance. This field is only required if the `AppliedInvoiceAmount` field value is null. [optional]
applied_invoice_amount Float The amount of the payment to apply to an invoice. This field is only required if either the `InvoiceId` or `InvoiceNumber` field is not null. [optional]
auth_transaction_id String The authorization transaction ID from the payment gateway. Use this field for electronic payments, such as credit cards. [optional]
comment String Additional information related to the payment. [optional]
effective_date Date The date when the payment takes effect.
gateway String The name of the gateway instance that processes the payment. When creating a payment, the value of this field must be a valid gateway instance name, and this gateway must support the specific payment method. If no value is specified, the default gateway on the Account will be used. [optional]
gateway_option_data ProxyCreatePaymentGatewayOptionData [optional]
gateway_order_id String A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead. Gateways check duplicates on the gateway order ID to ensure that the merchant do not accidentally enter the same transaction twice. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use their shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems. [optional]
gateway_response String The message returned from the payment gateway for the payment. This message is gateway-dependent. [optional]
gateway_response_code String The code returned from the payment gateway for the payment. This code is gateway-dependent. [optional]
gateway_state String The status of the payment in the gateway; use for reconciliation. [optional]
invoice_id String The ID of the invoice that the payment is applied to. When applying a payment to a single invoice, this field is only required if the `InvoiceNumber` field is null. [optional]
invoice_number String The unique identification number for the invoice that the payment is applied to. When applying a payment to a single invoice, this field is only required if the `InvoiceId` field is null. [optional]
invoice_payment_data InvoicePaymentData [optional]
payment_method_id String The ID of the payment method used for the payment.
payment_number String The unique identification number of the payment. For example, P-00000028. [optional]
reference_id String The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments. [optional]
soft_descriptor String A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. Zuora passes this field to Verifi directly without verification. In general, this field will be defaulted by the gateway. For Orbital, this field contains two fields separated by an asterisk, `SDMerchantName` and `SDProductionInfo`. For more information, contact your payment gateway. [optional]
soft_descriptor_phone String A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. Verifi and Orbital determine how to format this string. For more information, contact your payment gateway. [optional]
status String The status of the payment in Zuora. The value depends on the type of payment. For electronic payments, the status can be `Processed`, `Error`, or `Voided`. For external payments, the status can be `Processed` or `Canceled`.
type String The type of the payment, whether the payment is external or electronic.