Merchant Account Information

POST https://api.fraudio.com/v1/merchants/account-information

Endpoint Overview

Our Merchant Account Information endpoint collects merchant meta data in an asynchronous manner. Collecting this data allows our system to use more comprehensive information about the merchant's business, improving our AI products.

The merchant account information can be sent either individually or in batch.

Request Parameters

Request parameters in JSON format

{
  "data": [
    {
      "merchant": "Fred & Freddy Sports Store",
      "walletid": "1121451",
      "mcccode": "5969",
      "registrationdate": 1646063615.143105,
      "acquirer": "Acquirer X",
      "acquirercountry": "056",
      "merchantip": "34.231.107.3",
      "kyclevel": "5",
      "kyclevelnorm": 0.5,
      "limitprofile": "5",
      "merchantcity": "London",
      "merchantcountry": "528",
      "merchantemail": "support@fraudio.com",
      "merchantpostalcode": "w1b 3hh",
      "merchantstatecode": "GA",
      "merchantstreetadress": "29 Ravenscroft, Covingham",
      "merchanturl": "www.foreverliving.com",
      "ocptenabled": true,
      "submerchant": "Shoestore X"
    }
  ]
}

Request parameters: Field Reference Table

Field	Data Type	Payment Fraud (Issuer)	Payment Fraud (Acquirer / Processor)	Merchant Fraud / AML	Description
merchant	String	Supplementary	Supplementary	Supplementary	The name or identifier of the merchant. This field uniquely identifies the merchant, and should not be confused with the MID. Any name or unique identifier is accepted.
mcccode	String	Supplementary	Supplementary	Supplementary	A Merchant Category Code (MCC) is a four-digit number listed for financial services. An MCC is used to classify a business by the types of goods or services it provides. Only ISO 18245 mcc codes are accepted.
acquirer	String	Supplementary	Supplementary	Supplementary	The acquirer is a financial institution with whom the merchant has a bank account.
acquirercountry	String	Supplementary	Supplementary	Supplementary	Countrycode of country where the acquirer is registered. Only ISO 3166-1 numeric country codes are accepted.
merchantcity	String	Supplementary	Supplementary	Supplementary	City where the merchant is registered. Without merchantip this field becomes important. Any city is accepted.
merchantcountry	String	Supplementary	Supplementary	Supplementary	Countrycode of country where the merchant is registered.Only ISO 3166-1 numeric country codes are accepted
merchantip	String	Supplementary	Supplementary	Supplementary	The IP address of the merchant refers to the IP address where the merchant is registered. It is important to distinguish between the acceptor IP and the merchant IP. The acceptor IP is the location of the merchant's server where the payment is received. Therefore, a merchant can have multiple acceptor IPs, but only one merchant IP.
merchantpostalcode	String	Supplementary	Supplementary	Supplementary	Postal code where the merchant is registered. Without merchantip this field becomes important. Any postal code is accepted.
merchantstatecode	String	Supplementary	Supplementary	Supplementary	State where the merchant is registered. Without merchantip this field becomes important. Any state code is accepted.
merchantstreetaddress	String	Supplementary	Supplementary	Supplementary	Street address where the merchant is registered. Without merchantip this field becomes important. Any street address is accepted.
mid	String	Supplementary	Supplementary	Supplementary	The MID, or Merchant ID, is a unique identifier assigned to a merchant by their payment processor. It's important to note that the MID does not uniquely identify the merchant, but rather it identifies the merchant's account. This is because a merchant can have multiple MIDs, as they may have separate merchant accounts for different aspects of their business.
submerchant	String	Supplementary	Supplementary	Supplementary	The name or identifier of the submerchant, which is a merchant that processes under a payment service provider or payment facilitator. These services use one merchant account to process the transactions of many sub-merchants, thereby eliminating the need for each sub-merchant to open and maintain a fully-fledged merchant account. Any name or unique identifier is accepted.
iso	String	n.a.	Supplementary	Supplementary	The full name of the Independent Sales Organisation (ISO) that accepts credit card payments for the merchant account that is in its portfolio.
isocountry	String	n.a.	Supplementary	Supplementary	The country of the ISO.
kyclevel	String	n.a.	Supplementary	Supplementary	The Know-Your-Customer level of the merchant. Any indication level is accepted.
kyclevelnorm	Double	n.a.	Supplementary	Supplementary	A normalized know-your-customer level of the merchant between 0 and 1, where 0 is a totally unknown and untrusted merchant and 1 is a fully known and absolutely trusted merchant.
limitprofile	String	n.a.	Supplementary	Supplementary	The limit profile of a merchant is a set of limits imposed on the daily/weekly/monthly transaction amounts. A low limit profile number denotes low limits on all transactions.
merchantemail	String	n.a.	Supplementary	Supplementary	The email address of the merchant.
merchantturnover	String	n.a.	Supplementary	Supplementary	Expected monthly turnover (auths and authcaptures) to be processed through the merchant’s account in euros.
merchanturl	String	n.a.	Supplementary	Supplementary	URL of merchant web site or page where transaction took place. Any URL is accepted.
ocptenabled	String	n.a.	Supplementary	Supplementary	Indicates if ocpt is enabled for this merchant. When ocpt is enabled, payout back to the cardholder is supported.
payfac	String	n.a.	Supplementary	Supplementary	The full name of the Payment Facilitator that has the merchant account in its portfolio.
payfaccountry	String	n.a.	Supplementary	Supplementary	The country of the Payment Facilitator.
registrationdate	Double	n.a.	Supplementary	Supplementary	The time UTC at which the merchant got registered. Only Unix Timestamps are accepted.
ubo	String	n.a.	Supplementary	Supplementary	The full name of the Ultimate Beneficial Owner (UBO). The UBO is the individual that is registered as the owner of the merchant account.
ubocountry	String	n.a.	Supplementary	Supplementary	Countrycode of country where the ubo is registered. Only ISO 3166-1 numeric country codes are accepted.
uboemail	String	n.a.	Supplementary	Supplementary	The email address of the ubo.
ubophonenumber	String	n.a.	Supplementary	Supplementary	The phone number of the ubo.
ubostreetaddress	String	n.a.	Supplementary	Supplementary	Street address where the ubo is registered. Without merchantip this field becomes important. Any street address is accepted.
walletid	String	n.a.	n.a.	Supplementary	External ID of the merchant wallet.

Response Parameters

Status Code	Status Message	Description	Schema
200	OK	Standard response for successful HTTP requests.	200 OK - Data Collection Response
4xx, 500, 501, 502, 503, 504	error	Various error messages for unsuccessful HTTP requests.	Problem response

Code samples

Shell

curl -X POST 'https://api.fraudio.com/v1/merchants/account-information' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data-raw '{"data":[{"merchant":"Fred & Freddy Sports Store","walletid":"1121451","mcccode":"5969","registrationdate":1646063615.143105,"acquirer":"Acquirer X","acquirercountry":"056","merchantip":"34.231.107.3","kyclevel":"5","kyclevelnorm":0.5,"limitprofile":"5","merchantcity":"London","merchantcountry":"528","merchantemail":"support@fraudio.com","merchantpostalcode":"w1b 3hh","merchantstatecode":"GA","merchantstreetadress":"29 Ravenscroft, Covingham","merchanturl":"www.foreverliving.com","ocptenabled":true}]}'

Python

import json
import os

import requests

merchant_account_information_endpoint = 'https://api.fraudio.com/v1/merchants/account-information'
access_token = os.environ['ACCESS_TOKEN']
headers = {'Authorization': f'Bearer {access_token}', 'Content-Type': 'application/json'}
merchant_account = {"data":[{"merchant":"Fred & Freddy Sports Store","walletid":"1121451","mcccode":"5969","registrationdate":1646063615.143105,"acquirer":"Acquirer X","acquirercountry":"056","merchantip":"34.231.107.3","kyclevel":"5","kyclevelnorm":0.5,"limitprofile":"5","merchantcity":"London","merchantcountry":"528","merchantemail":"support@fraudio.com","merchantpostalcode":"w1b 3hh","merchantstatecode":"GA","merchantstreetadress":"29 Ravenscroft, Covingham","merchanturl":"www.foreverliving.com","ocptenabled": True}]}
r = requests.post(merchant_account_information_endpoint, data=json.dumps(merchant_account), headers=headers)
print(r.json())

Java

package com.fraudio;

import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class MerchantsAccountInformation
{
    public static void main(String[] args) throws IOException, URISyntaxException, InterruptedException
    {
        String merchantAccountInformationEndpoint = "https://api.fraudio.com/v1/merchants/account-information";
        String accessToken = System.getenv("ACCESS_TOKEN");
        String merchantAccount = "{\"data\":[{\"merchant\":\"Fred & Freddy Sports Store\",\"walletid\":\"1121451\",\"mcccode\":\"5969\",\"registrationdate\":1646063615.143105,\"acquirer\":\"Acquirer X\",\"acquirercountry\":\"056\",\"merchantip\":\"34.231.107.3\",\"kyclevel\":\"5\",\"kyclevelnorm\":0.5,\"limitprofile\":\"5\",\"merchantcity\":\"London\",\"merchantcountry\":\"528\",\"merchantemail\":\"support@fraudio.com\",\"merchantpostalcode\":\"w1b 3hh\",\"merchantstatecode\":\"GA\",\"merchantstreetadress\":\"29 Ravenscroft, Covingham\",\"merchanturl\":\"www.foreverliving.com\",\"ocptenabled\":true}]}";
        HttpRequest request = HttpRequest.newBuilder()
            .uri(new URI(merchantAccountInformationEndpoint))
            .header("Authorization", String.format("Bearer %s", accessToken))
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(merchantAccount))
            .build();
        HttpClient client = HttpClient.newHttpClient();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        String responseBody = response.body();
        System.out.println("Response Code: " + response.statusCode() + "\nResponse Body: " + responseBody);
    }
}

Perl

use LWP::UserAgent;
use HTTP::Request::Common;

my $merchants_account_information_endpoint = 'https://api.fraudio.com/v1/merchants/account-information';
my $access_token = $ENV{"ACCESS_TOKEN"};
my $merchant_account = '{"data":[{"merchant":"Fred & Freddy Sports Store","walletid":"1121451","mcccode":"5969","registrationdate":1646063615.143105,"acquirer":"Acquirer X","acquirercountry":"056","merchantip":"34.231.107.3","kyclevel":"5","kyclevelnorm":0.5,"limitprofile":"5","merchantcity":"London","merchantcountry":"528","merchantemail":"support@fraudio.com","merchantpostalcode":"w1b 3hh","merchantstatecode":"GA","merchantstreetadress":"29 Ravenscroft, Covingham","merchanturl":"www.foreverliving.com","ocptenabled": true}]}';
my $req = HTTP::Request -> new(POST => $merchants_account_information_endpoint);
$req -> header('Authorization' => "Bearer $access_token", "Content-Type" => "application/json");
$req -> content($merchant_account);
my $ua = LWP::UserAgent -> new;
my $resp = $ua -> request($req);
my $message = $resp -> decoded_content;
print "Received reply: $message";

PHP

<?php
  $merchants_account_information_endpoint = 'https://api.fraudio.com/v1/merchants/account-information';
  $access_token = $_SERVER["ACCESS_TOKEN"];
  $merchant_account = '{"data":[{"merchant":"Fred & Freddy Sports Store","walletid":"1121451","mcccode":"5969","registrationdate":1646063615.143105,"acquirer":"Acquirer X","acquirercountry":"056","merchantip":"34.231.107.3","kyclevel":"5","kyclevelnorm":0.5,"limitprofile":"5","merchantcity":"London","merchantcountry":"528","merchantemail":"support@fraudio.com","merchantpostalcode":"w1b 3hh","merchantstatecode":"GA","merchantstreetadress":"29 Ravenscroft, Covingham","merchanturl":"www.foreverliving.com","ocptenabled": true}]}';
  $options = [
    'http' => [
        'header'  => "Authorization: Bearer $access_token" .
                     "Content-Type: application/json",
        'method'  => 'POST',
        'content' => $merchant_account
    ]
  ];
  $context  = stream_context_create($options);
  $result = file_get_contents($merchants_account_information_endpoint, false, $context);
  print $result;
?>