As a PCI level 1 platform we put our focus on the security of all of users and our clients users - that is why we separated all payment related services to a stand alone service to give you easy access to the secured information you need to present.

  • DeleteStoredPaymentMethod

    This service call allows to delete payment method which was stored earlier

    Request - Filters

    Parameter Mandatory Type Description
    pmid No int ID of the payment method which has to be deleted

    Response - Parameters

    Parameter Type Description
    d (root element) boolean Defines whether payment method was deleted successfully

    Examples

    Request

    {
      "pmid": int
    }

    Response

    {
      "d": boolean
    }
  • GetBillingAddresses

    This method allows to get all billing addresses for currently logged in user

    Request - Filters

    Parameter Mandatory Type Description
    This method has an empty body as it doesn't require any input parameters. It takes user's credentials token from the request's header automatically and this way detects billing addresses for which user have to be returned. Check Headers topic to get more info on how to add credentials token to request's headers.

    Response - Parameters

    As a response this method returns an array which contains objects with info about currently logged in user's billing addresses. Each object includes parameters represented in the table below.

    Parameter Type Description
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string Country ISO
    PostalCode No string Postal code
    StateIso No string State ISO

    Examples

    Request

    
        

    Response

    {
      "d": [
        {
          "AddressLine1": "string",
          "AddressLine2": "string",
          "City": "string",
          "CountryIso": "string",
          "PostalCode": "string",
          "StateIso": "string"
        },
        ...
      ]
    }
  • GetStaticData

    This service is designed to provide full list of payment methods' groups (credit card, wallet, etc.) and types (Visa, MasterCard, etc.)

    Request - Filters

    Parameter Mandatory Type Description
    This method has an empty body as it doesn't require any input parameters. It takes user's credentials token from the request's header automatically and this way detects payment methods' static data for which user has to be returned. Check Headers topic to get more info on how to add credentials token to request's headers.

    Response - Parameters

    Parameter Type Description
    PaymentMethodGroups Array Contains the list of payment methods' groups. Each object in the list has three fields (Icon, Key, Name). Check detailed fields' descriptions below
    Icon string Payment method group's icon
    Key string Payment method group's ID
    Name string Payment method group's name
    PaymentMethods Array Contains the list of payment methods' types. Each object in the list has nine fields (Icon, Key, Name, GroupKey, HasExpirationDate, Value1Caption, Value1ValidationRegex, Value2Caption, Value2ValidationRegex). Check detailed fields' descriptions below
    Icon string Payment method type's icon
    Key string Payment method type's ID
    Name string Payment method type's name
    GroupKey string ID of the payment method group which this payment method type belongs to
    HasExpirationDate boolean Defines whether payment method type has expiration date
    Value1Caption string *TBD*
    Value1ValidationRegex string *TBD*
    Value2Caption string *TBD*
    Value2ValidationRegex string *TBD*

    Examples

    Request

    
        

    Response

    {
      "d": {
        "PaymentMethodGroups": [
          {
            "Icon": "string",
            "Key": "string",
            "Name": "string"
          },
          ...
        ],
        "PaymentMethods": [
          {
            "Icon": "string",
            "Key": "string",
            "Name": "string",
            "GroupKey": "string",
            "HasExpirationDate": boolean,
            "Value1Caption": "string",
            "Value1ValidationRegex": "string",
            "Value2Caption": "string",
            "Value2ValidationRegex": "string"
          },
          ...
        ]
      }
    }
  • GetStoredPaymentMethod

    This service call allows to get exact payment method's data

    Request - Filters

    Parameter Mandatory Type Description
    pmid No int ID of the payment method which data has to be loaded

    Response - Parameters

    Parameter Type Description
    AccountValue1 No string Account number of the payment method (e.g. card number)
    AccountValue2 No string *TBD*
    BillingAddress No This block contains info about payment methods' billing address
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string Country ISO
    PostalCode No string Postal code
    StateIso No string State ISO
    Display No string Payment method's display name
    ExpirationDate No dateTime Payment method's expiration date
    ID No int ID of the payment method
    Icon No string Icon for the payment method
    IsDefault No boolean Defines whether this payment method is marked as default
    IssuerCountryIsoCode No string *TBD*
    Last4Digits No string Last 4 digits of the payment methods' number
    OwnerName No string Payment method's owner name
    PaymentMethodGroupKey No string ID of the group which the payment method belongs to
    PaymentMethodKey No string ID of the type which the payment method belongs to
    Title No string Payment method's title

    Examples

    Request

    {
      "pmid": int
    }

    Response

    {
      "d": {
        "AccountValue1": "string",
        "AccountValue2": "string",
        "BillingAddress": {
          "AddressLine1": "string",
          "AddressLine2": "string",
          "City": "string",
          "CountryIso": "string",
          "PostalCode": "string",
          "StateIso": "string"
        },
        "Display": "string",
        "ExpirationDate": dateTime,
        "ID": int,
        "Icon": "string",
        "IsDefault": boolean,
        "IssuerCountryIsoCode": "string",
        "Last4Digits": "string",
        "OwnerName": "string",
        "PaymentMethodGroupKey": "string",
        "PaymentMethodKey": "string",
        "Title": "string"
      }
    }
  • GetStoredPaymentMethods

    This method allows to get all payment methods for currently logged in user

    Request - Filters

    Parameter Mandatory Type Description
    This method has an empty body as it doesn't require any input parameters. It takes user's credentials token from the request's header automatically and this way detects payment methods for which user have to be returned. Check Headers topic to get more info on how to add credentials token to request's headers.

    Response - Parameters

    As a response this method returns an array which contains objects with info about currently logged in user's payment methods. Each object includes parameters represented in the table below.

    Parameter Type Description
    AccountValue1 No string Account number of the payment method (e.g. card number)
    AccountValue2 No string *TBD*
    BillingAddress No This block contains info about payment methods' billing address
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string Country ISO
    PostalCode No string Postal code
    StateIso No string State ISO
    Display No string Payment method's display name
    ExpirationDate No dateTime Payment method's expiration date
    ID No int ID of the payment method
    Icon No string Icon for the payment method
    IsDefault No boolean Defines whether this payment method is marked as default
    IssuerCountryIsoCode No string *TBD*
    Last4Digits No string Last 4 digits of the payment methods' number
    OwnerName No string Payment method's owner name
    PaymentMethodGroupKey No string ID of the group which the payment method belongs to
    PaymentMethodKey No string ID of the type which the payment method belongs to
    Title No string Payment method's title

    Examples

    Request

    
        

    Response

    {
      "d": [
        {
          "AccountValue1": "string",
          "AccountValue2": "string",
          "BillingAddress": {
            "AddressLine1": "string",
            "AddressLine2": "string",
            "City": "string",
            "CountryIso": "string",
            "PostalCode": "string",
            "StateIso": "string"
          },
          "Display": "string",
          "ExpirationDate": dateTime,
          "ID": int,
          "Icon": "string",
          "IsDefault": boolean,
          "IssuerCountryIsoCode": "string",
          "Last4Digits": "string",
          "OwnerName": "string",
          "PaymentMethodGroupKey": "string",
          "PaymentMethodKey": "string",
          "Title": "string"
        },
        ...
      ]
    }
  • LinkPaymentMethod

    *TBD*

    Request - Filters

    Parameter Mandatory Type Description
    data No This block contains requests' data
    AccountValue1 No string Account number (e.g. card number) of the payment method which has to be linked
    DateOfBirth No dateTime Date of birth of the owner of the payment method which has to be linked
    PersonalNumber No string Personal number of the owner of the payment method which has to be linked (SSN/ ID etc)
    PhoneNumber No string Phone of the owner of the payment method which has to be linked

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message

    Examples

    Request

    {
      "data": {
        "AccountValue1": "string",
        "DateOfBirth": dateTime,
        "PersonalNumber": "string",
        "PhoneNumber": "string"
      }
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string"
      }
    }
  • LoadPaymentMethod

    This service is used to "Top Up" a MasterCard prepaid card using one of our 3rd party providers.

    Request - Filters

    Parameter Mandatory Type Description
    data No This block contains requests' data
    Amount No decimal Amount which has to be loaded to the payment method
    CurrencyIso No string Currency ISO with which the amount has to be loaded
    PaymentMethodID No int ID of the payment method to which the amount has to be loaded
    PinCode No string Currently logged in user's PIN code
    ReferenceCode No string The reference code for the deposit

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message

    Examples

    Request

    {
      "data": {
        "Amount": decimal,
        "CurrencyIso": "string",
        "PaymentMethodID": int,
        "PinCode": "string",
        "ReferenceCode": "string"
      }
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string"
      }
    }
  • RequestPhysicalPaymentMethod

    *TBD*

    Request - Filters

    Parameter Mandatory Type Description
    data No This block contains requests' data
    Address No This block contains info about *TBD*
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string Country ISO
    PostalCode No string Postal code
    StateIso No string State ISO
    ProviderID No string *TBD*

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message

    Examples

    Request

    {
      "data": {
        "Address": {
          "AddressLine1": "string",
          "AddressLine2": "string",
          "City": "string",
          "CountryIso": "string",
          "PostalCode": "string",
          "StateIso": "string"
        },
        "ProviderID": "string"
      }
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string"
      }
    }
  • StorePaymentMethod

    This service call allows to create new or update existing payment method for currently logged in user

    Request - Filters

    Parameter Mandatory Type Description
    methodData No This block contains info about the payment method which has to be saved
    AccountValue1 No string Account number of the payment method (e.g. card number)
    AccountValue2 No string *TBD*
    BillingAddress No This block contains info about payment methods' billing address
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string Country ISO
    PostalCode No string Postal code
    StateIso No string State ISO
    Display No string Payment method's display name
    ExpirationDate No dateTime Payment method's expiration date
    ID No int In case an existing payment method has to be updated, put ID of that payment method here
    In case a new payment method has to be added, set value 0 for this parameter
    Icon No string Icon for the payment method
    IsDefault No boolean Define whether this payment method is default. Only one default payment method per user's account can exist. In case the user already has a default payment method and tries to set another payment method as default, the payment method marked as default earlier will be set to non-default automatically by the system.
    IssuerCountryIsoCode No string *TBD*
    Last4Digits No string Last 4 digits of the payment methods' number
    OwnerName No string Payment method's owner name
    PaymentMethodGroupKey No string ID of the group which the payment method should belong to
    PaymentMethodKey No string ID of the type which the payment method should belong to
    Title No string Payment method's title

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message

    Examples

    Request

    {
      "methodData": {
        "AccountValue1": "string",
        "AccountValue2": "string",
        "BillingAddress": {
          "AddressLine1": "string",
          "AddressLine2": "string",
          "City": "string",
          "CountryIso": "string",
          "PostalCode": "string",
          "StateIso": "string"
        },
        "Display": "string",
        "ExpirationDate": dateTime,
        "ID": int,
        "Icon": "string",
        "IsDefault": boolean,
        "IssuerCountryIsoCode": "string",
        "Last4Digits": "string",
        "OwnerName": "string",
        "PaymentMethodGroupKey": "string",
        "PaymentMethodKey": "string",
        "Title": "string"
      }
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string"
      }
    }
  • StorePaymentMethods

    This service call allows to create new or update existing payment methods (several at once) for currently logged in user

    Request - Filters

    Parameter Mandatory Type Description
    data No Array Should contain objects with payment methods' data. Check such object's structure below.
    AccountValue1 No string Account number of the payment method (e.g. card number)
    AccountValue2 No string *TBD*
    BillingAddress No This block contains info about payment methods' billing address
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string Country ISO
    PostalCode No string Postal code
    StateIso No string State ISO
    Display No string Payment method's display name
    ExpirationDate No dateTime Payment method's expiration date
    ID No int In case an existing payment method has to be updated, put ID of that payment method here
    In case a new payment method has to be added, set value 0 for this parameter
    Icon No string Icon for the payment method
    IsDefault No boolean Define whether this payment method is default. Only one default payment method per user's account can exist. In case the user already has a default payment method and tries to set another payment method as default, the payment method marked as default earlier will be set to non-default automatically by the system.
    IssuerCountryIsoCode No string *TBD*
    Last4Digits No string Last 4 digits of the payment methods' number
    OwnerName No string Payment method's owner name
    PaymentMethodGroupKey No string ID of the group which the payment method should belong to
    PaymentMethodKey No string ID of the type which the payment method should belong to
    Title No string Payment method's title

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message
    RecordNumber int *TBD*
    RefNumbers ArrayOfstring *TBD*

    Examples

    Request

    {
      "data": [
        {
          "AccountValue1": "string",
          "AccountValue2": "string",
          "BillingAddress": {
            "AddressLine1": "string",
            "AddressLine2": "string",
            "City": "string",
            "CountryIso": "string",
            "PostalCode": "string",
            "StateIso": "string"
          },
          "Display": "string",
          "ExpirationDate": dateTime,
          "ID": int,
          "Icon": "string",
          "IsDefault": boolean,
          "IssuerCountryIsoCode": "string",
          "Last4Digits": "string",
          "OwnerName": "string",
          "PaymentMethodGroupKey": "string",
          "PaymentMethodKey": "string",
          "Title": "string"
        },
        ...
      ]
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string",
        "RecordNumber": int,
        "RefNumbers": [ArrayOfstring]
      }
    }