My Project
 All Classes Namespaces Files Functions Variables Typedefs Properties Pages
Orbipay.PaymentsApi.Client.Wrappers.Payment Class Reference
Inheritance diagram for Orbipay.PaymentsApi.Client.Wrappers.Payment:
Orbipay.PaymentsApi.Client.Wrappers.Base

Public Member Functions

string GetId ()
 The unique identifier assigned by Orbipay to the payment. More...
 
string GetUrl ()
 This URL fetches the details of payment. More...
 
Fee GetFee ()
 Gets Fee More...
 
string GetStatus ()
 The status of the payment. More...
 
string GetPaymentMethod ()
 The fulfillment method for the payment. More...
 
string GetConfirmationNumber ()
 The confirmation number or reference provided to the customer for the payment. More...
 
Dictionary< string, string > GetCustomFields ()
 The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests. More...
 
string GetCurrencyCode3d ()
 The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD. More...
 
string GetAmount ()
 The amount being paid. In case the payment_amount_type is &#39;discounted_amount&#39;, &#39;penalty_amount&#39; or &#39;other&#39;, the amount needs to be specified. In other cases, this is derived from the payment_amount_type. More...
 
string GetCardCvvNumber ()
 This is never returned by Orbipay. This needs to be passed to Orbipay when making or editing a payment with a card funding account. More...
 
string GetPaymentDate ()
 The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
 
string GetPaymentScheduleType ()
 The schedule type for the payment. This defaults to one_time_payment. More...
 
string GetPaymentRequestDate ()
 The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it. More...
 
string GetPaymentAmountType ()
 The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other. More...
 
string GetPaymentReference ()
 The unique identifier in the client system for the payment. More...
 
string GetExpectedPaymentSettlementDate ()
 The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
 
string GetPaymentEntryDate ()
 The date on which the payment is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
 
string GetPaymentReturnDate ()
 The date on which the ACH returns is received by Orbipay. More...
 
string GetReturnCode ()
 The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments. More...
 
string GetPaymentNotificationEmail ()
 The email address to which notifications for the payment will be sent. The notifications will be sent to the customer&#39;s email in case this is not provided. More...
 
string GetComments ()
 Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo. More...
 
string GetDeleted ()
 The status of payment which says whether the payment is deleted or not More...
 
Customer GetCustomer ()
 Gets Customer More...
 
FundingAccount GetFundingAccount ()
 Gets FundingAccount More...
 
CustomerAccount GetCustomerAccount ()
 Gets CustomerAccount More...
 
PaymentNetworkResponse GetPaymentNetworkResponse ()
 Gets PaymentNetworkResponse More...
 
AuditInfo GetAuditInfo ()
 Gets AuditInfo More...
 
string GetID_CUSTOMER ()
 The unique identifier assigned by EBPP to the customer. More...
 
string GetID_PAYMENT ()
 The unique identifier assigned by EBPP to the payment. More...
 
 Payment (string iDPAYMENT=null)
 
Payment ForClient (string clientKey)
 
Payment VideChannel (string channel)
 
Payment WithDetails (string paymentAmountType, string amount, string paymentDate, string paymentRequestDate, string cardCvvNumber)
 
Payment FromAccount (FundingAccount fundingAccount)
 
Payment ToAccount (CustomerAccount customerAccount)
 
Payment WithReference (string paymentReference)
 
Payment WithPaymentNotificationEmail (string paymentNotificationEmail)
 
Payment WithStatus (string status)
 
Payment WithCustomFields (Dictionary< string, string > customFields)
 
Payment WithMemo (string comments)
 
Payment WithFee (Fee fee)
 
Payment ForCustomer (string iDCUSTOMER)
 
Payment CreatedBy (string requestor, string requestorType)
 CreatedBy Method. More...
 
Payment DeletedBy (string requestor, string requestorType)
 DeletedBy Method. More...
 
Payment RetrievedBy (string requestor, string requestorType)
 RetrievedBy Method. More...
 
Payment UpdatedBy (string requestor, string requestorType)
 UpdatedBy Method. More...
 
Payment Create (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
 Create Method. More...
 
Payment Delete (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
 Delete Method. More...
 
Payment Get (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
 Get Method. More...
 
Payment Update (InvocationContext invocation_context, string live_mode=null, string api_end_point=null)
 Update Method. More...
 
IEnumerator< PaymentGetEnumerator ()
 
- Public Member Functions inherited from Orbipay.PaymentsApi.Client.Wrappers.Base
String GetLiveMode ()
 
string GetApiEndPoint ()
 
void SetLiveMode (String LiveMode=default(String))
 
void SetHttpStatusCode (int httpStatusCode)
 
InvocationContext GetInvocationContext ()
 
int GetHttpStatusCode ()
 
void SetInvocationContext (InvocationContext invocationContext)
 
void Dispose ()
 

Public Attributes

string Id
 The unique identifier assigned by Orbipay to the payment. More...
 
string Url
 This URL fetches the details of payment. More...
 
Fee Fee
 Fee More...
 
string Status
 The status of the payment. More...
 
string PaymentMethod
 The fulfillment method for the payment. More...
 
string ConfirmationNumber
 The confirmation number or reference provided to the customer for the payment. More...
 
Dictionary< string, string > CustomFields
 The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests. More...
 
string CurrencyCode3d
 The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD. More...
 
string Amount
 The amount being paid. In case the payment_amount_type is &#39;discounted_amount&#39;, &#39;penalty_amount&#39; or &#39;other&#39;, the amount needs to be specified. In other cases, this is derived from the payment_amount_type. More...
 
string CardCvvNumber
 This is never returned by Orbipay. This needs to be passed to Orbipay when making or editing a payment with a card funding account. More...
 
string PaymentDate
 The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
 
string PaymentScheduleType
 The schedule type for the payment. This defaults to one_time_payment. More...
 
string PaymentRequestDate
 The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it. More...
 
string PaymentAmountType
 The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other. More...
 
string PaymentReference
 The unique identifier in the client system for the payment. More...
 
string ExpectedPaymentSettlementDate
 The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
 
string PaymentEntryDate
 The date on which the payment is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. More...
 
string PaymentReturnDate
 The date on which the ACH returns is received by Orbipay. More...
 
string ReturnCode
 The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments. More...
 
string PaymentNotificationEmail
 The email address to which notifications for the payment will be sent. The notifications will be sent to the customer&#39;s email in case this is not provided. More...
 
string Comments
 Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo. More...
 
string Deleted
 The status of payment which says whether the payment is deleted or not More...
 
Customer Customer
 Customer More...
 
FundingAccount FundingAccount
 FundingAccount More...
 
CustomerAccount CustomerAccount
 CustomerAccount More...
 
PaymentNetworkResponse PaymentNetworkResponse
 PaymentNetworkResponse More...
 
AuditInfo AuditInfo
 AuditInfo More...
 
string ID_CUSTOMER
 The unique identifier assigned by EBPP to the customer. More...
 
string ID_PAYMENT
 The unique identifier assigned by EBPP to the payment. More...
 
- Public Attributes inherited from Orbipay.PaymentsApi.Client.Wrappers.Base
int HttpStatusCode
 

Additional Inherited Members

- Protected Member Functions inherited from Orbipay.PaymentsApi.Client.Wrappers.Base
Base VideChannel (string channel)
 
Base RequestedBy (string requestor, string requestorType)
 
Base ForClient (string clientKey)
 
Base SetAPIEndpoint (String LiveMode=null, String apiEndPoint=null)
 
Base WithContext (InvocationContext request, String LiveMode=default(String), String apiEndPoint=null)
 

Constructor & Destructor Documentation

Orbipay.PaymentsApi.Client.Wrappers.Payment.Payment ( string  iDPAYMENT = null)

Payment Constructor.

Parameters
ID_PAYMENTThe ID_PAYMENT is of type string

Member Function Documentation

Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.Create ( InvocationContext  invocation_context,
string  live_mode = null,
string  api_end_point = null 
)

Create Method.

Parameters
invocationContextThe invocationContext is of type InvocationContext
liveModeThe liveMode is of type String
Exceptions
OrbipayApiExceptionThe only Exception that is thrown in Exceptional case
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.CreatedBy ( string  requestor,
string  requestorType 
)

CreatedBy Method.

Parameters
RequestorThe Requestor is of type string
RequestorTypeThe RequestorType is of type string
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.Delete ( InvocationContext  invocation_context,
string  live_mode = null,
string  api_end_point = null 
)

Delete Method.

Parameters
invocationContextThe invocationContext is of type InvocationContext
liveModeThe liveMode is of type String
Exceptions
OrbipayApiExceptionThe only Exception that is thrown in Exceptional case
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.DeletedBy ( string  requestor,
string  requestorType 
)

DeletedBy Method.

Parameters
RequestorThe Requestor is of type string
RequestorTypeThe RequestorType is of type string
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.ForClient ( string  clientKey)

ForClient Method.

Parameters
ClientKeyThe ClientKey is of type string
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.ForCustomer ( string  iDCUSTOMER)

ForCustomer Method.

Parameters
ID_CUSTOMERThe ID_CUSTOMER is of type string
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.FromAccount ( FundingAccount  fundingAccount)

FromAccount Method.

Parameters
FundingAccountThe FundingAccount is of type FundingAccount
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.Get ( InvocationContext  invocation_context,
string  live_mode = null,
string  api_end_point = null 
)

Get Method.

Parameters
invocationContextThe invocationContext is of type InvocationContext
liveModeThe liveMode is of type String
Exceptions
OrbipayApiExceptionThe only Exception that is thrown in Exceptional case
Returns
Payment
string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetAmount ( )

The amount being paid. In case the payment_amount_type is &#39;discounted_amount&#39;, &#39;penalty_amount&#39; or &#39;other&#39;, the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

The amount being paid. In case the payment_amount_type is &#39;discounted_amount&#39;, &#39;penalty_amount&#39; or &#39;other&#39;, the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

AuditInfo Orbipay.PaymentsApi.Client.Wrappers.Payment.GetAuditInfo ( )

Gets AuditInfo

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetCardCvvNumber ( )

This is never returned by Orbipay. This needs to be passed to Orbipay when making or editing a payment with a card funding account.

This is never returned by Orbipay. This needs to be passed to Orbipay when making or editing a payment with a card funding account.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetComments ( )

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo.

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetConfirmationNumber ( )

The confirmation number or reference provided to the customer for the payment.

The confirmation number or reference provided to the customer for the payment.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetCurrencyCode3d ( )

The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD.

The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD.

Customer Orbipay.PaymentsApi.Client.Wrappers.Payment.GetCustomer ( )

Gets Customer

CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.Payment.GetCustomerAccount ( )
Dictionary<string, string> Orbipay.PaymentsApi.Client.Wrappers.Payment.GetCustomFields ( )

The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests.

The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetDeleted ( )

The status of payment which says whether the payment is deleted or not

The status of payment which says whether the payment is deleted or not

IEnumerator<Payment> Orbipay.PaymentsApi.Client.Wrappers.Payment.GetEnumerator ( )
string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetExpectedPaymentSettlementDate ( )

The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Fee Orbipay.PaymentsApi.Client.Wrappers.Payment.GetFee ( )

Gets Fee

FundingAccount Orbipay.PaymentsApi.Client.Wrappers.Payment.GetFundingAccount ( )
string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetId ( )

The unique identifier assigned by Orbipay to the payment.

The unique identifier assigned by Orbipay to the payment.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetID_CUSTOMER ( )

The unique identifier assigned by EBPP to the customer.

The unique identifier assigned by EBPP to the customer.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetID_PAYMENT ( )

The unique identifier assigned by EBPP to the payment.

The unique identifier assigned by EBPP to the payment.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetPaymentAmountType ( )

The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.

The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetPaymentDate ( )

The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetPaymentEntryDate ( )

The date on which the payment is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

The date on which the payment is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetPaymentMethod ( )

The fulfillment method for the payment.

The fulfillment method for the payment.

PaymentNetworkResponse Orbipay.PaymentsApi.Client.Wrappers.Payment.GetPaymentNetworkResponse ( )
string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetPaymentNotificationEmail ( )

The email address to which notifications for the payment will be sent. The notifications will be sent to the customer&#39;s email in case this is not provided.

The email address to which notifications for the payment will be sent. The notifications will be sent to the customer&#39;s email in case this is not provided.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetPaymentReference ( )

The unique identifier in the client system for the payment.

The unique identifier in the client system for the payment.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetPaymentRequestDate ( )

The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it.

The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetPaymentReturnDate ( )

The date on which the ACH returns is received by Orbipay.

The date on which the ACH returns is received by Orbipay.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetPaymentScheduleType ( )

The schedule type for the payment. This defaults to one_time_payment.

The schedule type for the payment. This defaults to one_time_payment.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetReturnCode ( )

The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.

The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetStatus ( )

The status of the payment.

The status of the payment.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.GetUrl ( )

This URL fetches the details of payment.

This URL fetches the details of payment.

Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.RetrievedBy ( string  requestor,
string  requestorType 
)

RetrievedBy Method.

Parameters
RequestorThe Requestor is of type string
RequestorTypeThe RequestorType is of type string
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.ToAccount ( CustomerAccount  customerAccount)

ToAccount Method.

Parameters
CustomerAccountThe CustomerAccount is of type CustomerAccount
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.Update ( InvocationContext  invocation_context,
string  live_mode = null,
string  api_end_point = null 
)

Update Method.

Parameters
invocationContextThe invocationContext is of type InvocationContext
liveModeThe liveMode is of type String
Exceptions
OrbipayApiExceptionThe only Exception that is thrown in Exceptional case
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.UpdatedBy ( string  requestor,
string  requestorType 
)

UpdatedBy Method.

Parameters
RequestorThe Requestor is of type string
RequestorTypeThe RequestorType is of type string
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.VideChannel ( string  channel)

VideChannel Method.

Parameters
ChannelThe Channel is of type string
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.WithCustomFields ( Dictionary< string, string >  customFields)

WithCustomFields Method.

Parameters
CustomFieldsThe CustomFields is of type Dictionary<string, string>
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.WithDetails ( string  paymentAmountType,
string  amount,
string  paymentDate,
string  paymentRequestDate,
string  cardCvvNumber 
)

WithDetails Method.

Parameters
PaymentAmountTypeThe PaymentAmountType is of type string
AmountThe Amount is of type string
PaymentDateThe PaymentDate is of type string
PaymentRequestDateThe PaymentRequestDate is of type string
CardCvvNumberThe CardCvvNumber is of type string
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.WithFee ( Fee  fee)

WithFee Method.

Parameters
FeeThe Fee is of type Fee
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.WithMemo ( string  comments)

WithMemo Method.

Parameters
CommentsThe Comments is of type string
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.WithPaymentNotificationEmail ( string  paymentNotificationEmail)

WithPaymentNotificationEmail Method.

Parameters
PaymentNotificationEmailThe PaymentNotificationEmail is of type string
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.WithReference ( string  paymentReference)

WithReference Method.

Parameters
PaymentReferenceThe PaymentReference is of type string
Returns
Payment
Payment Orbipay.PaymentsApi.Client.Wrappers.Payment.WithStatus ( string  status)

WithStatus Method.

Parameters
StatusThe Status is of type string
Returns
Payment

Member Data Documentation

string Orbipay.PaymentsApi.Client.Wrappers.Payment.Amount

The amount being paid. In case the payment_amount_type is &#39;discounted_amount&#39;, &#39;penalty_amount&#39; or &#39;other&#39;, the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

The amount being paid. In case the payment_amount_type is &#39;discounted_amount&#39;, &#39;penalty_amount&#39; or &#39;other&#39;, the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

AuditInfo Orbipay.PaymentsApi.Client.Wrappers.Payment.AuditInfo
string Orbipay.PaymentsApi.Client.Wrappers.Payment.CardCvvNumber

This is never returned by Orbipay. This needs to be passed to Orbipay when making or editing a payment with a card funding account.

This is never returned by Orbipay. This needs to be passed to Orbipay when making or editing a payment with a card funding account.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.Comments

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo.

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.ConfirmationNumber

The confirmation number or reference provided to the customer for the payment.

The confirmation number or reference provided to the customer for the payment.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.CurrencyCode3d

The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD.

The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD.

Customer Orbipay.PaymentsApi.Client.Wrappers.Payment.Customer
CustomerAccount Orbipay.PaymentsApi.Client.Wrappers.Payment.CustomerAccount
Dictionary<string, string> Orbipay.PaymentsApi.Client.Wrappers.Payment.CustomFields

The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests.

The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay would reject custom fields that are not pre-configured. Please contact <a href &#x3D; &quot;mailto: suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com&quot;>suppo.nosp@m.rt@b.nosp@m.iller.nosp@m.paym.nosp@m.ents..nosp@m.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.Deleted

The status of payment which says whether the payment is deleted or not

The status of payment which says whether the payment is deleted or not

string Orbipay.PaymentsApi.Client.Wrappers.Payment.ExpectedPaymentSettlementDate

The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Fee Orbipay.PaymentsApi.Client.Wrappers.Payment.Fee

Fee

FundingAccount Orbipay.PaymentsApi.Client.Wrappers.Payment.FundingAccount
string Orbipay.PaymentsApi.Client.Wrappers.Payment.Id

The unique identifier assigned by Orbipay to the payment.

The unique identifier assigned by Orbipay to the payment.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.ID_CUSTOMER

The unique identifier assigned by EBPP to the customer.

The unique identifier assigned by EBPP to the customer.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.ID_PAYMENT

The unique identifier assigned by EBPP to the payment.

The unique identifier assigned by EBPP to the payment.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.PaymentAmountType

The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.

The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.PaymentDate

The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.PaymentEntryDate

The date on which the payment is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

The date on which the payment is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.PaymentMethod

The fulfillment method for the payment.

The fulfillment method for the payment.

PaymentNetworkResponse Orbipay.PaymentsApi.Client.Wrappers.Payment.PaymentNetworkResponse
string Orbipay.PaymentsApi.Client.Wrappers.Payment.PaymentNotificationEmail

The email address to which notifications for the payment will be sent. The notifications will be sent to the customer&#39;s email in case this is not provided.

The email address to which notifications for the payment will be sent. The notifications will be sent to the customer&#39;s email in case this is not provided.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.PaymentReference

The unique identifier in the client system for the payment.

The unique identifier in the client system for the payment.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.PaymentRequestDate

The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it.

The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.PaymentReturnDate

The date on which the ACH returns is received by Orbipay.

The date on which the ACH returns is received by Orbipay.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.PaymentScheduleType

The schedule type for the payment. This defaults to one_time_payment.

The schedule type for the payment. This defaults to one_time_payment.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.ReturnCode

The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.

The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.Status

The status of the payment.

The status of the payment.

string Orbipay.PaymentsApi.Client.Wrappers.Payment.Url

This URL fetches the details of payment.

This URL fetches the details of payment.


The documentation for this class was generated from the following file: