Skip to main content

paymentMethod

/v2/private/purchase/aa/paymentMethod

Available Methods​

  • POST

POST /v2/private/purchase/aa/paymentMethod​

This endpoint is used to save the user's selected payment method in the American Amicable Purchase flow.

info

If credit is selected, an Authorize.net token will be generated and saved to the user under purchase.aa.authorizenet. The token is used to retrieve the payment form. Tokens will expire after 15 minutes, so a new one will need to be generated if the user comes back after an extended period of time.

Params​

ParamTypeDescription
paymentMethodString Enum - ['bank', 'credit']The user's selected payment method. Bank refers to ACH.
Example request body
body: {
  "paymentMethod": "bank"
}

Returns​

The entire user object.

Example return object with user.purchase
user: {
  "purchase": {
    "aa": {
        "appNumber": 1000542,
        "pricing": [
            {
                "product": "EZT",
                "coverage": 50000,
                "terms": [
                    {
                        "years": 10,
                        "price": 21.48,
                        "riders": [
                            {
                                "type": "CI",
                                "price": 4.94,
                                "included": false,
                                "coverage": 12500
                            }
                        ]
                    }
                ]
            },
        ],
        "transactionId": 11272,
        "paymentMethod": "bank"
        }
    },
}
info

For more detailed information about each value in purchase, please refer to the user model docs.