Add Payment Method

Add a payment method

POST https://apis.sandbox.flexshopper.com/v3/paymentMethods/add

Headers

Name	Type	Description
Authorization	string	Authorization token
customer-token	string	Customer's authentication token

Request Body

Name	Type	Required	Description
primary	boolean		Payment method primary status
label	string		Payment method label
ach	object		ACH payment method details. See "ACH Object"
token	object		Token payment method details. See "Token Object"

ACH Object

Name	Type	Required	Description
routing	string		Routing number
account	string		Account number
accountType	string		Account type, either 'checking' or 'savings'

Token Object

Name	Type	Required	Description
expirationDate	string	false	Card expiration date
cardType	string	true	Card type (american-express/visa/mastercard/discover)
lastFour	string	false	Last four digits
firstSix	string	false	First six digits
token	string, array	true	LPP token, or array of Gateway objects (see below)
billingZip	string	true	Billing zip code

Gateway Object

Name	Type	Required	Description
name	string	true	'clover' or 'loanpaymentpro'
token	string	true	The card token value

Examples

Request

{
  "primary": false,
  "label": "CreditCardTest",
  "token": {
    "expirationDate": "2025-09",
    "cardType": "visa",
    "lastFour": "0067",
    "token": "b219cb1d-669f-464a-a943-cf5c8f176653",
    "billingZip": "20146"
  }
}

Response

201 Created

400 Bad Request

{
    "error": {
        "statusCode": 400,
        "message": "\"primary\" is required"
    }
}

401 Unauthorized

{
    "error": {
        "statusCode": 401,
        "message": "Missing authentication"
    }
}