Our Payee Vault API resource is a collection of Platform API endpoints for securely storing and referencing payment details in the Qualpay Payee Vault.

Please note: This API resource is intended for a specific use case involving payments facilitators set up with and paid from an FBO account. It requires integration through the Qualpay product team. To use this resource, please contact Qualpay Support.

This page gives an overview of Payee Vault and the requests it supports. Subpages provide implementation guides for a few important Payee Vault requests. See Payee Vault in our API Reference for endpoints and details on all supported transactions.

Features

Our Payee Vault API resource supports the following features:

• Editable payee records - You can create a payee profile with only the payee's name and add other information later, when it's more convenient. Edit the information any time.
• Secure storage - All data is stored securely with Qualpay, a PCI DSS certified Level 1 service provider.

The resource supports several requests. We offer API reference for all supported requests and detailed implementation guides for some.

We have guides for the following API functions:

• Add a Payee - Creates a payee profile in the Payee Vault.
• Update a Payee Account - Updates the payment information in a profile.
• Get All Payees - Gets and filters all payee profiles of one merchant account.
• Delete A Payee - Deletes a payee profile.

See the Payee Vault API reference for the following additional functions supported by the API:

• Get by Payee ID - Gets a specified payee profile.
• Update a Payee Account - Updates the details of a payee account.