API transaction list

TRANSACTION LIST request is used for acquisition of the list of shop transactions for certain period. 

The request is generated on the side of the merchant and transferred with the help of POST method through HTTP protocol to URL https://api.wayforpay.com/api

Request parameters:

Parameter

Description

Mandatory

transactionType

Request type, possesses the value of TRANSACTION_LIST

yes

merchantAccount

Merchant unique identifier.

yes

merchantSignature

Order signature

yes

apiVersion

Protocol version. Default value: 1

Value 2 - include the transfer of advanced data - additional fields, delivery, comments.

yes

dateBegin

Period start date, timestamp

yes

dateEnd

Period end date, TRANSACTION_LIST

yes

In order to confirm the data validity, there shall be generated and transferred in the HMAC_MD5 request the control signature with use of the merchant SecretKey.

The line, subject to HMAC_MD5, is generated through concatenation of UTF-8-encoded merchantAccount;dateBegin;dateEnd separated with “;” (semicolon)

Response parameters:

Parameter

Description

Example

reason

Response result

Ок

reasonCode

Response code

1100

transactionList

List of transactions for the requested period

 

transactionType

Transaction type

Purchase

orderReference

Unique order number in the merchant system

1212dd1

createdDate

Date of order creation in psp

123456789

amount

Order amount

100

currency

Order currency

UAH

transactionStatus

Transaction status

Approved

processingDate

Transaction processing date

12345678

reasonCode

Rejection reason

Ok

reason

Rejection code

1100

email

Client E-mail

email@email.com

phone

Client telephone number

380987654321

paymentSystem

Payment method used for payment

card

cardPan

Masked card number

42****4242

cardType

Card type: Visa/MasterCard

Visa

issuerBankCountry

Card country

980

issuerBankName

Name of the bank-card issuer

PrivatBank

fee

Fee psp

1.50

 

An example of request and response

Request:
 
{
"apiVersion": 1,
"transactionType": "TRANSACTION_LIST",
"merchantAccount": "test_merch_n1",
"merchantSignature": "b9277c081b29841e5eccea03d223e23a",
"dateBegin": 1454277600,
"dateEnd": 1454364000
}

 

Response:
{
"reason": "Ok",
"reasonCode": 1100,
"transactionList": [
{
"transactionType": "PURCHASE",
"orderReference": "RF3656-1454331982",
"createdDate": "1454332003",
"amount": "0.17",
"currency": "UAH",
"transactionStatus": "Declined",
"processingDate": "1454332238",
"reasonCode": "1101",
"reason": "Declined To Card Issuer",
"email": "dev@wayforpay.com",
"phone": "380660000001",
"paymentSystem": "card",
"cardPan": "41****1111",
"cardType": "Visa",
"issuerBankCountry": "",
"issuerBankName": "",
"fee": "0"
},
{
"transactionType": "PURCHASE",
"orderReference": "RF3656-1454338652",
"createdDate": "1454338658",
"amount": "0.17",
"currency": "UAH",
"transactionStatus": "InProcessing",
"processingDate": "1454338666",
"reasonCode": "1131",
"reason": "Transaction in processing",
"email": "dev@wayforpay.com",
"phone": "380660000001",
"paymentSystem": "privat24",
"cardPan": "",
"cardType": "",
"issuerBankCountry": "",
"issuerBankName": "",
"fee": "0"
}
]
}