record_alternative_payment_m Guide

Last updated
Save as PDF

Records a payment transaction for a payment collected from an account holder without using Aria.

API Specification:	record_alternative_payment_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id> <reference_code> <payment_amount> <processor_id> <pay_method_type> <statement_no>

Error Codes

Error Code/Description	Associated Inputs
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id) Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no	<acct_no>, <client_acct_id>
1025: amount not positive Associated Inputs: amount, percent_amount Additional Comments: This error occurs when the percent amount is greater than 100.	<payment_amount>
4001: collection failed
4006: invalid pay method or alternate pay method Associated Inputs: alt_pay_method, pay_method_type, pay_method_type	<pay_method_type>
4028: Invalid processor ID	<processor_id>
4029: Invalid processor and pay method combination
4030: Duplicate Payment Reference Code
18003: statement could not be found
26010: Invalid billing group number Associated Inputs: billing_group_no	<billing_group_no>
26012: Invalid client-defined billing group ID. Associated Inputs: client_billing_group_id	<client_billing_group_id>

Additional Guidance

Input Fields

Field Name

Notes

<proc_payment_method_id>

Example: If you are using the Adyen payment gateway to process a payment made using SOFORT, after your customer enters bank details on the SOFORT website, pass values into these inputs as described below:

Pass 1 into the payment_auth_received field to indicate that you have received a successful authorization from Adyen for the SOFORT payment.
Pass the shopper reference code provided by Adyen into the proc_payment_method_id field.

<processor_id>

Allowable Values

Values	Description
16	Global Collect (to be deprecated)
29	Worldpay
34	Adyen
36	Worldline (formerly Ingenico)

<pay_method_type>

Allowable Values

Values	Description
30	Boleto
32	iDEAL
33	WebMoney
34	Yandex
35	PaySafeCard
36	SOFORT
38	ApplePay
39	PayPal Express Checkout
42	Klarna
43	Tokenized Klarna
46	Swish
47	Tokenized ApplePay

<allow_recurring>

Allowable Values

Values	Description
true	Use this payment method for subsequent recurring payments.
false	Do not use this payment method for subsequent recurring payments (default).

<payment_auth_received>

Allowable Values

Values	Description
0	Not received successfully
1	Received successfully

<primary_payment_method_ind>

Allowable Values

Values	Description
0	The billing group will be created in the account, but it will not set as the primary pay method to any billing group (default).
1	The billing group will be created as the primary pay method for the billing group associated with the statement number.