Page tree

Overview

This API call applies to both Armor Complete and Armor Anywhere users.

The Patch Payment Method API configures the primary payment method for an account.    

You can use the Get Payment Methods API to find the Payment Method ID.


Sample request

PATCH https://api.armor.com/paymentmethods/1

{
 "isPrimary": true
}

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/paymentmethods/{id}PATCH

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionFormatRequired or optionalExample

PaymentMethodId

(Route)
The ID of the payment method to set as the primary payment method.IntegerRequired1
IsPrimaryIndicate whether the payment method should be set as primaryBoolean valueRequiredtrue

Sample return

StatusResponse
200
true
400
"Invalid Request"