Home > Aria Crescendo Documentation > Aria Crescendo core api > update_payment_method_m Guide

update_payment_method_m Guide

Table of contents
No headers
API Specification: update_payment_method_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id> 
Error Messages: update_payment_method_m Error Messages

Additional Guidance:

Inputs passed to this API call will override any fraud options that you specified in your payment gateway, collection group, or Direct Post settings, unless stated otherwise below.

Input Fields

Field Name: Notes:
<payment_method_no>

The same pay method sequence number cannot be used for a primary and secondary payment method.

<cc_id> <cc_id> is sometimes a required field when using payment method 13, Tokenized Credit Card, as the <pay_method_type> field for certain payment processors as defined in the internal Aria processor pay methods table.
<cc_auth_amount>

To authorize a tokenized credit card:

  • For the Braintree payment gateway, complete the required Aria configuration fields.
  • For the Worldpay payment gateway, first add the client_acct_id to the account as described in the Worldpay configuration notes.

Do one of the following:

  • If the card has already been added to the account, pass in the <payment_method_no>; or
  • If the token was already generated outside of Aria, set the <pay_method_type> to 13 and pass in the <bill_agreement_id>; or
  • If you need to generate a token for the card, set the <pay_method_type> to 13 and pass in the credit card details.
  • Pass in the <cc_auth_amount> to be authorized.

Please contact your payment gateway representative for more information.

  • <alt_client_collection_acct_group_id>
  • <alt_collection_acct_group_no>
It is possible to have an account with more than one payment method with an agreement ID obtained outside of Aria with a collection group that is mapped with more than one billing group. When this input argument is used to pass a token outside Aria this API will validate the agreement ID against the collection group. When no collection group is passed as an input via API, then the agreement ID will be validated against the account level collection group. If there is no collection group at the account level, then the agreement ID is validated against the last processor mapped to that client.
<fraud_filter>

If you set this field to "0", then Aria will ignore all other fraud filtering fields.

If you set this field to "1", then Aria will apply the values that you specified in the other fraud filtering fields. However, if you pass "-1" into any fraud filtering field, Aria will ignore that field.

If you set this field to "2", then Aria will apply the values that you specified in the other fraud filtering fields.

<recurring_processing_model_ind>

Currently, for only the Vantiv payment gateway, the value in this field will automatically be set to 2 if your payment gateway or collection group configuration has the Send orderSource as recurring for all transactions option enabled.

Refer to your payment gateway documentation to see if this applies.

Please contact your payment gateway representative for more information.

<attempt_3d_secure>

This will manually trigger a 3DSecure check if the payment gateway/processor supports this feature.

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.