White Label Wallet/
B2B Customer Care/
Verification

B2B Customer Care - Verification

DOCS

Last updated: Aug 15th, 6:19am

authenticateCustomerLogin

Returns success when the username and password entered when a user logs in matches the username and password stored for this user.

POST URL/b2b-gateway/customers/security/login

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.
password Required String
The password used when this customer logs in.
username Required String
The username (email) the customer uses to log in.

Response

Attribute Description
b2bResponse Required B2bResponse
Identifies the response from the B2B Gateway.
numberOfQuestionsToAnswer Required Integer
The total number of questions that must be answered to verify the customer’s identify as set during onboarding for this Issuing Partner. 10 char.
questionDetails Optional QuestionDetail
Indicates the expected questions and whether this security question is required or optional. May be multiple questions and their details.
customerUri Required String
The unique identifier of a registered mobile wallet user.

authenticateCustomerMFA

Verifies that the customer MFA (Multi-Factor Authentication) questions in the request are the questions that are expected for this customer.

POST URL/b2b-gateway/customers/security/authenticate/mfa

The customer’s MFA questions are obtained using retrieveCustomerMFAQuestions. A successful response means the questions and answers were matched for this customer. A failure response means the questions and answers were not correct for this customer.

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.
questionAnswers Required Object
The list of QuestionAnswer objects used to verify that the correct customer is accessed.

Response

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

authenticateRecoveryCode

Verifies that the recovery code sent to reset a forgotten or expired password or passcode is authentic. 

    1POST /b2b-gateway/customers/security/recovery/authenticate

    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 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.
    recoveryType Required Enum
    The reason for which the credential needs to be reset. Valid values are:
    FORGOT_PASSWORD
    FORGOT_PASSCODE
    EXPIRED_PASSWORD
    recoveryCode Required String
    The unique reset authorization code obtained in the retrieveRecoveryCode response.

    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.

    completeApplicationVerification

    PUT URL/b2b-gateway/customers/security/appverification

    Used to manually send the verification code that is usually automatically generated by retrieveApplicationVerificationCode as part of a verification process.

    This code ensures that the application being added or linked to a new device did exist on the original device. This method enables a customer care professional to complete an existing application verification that is outstanding.

    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.
    verificationCode Required String
    A generated code used to match this email with the user.

    Response

    Attribute Description
    b2bResponse Required B2bResponse
    Identifies the response from the B2B Gateway.
    customerUri Required String
    Unique identifier of the register mobile wallet user.
    deviceUri Required String
    The unique identifier of the device where this card is stored.
    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.
    questionDetails Optional QuestionDetail
    Indicates the question and whether this security question is required or optional.

    completeApplicationVerificationWithMFA

    Used to manually send the answer to the MFA question that is usually automatically generated by retrieveApplicationVerificationCode as part of a verification process.

    PUT URL/b2b-gateway/customers/security/appverification/mfa

    This process ensures that the application being added or linked to a new device did exist on the original device. This method enables a customer care professional to complete an existing application verification that is outstanding.

    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.
    customerUri Required String
    The unique identifier of a registered mobile wallet user.
    deviceUri Required String
    The unique identifier of the device that registered this application.
    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.
    questionAnswers Required Object
    The list of QuestionAnswer objects used to verify that the correct customer is accessed.

    Response

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

    completeEmailVerification

    Used to manually send the verification code that is usually automatically generated by retrieveEmailVerificationCode as part of an email verification to ensure that the email exists.

    PUT URL/b2b-gateway/customers/security/emailverification

    This method enables a customer care professional to complete an existing email verification that is outstanding.

    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.
    verificationCode Required String
    A generated code used to match this email with the user.

    Response

    Attribute Description
    b2bResponse Required B2bResponse
    Identifies the response from the B2B Gateway.
    customerUri Required String
    Unique identifier of the register mobile wallet user.
    questionDetails Optional QuestionDetail
    Indicates the question and whether this security question is required or optional.

    completeEmailVerificationWithMFA

    Used to complete the email verification generated by retrieveEmailVerificationCode to ensure that the email exists. 

      1PUT /b2b-gateway/customers/security/emailverification/mfa

      Only one MFA question is used in this scenario. This method enables a customer care professional to complete an existing email verification that is still outstanding.

      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.
      customerUri Required String
      The unique identifier of a registered mobile wallet user.
      questionAnswers Required Object
      The list of QuestionAnswer objects used to verify that the correct customer is accessed.

      Response

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

      retrieveApplicationVerificationCode

      POST URL/b2b-gateway/customers/security/appverification

      Requests the recovery code used when verifying an application ID to ensure that the application supplied when a new device was added or linked did exist on the previous device.

      This method allows a customer care professional to initiate the verification process when a new device is added or linked.

      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 that registered this application.
      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.

      Response

      Attribute Description
      b2bResponse Required B2bResponse
      Identifies the response from the B2B Gateway.
      verificationCode Required String
      The code used to verify that this is the correct email address for this user.
      validUntildate Required dateTime
      The date on which this verification code will become invalid.

      retrieveCustomerMFAQuestions

      POST URL/b2b-gateway/customers/security/mfa/search

      Retrieves the set of MFA questions for this customer.

      MFAenabled must be set to TRUE during onboarding for this method to have an effect.

      If the retrieveAllQuestions setting was set to TRUE during onboarding, all MFA questions from the Issuing Partner are returned.

      If retrieveAllQuestions was set to FALSE during onboarding, only the questions that the customer answered are returned.

      If this customer’s MFA questions have been updated, only the questions specified in that update are available for retrieval.

      See updateCustomerMFAQuestions for more information.

      Request

      Attribute Description
      b2bResponse Required B2bResponse
      Identifies the response from the B2B Gateway.
      customerUri Contextual String
      The unique identifier of a registered mobile wallet user. Only required when calling customer endpoint.
      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.
      operationType Optional Enum
      Used to restrict the request to the MFA questions that have been defined for a specific type of operation. Valid values are:
      USER_REGISTRATION
      DEVICE_REGISTRATION
      USER_LOGIN
      DEVICE_LOGIN
      PASSCODE_RESET
      PASSWORD_RESET

      Currently only USER_REGISTRATION is supported.

      Response

      Attribute Description
      b2bResponse Required B2bResponse
      Identifies the response from the B2B Gateway.
      mfaEnabled Required Boolean
      Indicates if this Issuing Partner has turned on the requirement to ask MFA security questions to verify the user’s identify.
      numberOfQuestionsToAnswer Required Integer
      The total number of questions that must be answered to verify the customer’s identify. 10 char.
      questionDetails Optional QuestionDetail
      Indicates the question and whether this security question is required or optional.

      retrieveEmailVerificationCode

      POST URL/b2b-gateway/customers/security/emailverification

      Requests the recovery code that was used to verify that the email address that was supplied when resetting the passcode or password actually exists.

      See updateCustomerInfo for information about resending an email verification.

      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.

      Response

      Attribute Description
      b2bResponse Required B2bResponse
      Identifies the response from the B2B Gateway.
      verificationCode Required String
      The code used to verify that this is the correct email address for this user.
      validUntildate Required dateTime
      The date on which this verification code will become invalid.

      retrieveIINDetails

      POST URL/b2b-gateway/partners/iin/details

      Returns the accountTypeUri and the networkTypeUri based on an specific Issuer Identification Number (IIN) for a particular Issuing Partner.

      Request

      Attribute Description
      b2bRequest Required B2bRequest
      Identifies the request to the B2B Gateway.
      partnerUri Required String
      The unique identifier of the WLW partner under which the issuer is registered.
      issuingPartnerUri Required String
      The unique identifier of the WLW partner that issued the mobile payments app for which the wallet is registered.
      iin Required String
      The Issuer Identification Number (IIN) that identifies a particular issuing institution. Used as the first six digits on cards issued by this entity.

      Response

      Attribute Description
      b2bResponse Required B2bResponse
      Identifies the response from the B2B Gateway.
      partnerUri Required String
      The unique identifier of the WLW partner under which the issuer is registered.
      issuingPartnerUri Required String
      The unique identifier of the WLW partner that issued the mobile payments app for which the wallet is registered.
      iin Required String
      The Issuer Identification Number (IIN) that identifies a particular institution that issued the card. Used as the first six digits on the card.
      accountTypeUri Required String
      Unique identifier for the type of account.
      networkTypeUri Required String
      Unique identifier for the network being used.

      retrieveMFAQuestions

      Retrieves the list of available MFA questions that this Issuing Partner has defined as secondary identification values.

      POST URL/b2b-gateway/partners/security/mfa/search

      MFA enabled must be set to TRUE during onboarding for this method to be effective.

      If retrieveAllQuestions is set to TRUE, this method returns all questions defined by this IssuingPartner.

      If retrieveAllQuestions is set to FALSE, this method returns a random set of questions from the pool of available questions for this Issuing Partner. The numberOfQuestionsToAnswer onboarding setting determines how many of the available questions are returned.

      Request

      Attribute Description
      b2bRequest Required B2bRequest
      Identifies the request to the B2B Gateway.
      customerUri Contextual String
      The unique identifier of a registered mobile wallet user.

      Only required when calling customer endpoint.
      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.
      operationType Optional Enum
      Used to restrict the request to the MFA questions that have been defined for a specific type of operation. Valid values are:
      USER_REGISTRATION
      DEVICE_REGISTRATION
      USER_LOGIN
      DEVICE_LOGIN
      PASSCODE_RESET
      PASSWORD_RESET

      Currently only USER_REGISTRATION is supported.

      Response

      Attribute Description
      b2bResponse Required B2bResponse
      Identifies the response from the B2B Gateway.
      mfaEnabled Required Boolean
      Indicates if this Issuing Partner has turned on the requirement to ask MFA security questions to verify the user’s identify. Valid values are:
      TRUE - MFA questions are required
      FALSE - MFA questions are not required
      numberOfQuestionsToAnswer Required Integer
      The total number of questions that must be answered to verify the customer’s identify. 10 char.
      questionDetails Optional QuestionDetail
      Indicates the question and whether this security question is optional or required.

      retrieveRecoveryCode

      Requests generation of a unique code to authorize a one-time login credential reset.

      POST URL/b2b-gateway/customers/security/recovery

      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 for which the wallet is registered.
      partnerUri Required String
      The unique identifier of the WLW partner under which the issuer is registered.
      recoveryType Required Enum
      The reason for which the credential needs to be reset. Valid values include:
      FORGOT_PASSWORD
      FORGOT_PASSCODE
      EXPIRED_PASSWORD

      Response

      Attribute Description
      b2bResponse Required B2bResponse
      Identifies the response from the B2B Gateway.
      recoveryCode Required String
      An authorization string generated by the B2B service for the purpose of validating a login credential reset request for a particular wallet.

      SubmitAVSVerification

      POST URL/b2b-gateway/customers/wallet/verification#avs

      Verifies the ownership of an account by asking for the most recent deposits made in the account.

      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.
      customerUri Required String
      The unique identifier of a registered mobile wallet user.
      paymentAccountTypeUri Required String
      Unique identifier for the type of account.
      paymentNetworkTypeUri Required String
      Unique identifier for the network being used.
      paymentAccountUri Required String (may be null)
      The unique identifier of a card in the customer’s mobile wallet.
      doubleDeposit Required DoubleDeposit
      Defines two values for the most recent deposits made in this account as a way to verify that the user is the actual owner of the account. For example:
      "firstAmount" ; 0.75
      "secondAmount" : 0.25
      cardDetails Required CardDetails
      Set of key/value pairs used to add information about the account.

      Response

      Attribute Description
      paymentResponse Required PaymentResponse
      Extends the B2BResponse to add a payment status.
      verificationType Optional Enum
      Indicates the type of response. Valid values are:
      SIMPLE_AUTH
      SIMPLE_BALANCE_REQUEST
      BIN_NUMBER
      DOUBLE_DEPOSIT
      NO_VALIDATION

      submitPostVerification

      Verifies the ownership of an account by asking for the most recent deposits made in the account.

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

      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.
      customerUri Required String
      The unique identifier of a registered mobile wallet user.
      paymentAccountTypeUri Required String
      Unique identifier for the type of account.
      paymentNetworkTypeUri Required String
      Unique identifier for the network being used.
      paymentAccountUri Required String
      The unique identifier of a card in the customer’s mobile wallet. (may be null).
      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.
      doubleDeposit Required DoubleDeposit
      Defines two values for the most recent deposits made in this account as a way to verify that the user is the actual owner of the account. For example:
      "firstAmount" ; 0.75
      "secondAmount" : 0.25
      additionalData Required AdditionalData
      Key/value pairs used to add information about the account.

      Response

      Attribute Description
      paymentResponse Required PaymentResponse
      Extends the B2bResponse to add a payment status.
      verificationType Optional Enum
      Indicates the type of response. Valid values are:
      SIMPLE_AUTH
      SIMPLE_BALANCE_REQUEST
      BIN_NUMBER
      DOUBLE_DEPOSIT
      NO_VALIDATION

      updateCustomerMFAQuestions

      Changes the security questions and answers that the specified customer will use to verify that the correct user account is being accessed.

      PUT URL/b2b-gateway/customers/security/mfa

      The number of questions and answers sent with the updateCustomerMFAQuestionRequest must match the number of questions that the IssuingPartner requires to be answered. Even if you want to update only one question/answer, all required. Questions/answers must be sent when updating.

      Also, only the questions sent with the update request are retained. Once the MFA questions have been updated, any other questions that may have been stored for this customer to use as verification of identity are no longer available.

      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.
      questionsAnswers Required Object
      The list of QuestionAnswer used to verify that the correct customer is accessed.

      Response

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

      If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more