Merchant Login

  • Live URL : https://liveapi.paywallreporting.com/api/v3/merchant/user/login
  • Test URL : https://testapi.paywallreporting.com/api/v3/merchant/user/login

Post parameters

Parameter name Details Example Type Mandatory
email Email address of merchant user. [email protected] Char(128) ✔
password Password 12345 Char(32) ✔

Successful Response

{
    token : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudFVzZXJJZCI6MSwicm9sZSI6ImFkbWluIiwibWVyY2hhbnRJZCI6MSwic3ViTWVyY2hhbnRJZHMiOltdLCJ0aW1lc3RhbXAiOjE0NDQzODk4ODB9.zPxVu4fkRqIy1uG2fO3X2RbxiI4otK_HG7M4MMTB298",
    status : "APPROVED"
}

The parameter 'token' in response is important because token is required for all API requests.

Please bear in mind that you need to use this token in every API endpoint request as a header parameter.

Mandatory Header parameter per API request

Parameter name Details Example Type Mandatory
Authorization JWT token generated in merchant login. eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFu dFVzZXJJZCI6MSwicm9sZ SI6ImFkbWluIiw Text ✔

Token is valid for 10 minutes.

Merchant Detail

  • Live URL : https://liveapi.paywallreporting.com/api/v3/merchant/get
  • Test URL : https://testapi.paywallreporting.com/api/v3/merchant/get

Post parameters

Parameter name Details Example Type Mandatory
id The merchant identifier. 1 Int ✔

Successful Response

{
    status : "APPROVED", 
    message : "Approved", 
    merchant : {
        id : 3,
        parentId : null,
        name : "Dev-Merchant",
        3dStatus : "ALL",
        mcc : "6012",
        ipnUrl : "",
        apiKey : "b5c946997663e1356542fd966167bbae",
        cpgKey : null,
        type : "ECOM",
        descriptor : "descriptor2",
        secretKey : "1234",
        comType : "API"
    }
}

Merchant User :: Create

  • Live URL : https://liveapi.paywallreporting.com/api/v3/merchant/user/create
  • Test URL : https://testapi.paywallreporting.com/api/v3/merchant/user/create

Post parameters

Parameter name Details Example Type Mandatory
merchantId The merchant identifier. 1 Int ✔
subMerchantId The sub merchant identifier. 2 Int
name Merchant user name. Pluto Char(64) ✔
password Merchant user password. 12345 Char(32) ✔
email Email address. [email protected] Char(32) ✔

Successful Response

{
    status: "APPROVED",
    message: "Merchant User Created",
    id: 59
}

Merchant User :: Update

  • Live URL : https://liveapi.paywallreporting.com/api/v3/merchant/user/update
  • Test URL : https://testapi.paywallreporting.com/api/v3/merchant/user/update

Post parameters

Parameter name Details Example Type Mandatory
id Merchant user identifier. 1 Int ✔
name Merchant user name. 2 Char(64) ✔
email Email address. [email protected] Char(32) ✔
role Merchant user role (admin/user) admin Char(16) ✔

Successful Response

{
    status: "APPROVED",
    message: "Merchant User Updated"
}

Merchant User :: Show

  • Live URL : https://liveapi.paywallreporting.com/api/v3/merchant/user/show
  • Test URL : https://testapi.paywallreporting.com/api/v3/merchant/user/show

Post parameters

Parameter name Details Example Type Mandatory
id Merchant user identifier. 1 Int ✔

Successful Response

{
    status: "APPROVED",
    merchantUser: {
        id: 59,
        role: "admin",
        email: "[email protected]",
        name: "Demo User 2",
        merchantId: 3,
        secretKey : null
    }
}

Merchant User :: Info

  • Live URL : https://liveapi.paywallreporting.com/api/v3/merchant/user/info
  • Test URL : https://testapi.paywallreporting.com/api/v3/merchant/user/info

Post parameters

Parameter name Details Example Type Mandatory
merchantUserId Merchant user identifier. 1 Int ✔

Successful Response

{
    id: 53,
    name: "Merchant",
    role: "admin",
    email: "[email protected]",
    merchantId: 1,
    secretKey : null,
    status: "APPROVED"
}

Merchant User :: Change Password

  • Live URL : https://liveapi.paywallreporting.com/api/v3/merchant/user/changePassword
  • Test URL : https://testapi.paywallreporting.com/api/v3/merchant/user/changePassword

Post parameters

Parameter name Details Example Type Mandatory
merchantId The merchant identifier. 1 Int ✔
id Merchant user identifier. 2 Int ✔
password New password. 12345 Char(64) ✔

Successful Response

{
    status: "APPROVED",
    message: "Merchant User Password Updated",
    id: 59
}

Non-Successful Response

{
    code: 0,
    status: "DECLINED",
    message: "Merchant no privileges"
}

Merchant User :: List

  • Live URL : https://liveapi.paywallreporting.com/api/v3/merchant/sub/getList
  • Test URL : https://testapi.paywallreporting.com/api/v3/merchant/sub/getList

Post parameters

Parameter name Details Example Type Mandatory
merchantId The merchant identifier. 1 Int ✔
subMerchantId The sub merchant identifier. 2 Int

Successful Response

{
    status: "APPROVED",
    message: "Merchant User List Download",
    merchantUsers:[
        {
            id: 6,
            name: "John Doe",
            email: "[email protected]",
            password: "$2y$10$0U4yw5dDFFrCJ3hwdOc3P.Way0Od4maaJ.rwkTa8gnb7k0rEeXUpq",
            role: "admin",
            merchantId: 3,
            secretKey: ""
        },
        {id: 53, name: "John Doe", email: "[email protected]",
        password:"$2y$10$h8iwV1/MtaG7RnZV1alDmu4F5ifCsE1c9b9juh0pa6kC6W…",…},
        {id: 59, name: "Demo User 2", email: "[email protected]",
        password:"$2y$10$MzboGDzIcEev97pzSTfUaOJZBoxBzLNiYdQocgXzeoL1Tgv/7Qxbq",…}
    ]
}

Merchant User :: Delete

  • Live URL : https://liveapi.paywallreporting.com/api/v3/merchant/user/delete
  • Test URL : https://testapi.paywallreporting.com/api/v3/merchant/user/delete

Post parameters

Parameter name Details Example Type Mandatory
id Merchant user identifier. 1 Int ✔

Successful Response

{
    status: "APPROVED",
    message: "Merchant User Deleted",
    id: "56"
}

Sub Merchant :: List

  • Live URL : https://liveapi.paywallreporting.com/api/v3/merchant/sub/list
  • Test URL : https://testapi.paywallreporting.com/api/v3/merchant/sub/list

Post parameters

Parameter name Details Example Type Mandatory
merchantId The merchant identifier. 1 Int ✔

Successful Response

{
    status: "APPROVED",
    message: "Sub Merchant List Uploaded",
    subMerchants:[{
        id: 74,
        parentId: 3,
        name: "Sub merchant num.1",
        3dStatus: "ALL",
        mcc: "6012",
        ipnUrl: "",
        apiKey: "44fbbbf91e0cce19bf1a3ffb4e3fef77",
        cpgKey: null,
        type: "ECOM",
        descriptor: "descriptor2",
        secretKey: "e7737647",
        comType: "API"
    }]
}

Transaction Report

  • Live URL : https://liveapi.paywallreporting.com/api/v3/transactions/report
  • Test URL : https://testapi.paywallreporting.com/api/v3/transactions/report

Post parameters

Parameter name Details Example Type Mandatory
fromDate Start date YYYY-MM-DD Date ✔
toDate Finish date. YYYY-MM-DD Date ✔
merchant The merchant identifier. 1 Int
type Report type by currency. merchantConverted - merchantOriginal Char

Successful Response

{
    status: "APPROVED",
    response:[
        {
            count: 283,
            total: 28300,
            currency: "USD"
        },
        {
            count: 280,
            total: 1636515,
            currency: "EUR"
        }
    ]
}

Transaction List

  • Live URL : https://liveapi.paywallreporting.com/api/v3/transaction/list
  • Test URL : https://testapi.paywallreporting.com/api/v3/transaction/list

Post parameters

Parameter name Details Example Type Mandatory
fromDate Start Date YYYY-MM-DD Date
toDate Finish Date YYYY-MM-DD Date
status The API request status. APPROVED Char(64)
operation Request operation 3D Char(64)
merchantId The merchant identifier. 1 Int
paymentMethod The payment method CREDITCARD Char(32)
errorCode Error Code Invalid Card Char(256)
filterField Search by special field Customer transactionId - customerEmail - referenceNo - customData - cardPan Char(128)
filterValue Value of field. [email protected] Char(256)
page Number of page 1 Int

Note:

If the optional parameters fromDate and toDate are not provided then the API will return transactions for today date.

Successful Response

{
    per_page: 50,
    current_page: 1,
    next_page_url:
    "http://testapi.paywallreporting.com/api/v3/transaction/list/?page=2",
    prev_page_url: null,
    from: 1,
    to: 50,
    data:[{
        fx:{
            merchant:{
                originalAmount: 5,
                originalCurrency: "EUR"
            }
        },
        customerInfo:{
            number: "448574XXXXXX3395",
            email: "[email protected]",
            billingFirstName: "John",
            billingLastName: "Doe"
        },
        merchant:{
            id: 3,
            name: "Dev-Merchant"
        },
        ipn:{ received: true },
        transaction:{
            merchant:{
                referenceNo: "api_560a4a9314208",
                status: "APPROVED",
                operation: "3DAUTH",
                message: "Auth3D is APPROVED",
                created_at: "2015-09-29 08:24:42",
                transactionId: "2827-1443515082-3"
            }
        },
        refundable: true
    },
    { fx:{merchant:{originalAmount: 100, originalCurrency: "EUR" }…},
    { fx:{merchant:{originalAmount: 100, originalCurrency: "EUR" }…},
    …………………
    …………………
    …………………
    …………………
}

Get Transaction

  • Live URL : https://liveapi.paywallreporting.com/api/v3/transaction
  • Test URL : https://testapi.paywallreporting.com/api/v3/transaction

Post parameters

Parameter name Details Example Type Mandatory
transactionId Our unique transaction identifier. 529-1438673740-2 Char(32) ✔

Successful Response

{
    fx:{
    merchant:{
            originalAmount: 100,
            originalCurrency: "EUR"
        }
    },
    customerInfo:{
        id: 1,
        created_at: "2015-10-09 12:09:10",
        updated_at: "2015-10-09 12:09:10",
        deleted_at: null,
        number: "401288XXXXXX1881",
        expiryMonth: "6",
        expiryYear: "2017",
        startMonth: null,
        startYear: null,
        issueNumber: null,
        email: "[email protected]",
        birthday: "1986-03-20 12:09:10",
        gender: null,
        billingTitle: null,
        billingFirstName: "Michael",
        billingLastName: "Kara",
        billingCompany: null,
        billingAddress1: "test address",
        billingAddress2: null,
        billingCity: "Antalya",
        billingPostcode: "07070",
        billingState: null,
        billingCountry: "TR",
        billingPhone: null,
        billingFax: null,
        shippingTitle: null,
        shippingFirstName: "Michael",
        shippingLastName: "Kara",
        shippingCompany: null,
        shippingAddress1: "test address",
        shippingAddress2: null,
        shippingCity: "Antalya",
        shippingPostcode: "07070",
        shippingState: null,
        shippingCountry: "TR",
        shippingPhone: null,
        shippingFax: null
    },
    merchant:{
        name: "Dev-Merchant"
    },
    transaction:{
        merchant :{
            referenceNo: "reference_5617ae66281ee",
            merchantId: 1,
            status: "WAITING",
            channel: "API",
            customData: null,
            chainId: "5617ae666b4cb",
            agentInfoId: 1,
            operation: "DIRECT",
            fxTransactionId: 1,
            updated_at: "2015-10-09 12:09:12",
            created_at: "2015-10-09 12:09:10",
            id: 1,
            code: "00",
            message: "Waiting",
            transactionId: "1-1444392550-1",
            agent:{id: 1, customerIp: "192.168.1.2", customerUserAgent:
            Agent, merchantIp: "127.0.0.1",…}
        }
    }
}

Get Client

  • Live URL : https://liveapi.paywallreporting.com/api/v3/client
  • Test URL : https://testapi.paywallreporting.com/api/v3/client

Post parameters

Parameter name Details Example Type Mandatory
transactionId Our unique transaction identifier. 529-1438673740-2 Char(32) ✔

Successful Response

{
    customerInfo:{
        id: 1,
        created_at: "2015-10-09 12:09:10",
        updated_at: "2015-10-09 12:09:10",
        deleted_at: null,
        number: "401288XXXXXX1881",
        expiryMonth: "6",
        expiryYear: "2017",
        startMonth: null,
        startYear: null,
        issueNumber: null,
        email: "[email protected]",
        birthday: "1986-03-20 12:09:10",
        gender: null,
        billingTitle: null,
        billingFirstName: "Michael",
        billingLastName: "Kara",
        billingCompany: null,
        billingAddress1: "test address",
        billingAddress2: null,
        billingCity: "Antalya",
        billingPostcode: "07070",
        billingState: null,
        billingCountry: "TR",
        billingPhone: null,
        billingFax: null,
        shippingTitle: null,
        shippingFirstName: "Michael",
        shippingLastName: "Kara",
        shippingCompany: null,
        shippingAddress1: "test address",
        shippingAddress2: null,
        shippingCity: "Antalya",
        shippingPostcode: "07070",
        shippingState: null,
        shippingCountry: "TR",
        shippingPhone: null,
        shippingFax: null
    }
}

Get Merchant

  • Live URL : https://liveapi.paywallreporting.com/api/v3/merchant
  • Test URL : https://testapi.paywallreporting.com/api/v3/merchant

Post parameters

Parameter name Details Example Type Mandatory
transactionId Our unique transaction identifier. 529-1438673740-2 Char(32) ✔

Successful Response

{
    merchant:{
        id: 1,
        parentId: null,
        name: "Dev-Merchant",
        3dStatus: "ALL",
        mcc: "6012",
        ipnUrl: null,
        apiKey: "1234",
        cpgKey: null,
        type: "ECOM",
        descriptor: "descriptor",
        secretKey: "1234",
        comType: “API"
    }
}

Refund Report

  • Live URL : https://liveapi.paywallreporting.com/api/v3/refunds/report
  • Test URL : https://testapi.paywallreporting.com/api/v3/refunds/report

Post parameters

Parameter name Details Example Type Mandatory
fromDate Start date YYYY-MM-DD Date ✔
toDate Finish date YYYY-MM-DD Date ✔
merchant The merchant identifier. 1 Int

Successful Response

{
    status: "APPROVED",
    response:[
        {
            count: 283,
            total: 28300,
            currency: "USD"
        },
        {
            count: 11,
            total: 1100,
            currency: "EUR"
        },
    ]
}

Chargeback List

  • Live URL : https://liveapi.paywallreporting.com/api/v3/chargeback/list
  • Test URL : https://testapi.paywallreporting.com/api/v3/chargeback/list

Post parameters

Parameter name Details Example Type Mandatory
status The API request status. APPROVED Char(64)
merchant The merchant identifier. 1 Int

Successful Response

{
    total: 1,
    per_page: 50,
    current_page: 1,
    last_page: 1,
    next_page_url: null,
    prev_page_url: null,
    from: 1,
    to: 1,
    data:[{
        _id: "562cc61b5b5aa0a85e8b4586",
        merchantTransactionId: "3720-1445774474-3",
        merchantId: 3,
        chargeBacks:[{
            caseId: "20150709312131",
            merchantNo: "104900006298",
            arn: "74089125152521000000000",
            reasonCode: 83,
            reasonMessage: "CBK: Fraud - Card Absent Environment",
            dueDate: "2015-08-21",
            referenceNo: "2-400583",
            raw:
            "[\"10\\/07\\/2015\",\"20150709312131\",\"Open\",\"104900006298\",\
            "6298\",\"09\\/07\\/2015\",\"CBK1\",\"VI\",\"454434******7544\",\"7
            4089125152521000000000\",\"83\",\"CBK: Fraud - Card Absent
            Environment\",\"1\",\"75.45\",\"GBP\",\"75.45\",\"GBP\",\"18\\/07\\
            /2015\",\"42\",\"21\\/08\\/2015\",\"09\\/07\\/2015\",\"0\",\"Melani
            e Mifsud\",\"ONLINE PAYMENT\",\"eCommerce, Channel
            Encrypt\",\"\",\"\",\"3552-1445774474-12-3\",\"01\\/06\\/2015\",\"2
            -400583\",\"GBP\",\"75.45\",\"\"]",
            status: "WAITING",
            amount: "7545",
            currency: "GBP",
            merchantTransactionId: "3720-1445774474-3",
            merchantId: 3,
            updated_at: "2015-10-25 12:07:55",
            created_at: "2015-10-25 12:07:55",
            id: 1
        },
        {
                            caseId: "20150709312131",
                            merchantTransactionId: "3720-1445774474-3",…
                            },
        {caseId: "20150709312131",
                            merchantTransactionId: "3720-1445774474-3",…}
    ],
    updated_at: "2015-10-25 12:07:55",
    created_at: "2015-10-25 12:07:55"
    }
]}

Get Chargeback

  • Live URL : https://liveapi.paywallreporting.com/api/v3/chargeback
  • Test URL : https://testapi.paywallreporting.com/api/v3/chargeback

Post parameters

Parameter name Details Example Type Mandatory
transactionId Our unique transaction identifier. 529-1438673740-2 Char(32) ✔

Successful Response

{
    _id: "562cc61b5b5aa0a85e8b4586",
    merchantTransactionId: "3720-1445774474-3",
    merchantId: 3,
    chargeBacks:[
    {
        caseId: "20150709312131",
        merchantNo: "104900006298",
        arn: "74089125152521000000000",
        reasonCode: 83,
        reasonMessage: "CBK: Fraud - Card Absent Environment",
        dueDate: "2015-08-21",
        referenceNo: "2-400583",
        raw: 
            "[\"10\\/07\\/2015\",\"20150709312131\",\"Open\",\"104900006298\",\"
            298\",\"09\\/07\\/2015\",\"CBK1\",\"VI\",\"454434******7544\",\"7408
            125152521000000000\",\"83\",\"CBK: Fraud - Card Absent
            Environment\",\"1\",\"75.45\",\"GBP\",\"75.45\",\"GBP\",\"18\\/07\\/
            015\",\"42\",\"21\\/08\\/2015\",\"09\\/07\\/2015\",\"0\",\"Melanie
            Mifsud\",\"ONLINE PAYMENT\",\"eCommerce, Channel
            Encrypt\",\"\",\"\",\"3552-1445774474-12-3\",\"01\\/06\\/2015\",\"2-
            00583\",\"GBP\",\"75.45\",\"\"]
        status: "WAITING",
        amount: "7545",
        currency: "GBP",
        merchantTransactionId: "3720-1445774474-3",
        merchantId: 3,
        updated_at: "2015-10-25 12:07:55",
        created_at: "2015-10-25 12:07:55",
        id: 1
    },
    {caseId: "20150709312131",
    merchantTransactionId: "3720-1445774474-3",…},
    {caseId: "20150709312131",
    merchantTransactionId: "3720-1445774474-3",…}
    ],
    updated_at: "2015-10-25 12:07:55",
    created_at: "2015-10-25 12:07:55"
}

Export

  • Live URL : https://liveapi.paywallreporting.com/api/v3/export
  • Test URL : https://testapi.paywallreporting.com/api/v3/export

Post parameters

Parameter name Details Example Type Mandatory
fromDate Start Date YYYY-MM-DD Date
toDate Finish Date YYYY-MM-DD Date
status The API request status. APPROVED Char(64)
operation Request operation 3D Char(64)
merchantId The merchant identifier. 1 Int
paymentMethod The payment method CREDITCARD Char(32)
errorCode Error Code Invalid Card Char(256)
filterField Search by special field Customer Email Char(128)
filterValue Value of field. [email protected] Char(256)
page Number of page 1 Int

Successful Response

{
    per_page: 10000,
    current_page: 1,
    next_page_url: null,
    prev_page_url: null,
    from: 1,
    to: 335,
    data:[{
        fx: {
            merchant:{
                originalAmount: 5,
                originalCurrency: "EUR"
            }
        },
        customerInfo:{
            number: "401288XXXXXX1881",
            email: "[email protected]",
            billingFirstName: "John",
            billingLastName: "Doe"
        },
        transaction:{
            merchant:{
                referenceNo: "api_563f852402f73",
                status: "APPROVED",
                operation: "STORED",
                created_at: "2015-11-08 17:23:56",
                message: "Approved",
                transactionId: "4929-1447003436-3"
            }
        },
        merchant:{
            id: 3,
            name: "Dev-Merchant"
        }
    },
    {fx:{merchant:{originalAmount: 5, originalCurrency: "EUR" }…},
    {fx:{merchant:{originalAmount: 500, originalCurrency: "TRY" }…},
    …
    …
    …
    }]
}