B2B Customer Care - Customers

createCustomerInfo

Adds a new customer profile to the wallet.

POST URL/b2b-gateway/customers

Most of the "required" fields must be present in the call but can be null.

Only the following fields must be present in the call and populated:

customerUri
issuingPartnerUri
firstName
lastName
email
password
devicePIN

Request

Attribute Description
b2bRequest Required B2bRequest
Identifies the request to the B2B Gateway.
issuingPartnerUri Required String
The unique identifier of the Paydiant partner that issued the mobile payments app where the wallet is registered.
partnerUri Required String
The unique identifier of the Paydiant partner under which the issuer is registered.
firstName Required String
The wallet owner’s first name. This parameter must be used in conjunction with at least one other parameter.
lastName Required String
The wallet owner’s last name.
email Required String
username Required String
Customer’s email address. No longer used as a separate property. Currently must match email address.
password Required String
The password this mobile wallet uses to log into the wallet.
devicePIN Required String
The PIN used for this device.
address1 Required NCName
The number and street of the physical address of the acceptance location.
address2 Required NCName
Any secondary information about the position of the business within the street address, such as a suite number.
city Required NCName
The name of the city in which the acceptance location exists.
state Required NCName
A namespace value that identifies the US state in the postal address of an entity. 2 char.
zip Required String
The zip code of the registered address for the mobile app owner. 20 char.
country Required String
A value from the countryCode enum that identifies the country of the acceptance location’s physical address. 2 char.
phone Required String
The wallet owner’s primary phone number. 100 char,
deviceTypeUris Optional String
A list of unique identifiers that indicate whether a phone is an iOS or an Android phone. 100 char,
additionalData Optional AdditionalData
Data in sets of key/value pairs used for additional information about this customer.
questionsAnswers Optional QuestionAnswer
The list of objects used to verify that the correct customer is accessed.

Response

Attribute Description
b2bResponse Required B2bResponse
Identifies the response from the B2B Gateway.
customerUri Optional String
The unique identifier of a registered mobile wallet user.

deleteCustomer

Removes a customer account from the wallet.

POST URL/b2b-gateway/customers/delete

When a user account is deleted, the following information is deleted:

  • All user profile data associated with that user including user info, payment accounts, loyalty cards, gift cards, etc.
  • All payment accounts registered with that mobile wallet account.
  • All tenders.

Request

Attribute Description
b2bRequest Required B2bRequest
Identifies the request to the B2B Gateway.
customerUri Required String
The unique identifier of a registered mobile wallet user.
issuingPartnerUri Required String
The unique identifier of the Paydiant partner that issued the mobile payments app where the wallet is registered.
partnerUri Required String
The unique identifier of the Paydiant partner under which the issuer is registered.

Response

Attribute Description
b2bResponse Required B2bResponse
Identifies the response from the B2B Gateway.

IsCustomerExists

Verifies that a customer profile has been created in the system.

POST URL/b2b-gateway/customers/isexists

Request

Attribute Description
b2bRequest Required B2bRequest
Identifies the request to the B2B Gateway.
customerUri Optional String
The unique identifier of a registered mobile wallet user.
issuingPartnerUri Required String
The unique identifier of the Paydiant partner that issued the mobile payments app where the wallet is registered.
partnerUri Required String
The unique identifier of the Paydiant partner under which the issuer is registered.
email Required String
The email address (username) under which the wallet is registered.

Response

Attribute Description
b2bResponse Required B2bResponse
Identifies the response from the B2B Gateway.
customerUri Required String
The unique identifier of a registered mobile wallet user.
issuingPartnerUri Required String
The unique identifier of the Paydiant partner that issued the mobile payments app where the wallet is registered.
partnerUri Required String
The unique identifier of the Paydiant partner under which the issuer is registered.
customerExists Required Boolean
Indicates if the customer is present in the system using True or False.

retrieveCustomersByUri

Uses the customerUri, issuingPartnerUri, and partnerUri to return details about the customer.

POST URL/b2b-gateway/customers/lookup/multiple/uri

Request

Attribute Description
b2bRequest Required B2bRequest
Identifies the request to the B2B Gateway.
customerUri Required String
The unique identifier of a registered mobile wallet user.
issuingPartnerUri Required String
The unique identifier of the Paydiant partner that issued the mobile payments app where the wallet is registered.
partnerUri Required String
The unique identifier of the Paydiant partner under which the issuer is registered.

Response

Attribute Description
b2bResponse Required B2bResponse
Identifies the response from the B2B Gateway.
devices Optional String
List of the deviceUris for all devices this customer has registered.
additionalCustomerIngformation Optional AdditionalCustomerInformation
Metadata that stores for this customer in key/value pairs.
active Required Boolean
Whether the mobile wallet is functional or in a suspended state. See locked for more information. Valid values are:
True - Active
False- Deactivated
address1 Required String
The first line of the wallet owner’s street address.
address2 Optional String
An optional second line to describe the address of the wallet owner.
city Required String
The city of the wallet owner’s address.
country Required String
The country of the wallet owner’s address.
createDate Required dateTime
The date in UNIX timestamp when the customer account was created.
customerUri Required String
The unique identifier of a registered mobile wallet user.
email Required String
The email address (username) under which the wallet is registered.
username Required String
The email for the user.
firstName Required String
The wallet owner’s first name. This parameter must be used in conjunction with at least one other parameter.
issuingPartnerUri Required String
The unique identifier of the Paydiant partner that issued the mobile payments app for which the wallet is registered.
lastName Required String
The wallet owner’s last name.
modifiedTime Required dateTime
The time in UNIX timestamp when the account was last modified.
partnerUri Required String
The unique identifier of the Paydiant partner under which the issuer is registered.
phone Required String
The phone number used to contact the wallet owner.
state Required String
The postal state code for the state for the wallet user’s address. 2 char,
zip Required String
The postal zip code for the wallet user.
issuingPartnerName Required String
The common name used to depict the issuing partner.
customerId Optional String
A unique number that identifies this customer.

retrieveCustomerLookUpInfo

Looks up customers with devices from all wallets.

POST URL/b2b-gateway/customers/lookup

Only wallets that are accessible to the logged-in user can be returned. This method executes a query against the issuer’s registered wallet account and returns the user profile object if a match is found.

Request

Although all of the search parameters are optional, the request must populate at least one of the search parameters and, in the case of firstName, at least one other parameter.

Attribute Description
b2bRequest Required B2bRequest
Identifies the request to the B2B Gateway.
issuingPartnerUri Required String
The unique identifier of the Paydiant partner that issued the mobile payments app where the wallet is registered.
partnerUri Required String
The unique identifier of the Paydiant partner under which the issuer is registered.
email Optional String
The email address (username) under which the wallet is registered.
firstName Optional String
The wallet owner’s first name. This parameter must be used in conjunction with at least one other parameter.
lastName Optional String
The wallet owner’s last name.
phone Optional String
The wallet owner’s primary phone number. 100 char,
externalId Optional String
ID supplied by a system external to Paydiant to identify this customer.
customerID Optional String
Used as a simplified way to uniquely identify a customer. customerId can be passed instead of customerURI in certain parts of the transaction.

Response

Attribute Description
b2bResponse Required B2bResponse
Identifies the response from the B2B Gateway.
customerLookupInfo Optional Object
If the lookup produces a match, this property populates the values found in CustomerLookUpInfo

retrieveCustomersEmailByUri

Uses the customerUri, issuingPartnerUri, and partnerUri to return the email address for customers.

POST URL/b2b-gateway/customers/lookup/multiple/uri

Request

Attribute Description
b2bRequest Required B2bRequest
Identifies the request to the B2B Gateway.
customerUri Required String
The unique identifier of a registered mobile wallet user.
issuingPartnerUri Required String
The unique identifier of the Paydiant partner that issued the mobile payments app where the wallet is registered.
partnerUri Required String
The unique identifier of the Paydiant partner under which the issuer is registered.

Response

Attribute Description
b2bResponse Required B2bResponse
Identifies the response from the B2B Gateway.
customers Optional CustomerEmailInfo
Customer email information.

retrieveCustomerTransactionsHistory

Used to lookup the transaction history of a specific customer.

POST URL/b2b-gateway/customers/transactions/search

This method returns a maximum of 200 transactions.

Request

Attribute Description
queryRequest Required queryRequest
Extends the B2bRequest to add query parameters.
customerUri Required String
The unique identifier of a registered mobile wallet user.
issuingPartnerUri Required String
The unique identifier of the Paydiant partner that issued the mobile payments app for which the wallet is registered.
partnerUri Required String
The identifier of the top-level Paydiant partner.

You can also use the following optional search parameters:

Attribute Description
merchantPartnerUri Optional String
The unique identifier for the merchant when the merchant is different from the Acceptance Partner.
acceptancePartnerUri Optional String
The unique identifier of the merchant that is registered to process mobile wallet transactions with Paydiant.
acceptanceLocationUri Optional String
The unique identifier assigned by Paydiant to a particular acceptance location.
transactionStatuses Optional Enum
Identifies the current TransactionStatus for the transactions being retrieved.

Response

Attribute Description
b2bResponse Required B2bResponse
Identifies the response from the B2B Gateway.
customerTransactions Optional CustomerTransactionInfo
Defines details about the retrieved transaction.

retrieveCustomerWalletInfo

Returns information about the customer’s wallet.

GET URL/b2b-gateway/customers/wallet

Includes all payment tenders or accounts that a customer has registered with their mobile wallet account.

Request

Attribute Description
b2bRequest Required B2bRequest
Identifies the request to the B2B Gateway.
customerUri Required String
The unique identifier of a registered mobile wallet user.
issuingPartnerUri Required String
The unique identifier of the Paydiant partner that issued the mobile payments app for which the wallet is registered.
partnerUri Required String
The unique identifier of the Paydiant partner under which the issuer is registered.
paymentAccountTypeUri Required String
Unique identifier for the type of account.
paymentNetworkTypeUri Required String
Unique identifier for the network being used.

Response

Attribute Description
b2bResponse Required B2bResponse
Identifies the response from the B2B Gateway.
customerCards Optional CustomerCardInfo
Provides some details of the cards used in the transaction.
customerOffers Optional CustomerOfferInfo
Details the offers that are part of this transaction.

updateCustomerInfo

Used to adjust the customer’s wallet information.

PUT URL/b2b-gateway/customers

Mandatory field values for this customer must be sent with the request. For optional fields, if the current customer information values are not sent with the request, the values are reset to null. To intentionally set any of the demographic information to null, use NULL_VALUE. Card must be updateable and verified.

Email verification: If a customer email address is changed, an email is sent to the new address which must be verified before the user can log in using that new address. A notification email is also sent to the previous email indicating that this email has been changed.

An ERR103 on this request may indicate that the card is not associated with the customerURI in the transaction.

Request

Attribute Description
b2bRequest Required B2bRequest
Identifies the request to the B2B Gateway.
customerUri Required String
The unique identifier of a registered mobile wallet user.
issuingPartnerUri Required String
The unique identifier of the Paydiant partner that issued the mobile payments app for which the wallet is registered.
partnerUri Required String
The unique identifier of the Paydiant partner under which the issuer is registered.
firstName Required String
The wallet owner’s first name. This parameter must be used in conjunction with at least one other parameter.
lastName Required String
The wallet owner’s last name.
email Required String
The email address (username) under which the wallet is registered.
username Required String
No longer used as a separate property. Currently must match email address.
address1 Required NCName
The number and street of the physical address of the acceptance location.

Important: If the following optional demographic fields, are not sent with the request, their values are set to NULL

Attribute Description
address2 Optional NCName
Any secondary information about the position of the business within the street address, such as a suite number.
city Optional NCName
The name of the city in which the acceptance location exists.
state Optional NCName
A namespace value that identifies the US state in the postal address of an entity. 2 char.
country Optional String
A value from the countryCode enum that identifies the country of the acceptance location’s physical address. 2 char For example:
US - United States
CA - Canada
phone Optional String
A namespace value that specifies the phone contact number for the acceptance location.
zip Optional String
The zip code of the registered address for the mobile app owner. 20 char.
additionalData Optional AdditionalData
Uses key/value pairs to add custom metadata.
devices Optional String
List of the deviceUri for all devices this customer has registered.

Response

Attribute Description
b2bResponse Required B2bResponse
Identifies the response from the B2B Gateway.

updateCustomerActivation

Resets the value of the active attribute associated with the mobile wallet account to the value specified in the request'

PUT URL/b2b-gateway/customers/activation
Attribute Description
b2bRequest Required B2bRequest
Identifies the request to the B2B Gateway.
customerUri Required String
The unique identifier of a registered mobile wallet user.
issuingPartnerUri Required String
The unique identifier of the Paydiant partner that issued the mobile payments app for which the wallet is registered.
partnerUri Required String
The unique identifier of the Paydiant partner under which the issuer is registered.
activate Required Boolean
To make the wallet account active, set this value to TRUE. To deactivate the wallet acount, set this value to FALSE.

Response

Attribute Description
b2bResponse Required B2bResponse
Identifies the response from the B2B Gateway.