PayID

Mobile Pay, in the Netherlands also known as “06-Betalen”, is a feature of SurePay’s PayID service. PayID is a premium add-on service to the IBAN-Name Check and allows for an API request containing a PayID (like a mobile phone number or email address) and a name, instead of an IBAN and a name. This way customers don’t need to enter the payee’s IBAN when making an online money transfer.

  • Thanks to PayID, banks can offer an enhanced experience to customers by connecting the mobile contact list to the banking app. This offers customers (the payer) a convenient way to select PayIDs (e.g. mobile phone number or email address) of the beneficiary account holder (the payee).

  • If a PayID and a name were provided in the request and the matching result of the name and the IBAN corresponding with the PayID was ‘Matching’ or ‘Mistype’, then the IBAN of the account holder will be returned. This IBAN can then be used by the bank to initiate the actual money transfer. We call this feature Mobile Pay as it is an easy way to make an online payment using the mobile phone. In the future, more features will be added to PayID.

This page only describes the PayID / Mobile Pay feature in the consuming API (It does not describe the PayID CRUD API specification). For more information about PayID / Mobile Pay (“06-Betalen”), please contact info@surepay.nl.

To gain access to SurePay's add-ons, customers are required to notify service@surepay.nl first. This notification is essential to enable access to these additional features.

Request

When using PayID, the otherwise mandatory IBAN can be replaced with a PayID of the type EMAIL or PHONE.

  • Name
    accountId
    Type
    object
    Tag(s)
    Mandatory
    Description

    Object used to send the account information in the request.

    • Name
      value
      Type
      string
      Tag(s)
      Description

      The identifier of the account to be checked. Use the following types in combination with a matching or mistype as resultType in order to receive back the IBAN.

      • EMAIL a valid Email address. e.g. info@surepay.nl
      • PHONE a valid phone number. e.g. 003164068877
    • Name
      type
      Type
      enum
      Tag(s)
      Description

      FOr a succesful PayID, this enumm needs to be either EMAIL or PHONE.

  • Name
    name
    Type
    string
    Tag(s)
    Mandatory
    Description

    Name of the account holder. Mandatory when the account type is “IBAN”, “PHONE” or “EMAIL”.

    • Max. 70 characters.

Response

In the response, the iban information will be included as an additional string in the account object, without any other changes in the rest of the response. This additional string will only be returned when the account is found in the list of payID's, and when the 'resultType' is MATCHING or MISTYPE.

  • Name
    result
    Type
    object
    Tag(s)
    Always returned
    Description
    • Name
      account
      Type
      object
      Tag(s)
      Always returned
      Description

      Object holding the following bank account details.

      • Only returned if the resultType is a MATCH, MISTYPE or NOT_MATCHING.
      • Name
        iban
        Type
        string
        Tag(s)
        Description

        Contains the IBAN of the requested account.

        • Format: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

Request

POST
/v2/account/check/banks
    {
        "accountId": {
            "value": "manuel_a@gmail.com",
            "type": "EMAIL"
        },
        "name": "Manuel Alberti"
    }

Response code 200

    {
        "result": {
            "account": {
            "accountHolderType": "NP",
            "status": "ACTIVE",
            "iban": "NL45SRPY0000000002"
            },
            "resultType": "MATCHING"
        }
    }
Previous