The Direct Post Payment Handler expects the form inputs listed in the chart below. Please note that before the payment handler can function without returning any errors, an account must have already been created using the create_acct_complete API, and an Aria session must be started using the set_session or set_session_auth API.
Expected Inputs
| Field Name | Field Type | Optional? | Expected Values | Comments |
|---|---|---|---|---|
| <formOfPayment> | radio | No |
CreditCard ACH Net0 Net10 Net15 Net30 Net45 Net60 |
The expected values should be options in radio button or dropdown menu format, being mutually‐exclusive. Please note that the client must be configured to accept such forms of payment. Note:
|
| <cc_no> | text | Yes | A valid credit card number | This is only required if CreditCard is selected as the <formOfPayment> option. |
| <cc_exp_mm> | drop-down | Yes | Numeric month (1-12) | This is only required if CreditCard is selected as the <formOfPayment> option. |
| <cc_exp_yyyy> | text | Yes | The 4-digit year | This is only required if CreditCard is selected as the <formOfPayment> option. |
| <cvv> | text | Yes | The 3-4 digit security number found on the back of credit cards | This is only required if CreditCard is selected as the <formOfPayment> option. |
| <bank_routing_num> | text | Yes | Valid 9‐digit bank routing number |
This is only required if ACH is selected as the <formOfPayment> option.
|
| <bank_acct_num> | text | Yes | Valid bank account number | This is only required if ACH is selected as the <formOfPayment> option. |
| <collection_amount> | text | Yes | Monetary units | This is only required if <do_one_time_collection> is set to 1. |
| <inSessionID> | hidden | No | A valid Aria session ID generated by set_session or set_session_auth | A session ID is a unique string that a Web assigned to a specific end‐ user for the duration of that users visit (session). |
| <mode> | hidden | No | A string matching the configuration set name "suffix" created for the Direct Post Handler | For example, if you named your configuration set “direct_post_reg”, then the value of hidden form field mode should be “reg." This tells the Direct Post Payment Handler which configuration set should be used. |
| <client_no> | hidden | No | An Aria-assigned client number | Every Aria client is assigned a unique ID number. |
| <aria_md> | hidden | Yes | Your chosen information such as descriptive data about your customers. | Example: vehicle make and model |
| The 6 fields listed below are used by some payment gateways for 3D Secure (3DS) authentication. Not all payment gateways support 3DS. The payment gateways documentation identifies payment gateways that support 3DS. Please contact your payment gateway representative for more information about which version of 3DS is supported and other details. | ||||
| <end_user_browser_color_depth> | hidden | Yes | Browser color depth in bits per pixel. You can obtain this by using the browser's screen.colorDepth property. Accepted values: 1, 4, 8, 15, 16, 24, 32 or 48 bit color depth. | |
| <end_user_browser_java_enabled_ind> | hidden | Yes | Boolean value indicating whether the customer's browser is able to execute Java. | |
| <end_user_browser_language> | hidden | Yes | Browser supported language (as defined in IETF BCP-Internet Engineering Task Force Best Current Practice 47). You can obtain this by using the browser's navigator.language property. | |
| <end_user_browser_screen_height> | hidden | Yes | Total height of the browser that was used for placing an online order. | |
| <end_user_browser_screen_width> | hidden | Yes | Total width of the browser that was used for placing an online order. | |
| <end_user_browser_timezone_offset_mins> | hidden | Yes | Difference between UTC (Universal Time Coordinated) time and the customer's browser local time, in minutes. | |
| Fields required to collect Direct Debit Payments are listed below. To collect a payment made using Direct Debit, pass in the fields identified below and complete the additional steps described in Use Direct Post to Collect Direct Debit Payments. | ||||
|
<bban>
OR
<iban>
|
text
text |
Yes
Yes |
Basic Bank Account Number. Identifier that uniquely distinguishes an individual account, at a specific financial institution, in a particular country.
International Bank Account Number.
|
|
| For both BBAN and IBAN payments, pass in these additional fields: | ||||
| <bank_check_digit> | text | Yes | Number provided by the customer's bank. Bank check digits enable a sanity check of the bank account number to confirm its integrity before submitting a transaction. | |
| <bank_country_cd> | text | Yes | Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. | |
| <bank_swift_cd> | text | Yes | SWIFT code is a standard format of Bank Identifier Codes (BIC). It consists of 8 or 11 alphanumeric characters. Only hyphens and spaces are allowed for formatting the SWIFT code. | |
| <mandate_id> | text | Yes | A mandate is provided by the customer to authorize you to collect a payment and to instruct the customer's bank to make that payment. | |
| <bank_id_cd> | text | Yes | Up to 10-digit numeric bank identifier code. Used in Europe. Only hyphens and spaces are allowed for formatting the bank ID code. | |
| <bank_branch_cd> | text | Yes | Up to 10-digit numeric bank branch code. Used in Europe. Only hyphens and spaces are allowed for formatting the bank branch code. | |
| For only BBAN payments, pass in these additional fields: | ||||
| <bank_name> | text | Yes | Name of the bank used for the payment. | |
| <bank_city> | text | Yes | City in which the bank used for the payment is located. | |
| End of fields required to collect Direct Debit payments | ||||