Get Payment Profile Information

This request pulls a customer's Payment Profile information.

General

A Payment Profile allows a customer to make payments on their accounts. Here's what you need to know about payment profiles:

  • The PaymentAccounts object holds payment profile information, and it's nested within the Customers entity.
  • 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 yourself until linking the payment profile to a customer in LMS.
  • When you pull payment profile information, you won't be able to view sensitive information.
  • Payment profiles can either be bank accounts or credit/debit cards.
  • Multiple payment profiles can be associated to a 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:

📘

Try It Instructions

Our pages often provide sample payload information so that you can try requests yourself. This request is ready for you—hit ‘Try It’ to send the request.

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!