Home > Tech Writers Hub > Knowledge Services Sandbox > Aria Crescendo APIs Bucket > record_alternative_payment_m


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

For information on error messages generated by this API, see record_alternative_payment_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  client_acct_id string 50 Client-defined account identifier.
required-icon.png reference_code string 32 This code provides a reference correlation to the external payment. This field must be unique for every payment submitted by the client.
required-icon.png payment_amount double 12 The amount of the payment to-be made against the outstanding account balance
required-icon.png processor_id long 3 The payment processor to use for managing the Alternate Payment Method (APM) defined by <pay_method_type>. 
Values Description
16 Global Collect (to be deprecated)
29 Worldpay
34 Adyen
36 Worldline (formerly Ingenico)
required-icon.png pay_method_type long 3 Payment method code.  
Values Description
30 Boleto
32 iDEAL
33 WebMoney
34 Yandex
35 PaySafeCard
38 ApplePay
39 PayPal Express Checkout
46 Swish
47 Tokenized ApplePay
required-icon.png statement_no long 32 The unique statement number that shall be used to identify the billing group.
  comments string 500 Additional explanatory text relating to this API call.
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  allow_recurring string 5 Specifies whether this payment method can be used for subsequent recurring payments.  
Values Description
true Use this payment method for subsequent recurring payments.
false Do not use this payment method for subsequent recurring payments (default).
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.
  payment_auth_received long 1

This signifies whether you have received a successful authorization from your payment gateway for an alternative payment method (examples: iDEAL, SOFORT). 

Values Description
0 Not received successfully
1 Received successfully
  proc_payment_method_id string 100

The unique identifier provided by your payment gateway that is used to distinguish between different alternative payment methods (examples: iDEAL, SOFORT). 

As an example, this can specify the unique shopper reference of the shopper account (Adyen account) created outside of Aria with which a given SOFORT/iDeal payment was made.

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.
  external_payment_payload string 5000 This input accepts the Apple pay encrypted payment payload. Using your payment processing certificate, we will decrypt the payload and store the token for future payments.
  primary_payment_method_ind long 1 Indicates the Apple pay billing record to be created as primary payment method for the billing group mapped in the passed statement number. Default is 0. If we pass 1, then the billing record will be created as the primary pay method for the billing group associated with the statement number. 

Allowable values for primary_payment_method_ind

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.
  billing_group_no long 22 The billing group number mapped against each master plan.
  client_billing_group_id string 100 Client-defined billing group id.

Output Arguments

Field Name Field Type Description
auth_no long The unique number for a given authorization.
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
Last modified


This page has no custom tags.


This page has no classifications.