wrappers/Payment

The Payment wrapper module.

Members

inner amount :String

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

inner audit_info :AuditInfo

inner card_cvv_number :String

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

inner comments :String

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.

inner confirmation_number :String

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

inner currency_code3d :String

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.

inner custom_fields :Object

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 = "mailto: support@billerpayments.com">support@billerpayments.com 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.

inner customer :Customer

inner customer_account :CustomerAccount

inner deleted :String

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

inner expected_payment_settlement_date :String

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.

inner fee :Fee

inner funding_account :FundingAccount

inner id :String

The unique identifier assigned by Orbipay to the payment.

inner ID_CUSTOMER :String

The unique identifier assigned by EBPP to the customer.

inner ID_PAYMENT :String

The unique identifier assigned by EBPP to the payment.

inner payment_amount_type :String

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.

inner payment_date :String

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

inner payment_entry_date :String

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

inner payment_method :String

The fulfillment method for the payment.

inner payment_network_response :PaymentNetworkResponse

inner payment_notification_email :String

The email address of the customer to which payment notifications from EBPP will be sent. The notifications will be sent to customer email in case if this field is not present.

inner payment_reference :String

The unique identifier in the client system for the payment.

inner payment_request_date :String

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.

inner payment_return_date :String

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

inner payment_schedule_type :String

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

inner return_code :String

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

inner status :String

The status of the payment.

inner url :String

This URL fetches the details of payment.

Methods

static constructFromObject(data, obj) → {module:wrappers/Payment}

Constructs a Payment from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:wrappers/Payment

Optional instance to populate.

Returns:
module:wrappers/Payment -

The populated Payment instance.

forClient(client_key) → {module:wrappers/Payment}

Parameters:
Name Type Description
client_key String

The client_key of Payment.

Returns:
module:wrappers/Payment -

The instance of Payment.

forCustomer(ID_CUSTOMER) → {module:wrappers/Payment}

Parameters:
Name Type Description
ID_CUSTOMER String

The ID_CUSTOMER of Payment.

Returns:
module:wrappers/Payment -

The instance of Payment.

fromAccount(funding_account) → {module:wrappers/Payment}

Parameters:
Name Type Description
funding_account FundingAccount

The funding_account of Payment.

Returns:
module:wrappers/Payment -

The instance of Payment.

toAccount(customer_account) → {module:wrappers/Payment}

Parameters:
Name Type Description
customer_account CustomerAccount

The customer_account of Payment.

Returns:
module:wrappers/Payment -

The instance of Payment.

videChannel(channel) → {module:wrappers/Payment}

Parameters:
Name Type Description
channel String

The channel of Payment.

Returns:
module:wrappers/Payment -

The instance of Payment.

withCustomFields(custom_fields) → {module:wrappers/Payment}

Parameters:
Name Type Description
custom_fields Object

The custom_fields of Payment.

Returns:
module:wrappers/Payment -

The instance of Payment.

withDetails(payment_amount_type, amount, payment_date, payment_request_date, card_cvv_number) → {module:wrappers/Payment}

Parameters:
Name Type Description
payment_amount_type String

The payment_amount_type of Payment.

amount String

The amount of Payment.

payment_date String

The payment_date of Payment.

payment_request_date String

The payment_request_date of Payment.

card_cvv_number String

The card_cvv_number of Payment.

Returns:
module:wrappers/Payment -

The instance of Payment.

withFee(fee) → {module:wrappers/Payment}

Parameters:
Name Type Description
fee Fee

The fee of Payment.

Returns:
module:wrappers/Payment -

The instance of Payment.

withMemo(comments) → {module:wrappers/Payment}

Parameters:
Name Type Description
comments String

The comments of Payment.

Returns:
module:wrappers/Payment -

The instance of Payment.

withPaymentNotificationEmail(payment_notification_email) → {module:wrappers/Payment}

Parameters:
Name Type Description
payment_notification_email String

The payment_notification_email of Payment.

Returns:
module:wrappers/Payment -

The instance of Payment.

withReference(payment_reference) → {module:wrappers/Payment}

Parameters:
Name Type Description
payment_reference String

The payment_reference of Payment.

Returns:
module:wrappers/Payment -

The instance of Payment.

withStatus(status) → {module:wrappers/Payment}

Parameters:
Name Type Description
status String

The status of Payment.

Returns:
module:wrappers/Payment -

The instance of Payment.