This request links a Payment Profile to a customer.
Click here to learn more about this request
This request links a previously created Payment Profile to a customer account in LMS. Note the following when linking a payment profile to a customer account:
Linking a payment profile to a customer profile has some pre-requisites. Before linking a payment profile, ensure the following has been completed:
- Generate OBO token ↗
- Create a bank account ↗ or Create a bank card ↗ to create a payment profile and generate a token
When a payment profile is linked to a customer account in LoanPro, the payment profile's information is stored within the PaymentAccounts object. This object is nested within the Customers entity, and it holds the profile's token as well as its type and status.
The 200 response from this request does not return the ID of the newly linked payment profile. To pull the ID of the payment profile, send a GET Payment Profiles request.
How do payment profiles work within LoanPro and Secure Payments?
Payment profiles are created and tokenized within Secure Payments to ensure data security and PCI compliance. Secure Payments never stores these tokens, but they're used to link a payment profile to customer profile in LoanPro.
Once a payment profile is linked to a customer, LoanPro generates an ID that represents the payment profile. As payments are made on an account, the ID of the payment profile is sent to Secure Payments to move funds using the bank account or bank card associated with the customer.
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:
- Database – Customer Payment Profile Information (payment_account_entity)
- Database – Customer Main Table (customer_entity)
Sample Payloads
{
"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..."
}
}
]
}
}