Pay Now Payment Method Validation

You can validate the postal code (ZIP file code) in subscription and group payment method address data for the Braintree Payment Gateway Provider.

Using the SubMan APIs, you must identify the subscription or group, the PostalCode to validate, and, optionally, the ResourceId of the payment method. If you do not specify a payment method, the default system payment method is used if set. The response indicates if the provided postal code matches the postal code on record for the payment method.

To validate the payment method, use the following REST APIs:
  • PUT /subscription/{SearchTerm:.+}/validate_payment_method
  • PUT /group/{SearchTerm:.+}/validate_payment_method
Configure the input with the validation information as shown here:
<MtxPaymentMethodValidationData>
            <AddressData>
                <MtxAddressData>
                    <FirstName>{String}</FirstName>
                    <LastName>{String}</LastName>
                    <Company>{String}</Company>
                    <StreetAddress>{String}</StreetAddress>
                    <ExtendedAddress>{String}</ExtendedAddress>
                    <Locality>{String}</Locality>
                    <Region>{String}</Region>
                    <PostalCode>{String}</PostalCode>
                    <CountryCode>{String}</CountryCode>
                </MtxAddressData>
            </AddressData>
        </MtxPaymentMethodValidationData>
Note: Although the request contains a complete MtxAddressData object, only the PostalCode field is validated. All other MtxAddressData fields are ignored.

If the validation is successful, the Result value in the response (MtxResponse) is success. If validation fails, the response includes the error code PAYMENT_METHOD_VALIDATION_FAILED.

For more information about the payment APIs, see the discussion about Pay Now APIs.