B2B Customer Care - Cards

addCustomerCard
deleteCustomerCardInfo
provisionCustomerCard
refreshCustomerCardBalances
retrieveCustomerCardInfo
retrieveSupportedTenderTypes
submitTransactionProcessingEvent
updateCustomerCardInfo

addCustomerCard

Adds a new customer card to the wallet.

POST URL/b2b-gateway/customers/cards

This method is used when WLW is the System of Record for the card. If an SSO connection is required, use provisionCustomerCard instead to add the card. To determine what information a card needs for its 'cardDetails' metadata, use retrieveSupportedTenderTypes.

Note: Adding a new customer card to a PLACH existing card results in the processor generating a new card number for the mobile wallet instance of the payment account. Be sure to handle this addition through the processor’s API.

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 WLW partner that issued the mobile payments app where the wallet is registered.
`partnerUri`	Required String The unique identifier of the WLW partner under which the issuer is registered.
`applicationId`	Optional String ID of an application used by this wallet. You can get the `appId` for this wallet from your Professional Services representative. If your application uses an `appId`, this field is required.
`cardDetails`	Required `CardDetails` Provides card details in a set of key/value pairs that add required information about the card.

Response

Attribute	Description
`paymentResponse`	Required `PaymentResponse` Extends the base `B2bResponse` to include a `PaymentStatus`.
`cardUri`	Required String The unique identifier of a card in the customer’s mobile wallet.
`verificationType`	Required String Indicates the type of response. Valid values are: `SIMPLE_AUTH` `SIMPLE_BALANCE_REQUEST` `BIN_NUMBER` `DOUBLE_DEPOSIT` `NO_VALIDATION`

deleteCustomerCardInfo

Used to delete a customer’s card information.

POST URL/b2b-gateway/customers/cards/delete

Note: When a customer card is deleted using this method, PLACH card data must also be deleted from the 3rd party database.

Use provisionCustomerCard to add a card when an SSO connection is required. Use retrieveSupportedTenderTypes to determine the information the cards need for the cardDetails metadata.

Adding a new customer card to a PLACH existing card results in the processor generating a new card number for the mobile wallet instance of the payment account. Be sure to handle this addition through the processor’s API.

Request

Attribute	Description
`b2bRequest`	Required `B2bRequest` Identifies the request to the B2B Gateway.
`cardUri`	Required String Unique identifier of the customer’s card.
`customerUri`	Required String The unique identifier of a registered mobile wallet user.
`issuingPartnerUri`	Required String The unique identifier of the WLW partner that issued the mobile payments app where the wallet is registered.
`partnerUri`	Required String The unique identifier of the WLW partner under which the issuer is registered.
`applicationId`	Optional String ID of an application used by this wallet. You can get the `appId` for this wallet from your Professional Services representative. If your application uses an `appId`, this field is required.

Response

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

provisionCustomerCard

Adds a new card through an SSO connection.

POST URL/b2b-gateway/customers/cards/provision

Adds a card when an SSO connection is required in order to add the card. Use retrieveSupportedTenderTypes to determine the information the card needs for the cardDetails metadata.

Note: Adding a new customer card to a PLACH existing card results in the processor generating a new card number for the mobile wallet instance of the payment account. Be sure to handle this addition through the processor’s API.

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 WLW partner that issued the mobile payments app where the wallet is registered.
`partnerUri`	Required String The unique identifier of the WLW 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.
`applicationId`	Optional String ID of an application used by this wallet. You can get the `appId` for this wallet from your Professional Services representative. If your application uses an `appId`, this field is required.
`cardDetails`	Required `CardDetails` Card details in a set of key/value pairs used to add information about the card. One or more elements must be provided.

Response

Attribute	Description
`paymentResponse`	Required `PaymentResponse` Extends the B2bResponse to add a payment status.
`cardUri`	Required String Unique identifier of the customer’s card.
`splitPaymentEnabled`	Optional Boolean Indicates if this card can manage partial payments as part of a split payment flow. Valid values are: `TRUE` - split payments are enabled. `FALSE` - split payments cannot be done on this card.
`cashBackEnabled`	Optional Boolean Indicates if this card can provide cash back. Valid values are: `TRUE` - this card can provide cash back. `FALSE` - this card does not allow cash back.
`cardUri`	Required String Unique identifier of the customer’s card.

refreshCustomerCardBalances

Returns the current balances in the wallet of a specific customer.

POST URL/b2b-gateway/customers/wallet/balances

Used to verify a customer balance.

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 WLW partner that issued the mobile payments app where the wallet is registered.
`partnerUri`	Required String The unique identifier of the WLW partner under which the issuer is registered.
`cardUris`	Optional String The unique identifiers for the cards to be refreshed.

Response

Attribute	Description
`b2bResponse`	Required `B2bResponse` Identifies the response from the B2B Gateway.
`accountBalances`	Optional `AccountBalance` The set of objects that define each account’s current balance.

retrieveCustomerCardInfo

Returns the information on a specific card (payment account).

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

Uses the customerUri or the paymentAccountUri to identify the card.

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 WLW partner that issued the mobile payments app where the wallet is registered.
`partnerUri`	Required String The unique identifier of the WLW partner under which the issuer is registered.
`paymentAccountUri`	Required String The unique identifier of a card in the customer’s mobile wallet (but may be null).
`applicationId`	Optional String ID of an application used by this wallet. You can get the `appId` for this wallet from your Professional Services representative. If your application uses an `appId`, this field is required.
`includeMetaData`	Required Boolen Indicates if the metadata associated with this card will be included in the return.
`deviceUri`	Optional String The unique identifier of the device where this card is stored.

Response

Attribute	Description
`paymentResponse`	Required `PaymentResponse` Extends the b2bResponse to add a payment status.
`cards`	Optional `Card` Instances of the `Card` object that define an individual card/payment account.
`includeMetaData`	Required Boolean Indicates if the metadata associated with this card will be included in the return. `TRUE` - Metadata is included `FALSE` - Do not include the metadata
`customerUri`	Required String The unique identifier of a registered mobile wallet user.
`paymentAccountUri`	Required String The unique identifier of a card in the customer’s mobile wallet.

retrieveSupportedTenderTypes

Returns a list of the types of tender available for this Issuing Partner and the metadata required for each one when adding a new card using addCustomerCard.

POST URL/b2b-gateway/partners/tendertypes/search

Request

Attribute	Description
`b2bRequest`	Required `B2bRequest` Identifies the request to the B2B Gateway.
`tenantUri`	Required String Unique identifier used to indicate this partner for single gateway tenancy.
`partnerUri`	Required String The unique identifier of the WLW partner under which the issuer is registered.

Note: The following attributes are Optional search criteria that can be used to narrow the search.

Attribute	Description
`paymentNetworkTypeUri`	Optional String Unique identifier that identifies the type of payment network for this account.
`paymentAccountTypeUri`	Optional String Unique identifier for the kind of account, for example, "Credit Card."
`provisioningSupportedOnly`	Optional Boolean Indicates if only the tender types that support provisioning are returned. These are account types that allow new payment account generation through the wallet. Valid values are: `TRUE` - include only tender types that support provisioning `FALSE` - tender types that do not support provisioning may also be returned
`applicationId`	Contextual String ID of an application used by this wallet. You can get the `appId` for this wallet from your Professional Services representative. If your application uses an `appId`, this field is Required.

Response

Attribute	Description
`b2bResponse`	Required `B2bResponse` Identifies the response from the B2B Gateway.
`tenderTypes`	Optional `TenderType` Provides the details about a particular tender type.

submitTransactionProcessingEvent

Used to dispatch notification events to be picked up by configured notification connectors that listen for these events and send emails.

POST URL/b2b-gateway/customers/transactions/events/process

Request

Attribute	Description
`b2bRequest`	Required `B2bRequest` Identifies the request to the B2B Gateway.
`issuingPartnerUri`	Required String The unique identifier of the WLW partner that issued the mobile payments app where the wallet is registered.
`partnerUri`	Required String The unique identifier of the WLW partner under which the issuer is registered.
`transactionProcessingEvent`	Required `TransactionProcessingEvent` Details of the event used to identify and send a notification.

Response

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

updateCustomerCardInfo

Used to update card metadata for tenders and accounts in a customer’s wallet.

PUT URL/b2b-gateway/customers/cards

This method works only when the Issuing partner has allowed cards to be updated.

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 WLW partner that issued the mobile payments app where the wallet is registered.
`partnerUri`	Required String The unique identifier of the WLW partner under which the issuer is registered.
`deviceUri`	Required String The unique identifier of the device where this card is stored.
`applicationId`	Required String ID of an application used by this wallet. You can get the `appId` for this wallet from your Professional Services representative. If your application uses an `appId`, this field is required.
`cardDetails`	Optional `CardDetails` Communicates additional information relevant to the outcome of the call as a set of key/value pairs.

Response

Attribute	Description
`paymentResponse`	Required `PaymentResponse` Extends the b2bResponse to add a payment status.
`cardUri`	Required String The unique identifier of a card in the customer’s mobile wallet.
`verificationType`	Required String Indicates the type of response. Valid values are: `SIMPLE_AUTH` `SIMPLE_BALANCE_REQUEST` `BIN_NUMBER` `DOUBLE_DEPOSIT` `NO_VALIDATION`