Transaction Operations

Transaction Report

Live URL : https://reportingapi.openpaydpsp.com.com/api/v3/transactions/report
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/transactions/report

Post parameters

Parameter Name	Details	Example	Type	Is Required
fromDate	Start date	YYYY-MM-DD	Date	✔
toDate	Finish date	YYYY-MM-DD	Date	✔
merchant	The merchant identifier.	1	Int
acquirer	The acquirer identifier.	1	Int

Successful Response

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

Transaction List

Live URL : https://reportingapi.openpaydpsp.com.com/api/v3/transaction/list
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/transaction/list

Post parameters

Parameter Name	Details	Example	Type
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
acquirerId	The acquirer identifier.	2	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

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:
    "https://psp-reportingapi-test.openpaydpsp.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"
            }
        },
        acquirer:{
            id: 12,
            name: "Mergen Bank",
            code: "MB",
            type: "CREDITCARD"
        },
        refundable: true
    },
    { fx:{merchant:{originalAmount: 100, originalCurrency: "EUR" }…},
    { fx:{merchant:{originalAmount: 100, originalCurrency: "EUR" }…},
    …………………
    …………………
    …………………
    …………………
}

Get Transaction

Live URL : https://reportingapi.openpaydpsp.com.com/api/v3/transaction
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/transaction

Post parameters

Parameter Name	Details	Example	Type	Is Required
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,
            acquirerTransactionId: 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://reportingapi.openpaydpsp.com.com/api/v3/client
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/client

Post parameters

Parameter Name	Details	Example	Type	Is Required
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://reportingapi.openpaydpsp.com.com/api/v3/merchant
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/merchant

Post parameters

Parameter Name	Details	Example	Type	Is Required
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"
    }
}