B2B Customer Care 101

Which B2B calls can I use?

As an Issuing Partner, you can use only the B2B Customer Care API endpoints that match the configuration settings of your wallets:

  • Paydiant Configuration
    In this configuration, the Paydiant Platform is the system of record for the Issuer's wallet profiles. All changes to the wallets are managed internally by the Pyaidant system.
  • External Configuration
    The external configuration means the wallet data is managed in an external repository. In this case, Paydiant routes requests through an authorized 3rd-party connector to retrieve and update data in that system, such as an Identity Provider (IDP) for user profiles or a card management service for payment accounts.
  • Paydiant + IDP Configuration
    This is a hybrid confirguation where the profile data is managed by an external identity provider, but the login credentials are managed within the Paydiant system.

The following table lists which B2B Customer Care API calls are supported for each configuration. See B2B Endpoints by Configuration Type for a compilation of which endpoints are evailable in each configuration type.

Supported endpoints

B2B Endpoint Paydiant Configuration Paydiant + IDP Configuration External Configuration
addCustomerCard Yes No No
authenticateCustomerLogin Yes No No
authenticateCustomerMFA Yes Yes No
authenticateRecoveryCode Yes Yes No
completeApplicationVerification Yes Yes Yes
completeApplicationVerificationWithMFA Yes Yes Yes
completeEmailVerification Yes Yes Yes
completeEmailVerificationWithMFA Yes Yes Yes
createCustomerInfo Yes No No
deleteCustomer Yes No No
deleteCustomerCardInfo Yes No No
deleteCustomerDevice Yes Yes Yes
isCustomerExists Yes Yes No
processExternalActvity Yes No No
provisionCustomerCard No No Yes
queryActivities Yes No No
refreshCustomerCardBalances Yes Yes Yes
resetCustomerPasscode Yes Yes No
resetCustomerPassword Yes Yes No
retrieveApplicationVerificationCode Yes Yes Yes
retrieveCustomerByUri Yes No No
retrieveCustomerCardInfo Yes No No
retrieveCustomerCredentialsSpecification Yes Yes Yes
retrieveCustomerDevices Yes Yes Yes
retrieveCustomerLookupInfo Yes Yes Yes
retrieveCustomerMFAQuestions Yes Yes No
retrieveCustomersEmailByUri Yes Yes No
retrieveCustomerTransactionsHistory Yes Yes No
retrieveEmailVerificationCode Yes Yes Yes
retrieveMFAQuestions Yes Yes Yes
retrieveIssuingPartnerDeviceTypes Yes Yes Yes
submitAVSVerification Yes No No
submitPostVerification Yes No No
updateCustomerActivation Yes No No
updateCustomerCardInfo Yes No No
updateCustomerDeviceActivation Yes No No
updateCustomerInfo Yes No No
updateCustomerMFAQuestions Yes Yes No
updateCustomerPIN Yes Yes No
updateCustomerSecurityInfo Yes Yes No
updateExpiredCustomerPassword Yes Yes No

B2B endpoints by configuration type

This section consolidates the information about which endpoints are available depending on your Configuration type.

Paydiant configuration

The Paydiant configuration has access to almost all the B2B endpoints.

You can use all the listed endpoints except:

provisionCard

Paydiant + IDP configuration

This configuration type cannont perform certain actions that are instead managed by the IDP processing.

A Paydiant + IDP Configuration can use all the B2B Endpoints except:

  • addCustomerCard
  • authenticateCustomerLogin
  • createCustomerInfo
  • deleteCustomer
  • deleteCustomerCardInfo*
  • processExternalActivity
  • provisionCard
  • queryActivity
  • retrieveCustomerByUri
  • retrieveCustomerCardInfo
  • submityAVSVerification
  • updateCustomerActivation
  • updateCustomerCardInfo
  • updateCustomerDeviceActivation
  • updateCustomerINfo

External configuration

This configuration type has a limited set of endpoints since most of the required functions are handled by the External system.

An External Configuration type can use only:

  • completeApplicationVerification
  • completeApplicationVerificationWith MFA
  • completeEmailVerification
  • deleteCustomerDevice
  • provisionCustomerCard
  • refreshCustomerCardBalances
  • retrieveApplicationVerificationCode
  • retrieveCustomerCredentialsSpecification
  • retrieveCustomerDevices
  • retrieveCustomerLookupInfo
  • retrieveCustomerMFAQuestions
  • retrieveCustomerTransactionsHistory
  • retrieveEmailVerificationCode
  • retrieveIssuingPartnerDeviceTypes
  • retrieveMFAQuestions

B2B methods descriptions

The following list provides a brief description of each B2B endpoint available. See the B2B Customer Care API Guide for full descriptions and all attributes for each method.

addCustomerCard

Register a payment method in Paydiant PAM.

authenticateCustomerLogin

Check whether input username/password is correct for the registered user.

authenticateCustomerMFA

Check whether input MFA questions/responses are correct for the registered user.

authenticateRecoveryCode

Check that an input reset recovery code matches that generated for the registered user.

createCustomerInfo

Create a new mobile wallet profile in the Paydiant platform.

deleteCustomer

Permanently close a wallet account and remove it (including all profile data, payment and loyalty links) from the Paydiant system.

deleteCustomerCardInfo

Remove a payment account from the wallet and wipe all related data from the Paydiant system.

deleteCustomerDevice

Disassociate a mobile device from a mobile wallet.

completeApplicationVerification

Verify the validity of the application on a new device on behalf of the customer.

isCustomerExists

Verify that a customer has a profile in the Paydiant system.

processExternalActvity

Manually record loyalty activity associated with a qualified external action, such as a social media post, on behalf of a user.

queryActivities

Lookup loyalty activity history for a particular user or for all users for an issuing partner.

refreshCustomerCardBalances

Update the balance data for all registered payment accounts in the wallet.

resetCustomerPasscode

Update a user’s passcode (PIN) value.

resetCustomerPasscode

Update a user’s passcode (PIN) value.

resetCustomerPassword

Update a user’s password value.

retrieveApplicationVerificationCode

Obtain the code that verifies that an application is valid to link to a new device.

retrieveCustomerByUri

Get a user’s full profile by inputting the customerUri for that user.

retrieveCustomerCardInfo

Get the details for all payment accounts registered in the user’s wallet.

retrieveCustomerCredentialsSpecification

Get the issuer’s minimum requirements for password and passcode (PIN) values, such as upper and lower case, numbers, symbols, etc.

retrieveCustomerDevices

Get the list of devices linked to a user’s wallet account.

retrieveCustomerLookupInfo

When the customerUri is not available, look up a user’s profile based on email, last name, mobile number or external ID.

retrieveCustomerMFAQuestions

Get the set of questions for which the user has provided responses for use in secondary authentication.

retrieveCustomersEmailByUri

Get a user’s address by providing the customerUri, partnerUri, and issuingPartnerUri` values.

retrieveCustomerTransactionsHistory

Get the set of transactions recorded in the user’s history (up to a maximum of 200).

retrieveEmailVerificationCode

Obtain the code that verifies that the email address input by the user is accessible by that user.

retrieveIssuingPartnerDeviceTypes

Get the list of supported devices stipulated by the issuing partner.

retrieveMFAQuestions

Get the list of all possible secret questions and response criteria defined by the issuing partner for the purpose of secondary authentication.

retrieveRecoveryCode

Obtain the code that allows an expired or forgotten password or PIN to be reset.

submitAVSVerification

Submit double-deposit verification amounts on behalf of the user in order to verify account ownership and complete.

submitPostVerification

Submit double-deposit verification amounts on behalf of the user in order to verify account ownership and complete.

updateCustomerActivation

Edit the value of the wallet status for the user’s profile.

updateCustomerCardInfo

Edit payment account metadata, if permitted by the issuer.

updateCustomerDeviceActivation

Edit the value of the device activation status.

updateCustomerInfo

Supply new values for editable user profile properties.

updateCustomerMFAQuestions

Edit the user’s question selection and/or provided responses to the secondary authentication questions.

updateCustomerPIN

Submit a new passcode (PIN) value on behalf of the user.

updateCustomerSecurityInfo

Submit new values for password, passcode (PIN), and MFA questions/responses simultaneously.

updateExpiredCustomerPassword

Replace an expired password with an updated value on behalf of the user.

What's Next?

How do I complete the customer's task?

Feedback

Have feedback?

Let us know.