Refund and Chargebacks Operations

Refund Report

Live URL : https://reportingapi.openpaydpsp.com.com/api/v3/refunds/report
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/refunds/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: 11,
            total: 1100,
            currency: "EUR"
        },
    ]
}

Chargeback List

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

Post parameters

Parameter Name	Details	Example	Type	Is Required
status	The API request status.	APPROVED	Char(64)	No
merchant	The merchant identifier.	1	Int	No
acquirer	The acquirer identifier.	1	Int	No

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,
        acquirerTransactionId: "3552-1445774474-12-3",
        acquirerId: "3",
        chargeBacks:[{
            caseId: "20150709312131",
            acquirerTransactionId: "3552-1445774474-12-3",
            acquirerId: "3",
            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", acquirerTransactionId:
        "3552-1445774474-12-3", merchantTransactionId: "3720-1445774474-3",…},
        {caseId: "20150709312131", acquirerTransactionId:
        "3552-1445774474-12-3", merchantTransactionId: "3720-1445774474-3",…}
    ],
    updated_at: "2015-10-25 12:07:55",
    created_at: "2015-10-25 12:07:55"
    }
]}

Export Chargeback

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

Post parameters

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

Successful Response

{
    _id: "562cc61b5b5aa0a85e8b4586",
    merchantTransactionId: "3720-1445774474-3",
    merchantId: 3,
    acquirerTransactionId: "3552-1445774474-12-3",
    acquirerId: "3",
    chargeBacks:[
    {
        caseId: "20150709312131",
        acquirerTransactionId: "3552-1445774474-12-3",
        acquirerId: "3",
        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", acquirerTransactionId: "3552-1445774474-12-3",
    merchantTransactionId: "3720-1445774474-3",…},
    {caseId: "20150709312131", acquirerTransactionId: "3552-1445774474-12-3",
    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://reportingapi.openpaydpsp.com.com/api/v3/chargeback
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/chargeback

Post parameters

Parameter Name	Details	Example	Type	Is Required
transactionId	Our unique transaction identifier.	529-1438673740-2	Char(32)	✔

Successful Response

{
    _id: "562cc61b5b5aa0a85e8b4586",
    merchantTransactionId: "3720-1445774474-3",
    merchantId: 3,
    acquirerTransactionId: "3552-1445774474-12-3",
    acquirerId: "3",
    chargeBacks:[
    {
        caseId: "20150709312131",
        acquirerTransactionId: "3552-1445774474-12-3",
        acquirerId: "3",
        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", acquirerTransactionId: "3552-1445774474-12-3",
    merchantTransactionId: "3720-1445774474-3",…},
    {caseId: "20150709312131", acquirerTransactionId: "3552-1445774474-12-3",
    merchantTransactionId: "3720-1445774474-3",…}
    ],
    updated_at: "2015-10-25 12:07:55",
    created_at: "2015-10-25 12:07:55"
}