The PaymentAuthorization wrapper module.
Members
-
inner audit_info :AuditInfo
-
-
inner auth_amount :String
-
The amount being authorized.
-
inner captured_time :String
-
The date on which the payment authorization is captured in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000..
-
inner card_cvv_number :String
-
This is never returned by EBPP. This needs to be passed to EBPP 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 (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
-
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 EBPP. This defaults to USD.
-
inner custom_fields :Object
-
The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP 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 EBPP, would be accepted in the requests.
-
inner customer :Customer
-
-
inner customer_account :CustomerAccount
-
-
inner entry_time :String
-
The date on which the payment authorization created in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000.
-
inner funding_account :FundingAccount
-
-
inner id :String
-
The unique identifier assigned by EBPP to the payment authorization.
-
inner ID_AUTHORIZATION :String
-
The unique identifier assigned by EBPP to the payment authorization.
-
inner ID_CUSTOMER :String
-
The unique identifier assigned by EBPP to the customer.
-
inner payment_auth_reference :String
-
The unique identifier in the client system for the payment.
-
inner payment_method :String
-
The fulfillment method for the payment authorization.
-
inner payment_network_response :PaymentNetworkResponse
-
-
inner status :String
-
The status of the payment.
-
inner url :String
-
This URL fetches the details of payment authorization.
Methods
-
static constructFromObject(data, obj) → {module:wrappers/PaymentAuthorization}
-
Constructs a
PaymentAuthorizationfrom a plain JavaScript object, optionally creating a new instance. Copies all relevant properties fromdatatoobjif supplied or a new instance if not.Parameters:
Name Type Description dataObject The plain JavaScript object bearing properties of interest.
objmodule:wrappers/PaymentAuthorization Optional instance to populate.
-
forClient(client_key) → {module:wrappers/PaymentAuthorization}
-
Parameters:
Name Type Description client_keyString The client_key of PaymentAuthorization.
-
forCustomer(ID_CUSTOMER) → {module:wrappers/PaymentAuthorization}
-
Parameters:
Name Type Description ID_CUSTOMERString The ID_CUSTOMER of PaymentAuthorization.
-
fromAccount(funding_account) → {module:wrappers/PaymentAuthorization}
-
Parameters:
Name Type Description funding_accountFundingAccount The funding_account of PaymentAuthorization.
-
toAccount(customer_account) → {module:wrappers/PaymentAuthorization}
-
Parameters:
Name Type Description customer_accountCustomerAccount The customer_account of PaymentAuthorization.
-
videChannel(channel) → {module:wrappers/PaymentAuthorization}
-
Parameters:
Name Type Description channelString The channel of PaymentAuthorization.
-
withCustomFields(custom_fields) → {module:wrappers/PaymentAuthorization}
-
Parameters:
Name Type Description custom_fieldsObject The custom_fields of PaymentAuthorization.
-
withDetails(auth_amount, card_cvv_number) → {module:wrappers/PaymentAuthorization}
-
Parameters:
Name Type Description auth_amountString The auth_amount of PaymentAuthorization.
card_cvv_numberString The card_cvv_number of PaymentAuthorization.
-
withMemo(comments) → {module:wrappers/PaymentAuthorization}
-
Parameters:
Name Type Description commentsString The comments of PaymentAuthorization.
-
withReference(payment_auth_reference) → {module:wrappers/PaymentAuthorization}
-
Parameters:
Name Type Description payment_auth_referenceString The payment_auth_reference of PaymentAuthorization.