Link Payment Profile to Customer

This request allows you to link a payment profile to a customer.

General

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

  • 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, so it's important to hold on to them yourself until linking the payment profile to a customer in LMS.
  • Payment profiles can either be bank accounts or credit/debit cards.

For more information, see our API – Create New Payment Profile Process article.

Database

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

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

🚧

Try It Instructions

In this example, we are linking a checking account to a customer within LMS.

Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is a bit different. You will need to update the title parameter if you'd like to try this request. You can do so by expanding the PaymentAccounts object and entering a new title.

But you can also take a look at our example responses to see an example of a 200 response.

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.

Language
Authentication
Click Try It! to start a request and see the response here!