Link Payment Profile to Customer

General

This request links a payment profile created within Secure Payments to a customer in LMS. Here's what you need to know about linking payment profiles to customers:

The PaymentAccounts object holds payment profile information, and it's nested within the Customers entity. To link a payment profile to a customer, you send a payload to the Customers endpoint.
Payment profiles are always created via Secure Payments. Even when creating a payment profile in the LMS UI, you are actually creating it in Secure Payments via an iframe.
Payment profiles are tokenized when they're created for enhanced security. The token that is generated is used in LMS to reference the profile created in Secure Payments. Tokens are never saved in Secure Payments, so it's important to hold on to them until linking the payment profile to a customer in LMS.
Payment profiles can either be bank accounts or credit/debit cards.
You'll notice that your 200 response from this request will display all of the customer's linked payment profiles—not solely the one you created. If you're looking for the newly created payment profile ID, it will be the one with the highest ID. For example, if your customer has payment profile IDs of 1, 2, and 3, the newest payment profile is the one with the ID of 3.

For an example of how payment profiles are linked to customers within the UI, take a look at our Add a Payment Profile article.

Database

For information regarding payment profile database tables, see the following articles:

{
     "PaymentAccounts": {
          "results": [
               {
                    "active": 1,
                    "isPrimary": 0,
                    "isSecondary": 1,
                    "title": "Checking Account",
                    "type": "paymentAccount.type.checking",
                    "CheckingAccount": {
                         "accountType": "bankacct.type.checking",
                         "token": "QVFJREFIalVqRlk3bHJIVFJFWERTSFljS3R6..."
                    }
               }
          ]
     }
}

{
     "PaymentAccounts": {
          "results": [
               {
                    "active": 1,
                    "isPrimary": 0,
                    "isSecondary": 1,
                    "title": "Credit Card",
                    "type": "paymentAccount.type.credit",
                    "CreditCard": {
                    		"token": "QVFJREFIalVqRlk3bHJIVFJFWERTSFljS3R6..."
                    }
               }
          ]
     }
}

{
    "PaymentAccounts": {
        "results": [
            {
                "active": 1,
                "isPrimary": 1,
                "isSecondary": 0,
                "title": "Checking Account",
                "type": "paymentAccount.type.checking",
                "CheckingAccount": {
                    "accountType": "bankacct.type.checking",
                    "token": "QVFJREFIalVqRlk3bHJIVFJFWERTSFljS3R6..."
                }
            },
            {
                "active": 1,
                "isPrimary": 0,
                "isSecondary": 1,
                "title": "Credit Card",
                "type": "paymentAccount.type.credit",
                "CreditCard": {
                    "token": "QVFJREFIalVqRlk3bHJIVFJFWERTSFljS3R6..."
                }
            }
        ]
    }
}

🚧
Try It Instructions
Our pages often provide sample payload information so that you can try requests yourself. This request is a bit different.
We can’t provide sample values that will work for multiple users. But, if you’d like to see a sample of a 200 response, click the response examples located under the Try It button.
If you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.