2.2. Remote transactions report

2.2.1. Remote transactions report

User who has a merchant account in Paywize system is able to get a transaction report via special GET request made to our API. URL to which request is sent (its base part, with no parameters yet) looks like
https://gate.paywize.com/paynet-ui/services/transaction-report. Parameters are passed in URL. Following parameters are recognized:

2.2.2. Remote Transactions Report Request

Transactions Report Request Parameter Mandatory Description
createdFromDate Yes Filters transactions on creation date. Must be in the following format: YYYY-MM-dd HH:mm:ss
createdToDate Yes Filters transactions on creation date. Must be in the following format: YYYY-MM-dd HH:mm:ss
bankFromDate No Filters transactions on date when transaction was uploaded to bank. Must be in the following format: YYYY-MM-dd HH:mm:ss
bankToDate No Filters transactions on date when transaction was uploaded to bank. Must be in the following format: YYYY-MM-dd HH:mm:ss
transactionTypes No Comma-separated list of transaction types to return. If this parameter is omitted, transactions of all types. Following types are recognized: sale, reversal, preauth, capture, cancel, fraud, chargeback, retrieval, dispute, refund.
transactionStatuses No Comma-separated list of transaction statuses to return. If this parameter is omitted, transactions in all statuses are returned. Following statuses are recognized: approved, declined, filtered.
endpoints No Comma-separated list of endpoint IDs to which returned transactions must belong. If this parameter is omitted, transactions belonging to any endpoint of merchant who makes a request are returned.

There are some restrictions:

  • If endpoints parameter is specified and some endpoints in the list do not belong to the merchant who makes a request, or some endpoints from the list do not exist, an error message is returned.
  • Period specified by createdFromDate and createdToDate parameters must not exceed 31 days in length.
  • You cannot make more than 10 requests per hour to this report.

2.2.3. Remote Transactions Report Response

The order of parameters in transaction report might change in future releases. New parameters might be added. Please implement response handling based on parameters names, not parameters order.

Transactions Report Response Parameter Description
Txid Transaction ID in Paywize
Created Date Creation date in the server timezone
Created Date (no time) Creation date in the server timezone, no time
Bank Date Creation date in bank
Merchant Merchant name
End-Point ID Endpoint ID
Project ID Merchant’s project ID
Project name Name of the project
Currency Transaction currency
Site URL Domain name of the site
Card type Card type of international payment systems
Ip IP address
Type Transaction type
Status Transaction status
Error Number Error code
Error Description Error Description
Reason code Reason code (if information is available)
Reason Reason (if information is available)
Comment Comment (if information is available)
Amount Transaction amount
Processor ID Processor / acquirer transaction identification number
Card No Masked PAN
Name Card holder name
Routing Number Routing step ID
Account Number Merchant balance identification number
Email Customer email
Phone Customer phone number
Address Address passed by API
Zip Zip passed by API
City City passed by API
State State passed by API
Country Country passed by API
Order Description Payment description passed by API
Merchant OID ID of transaction on merchant’s side
Reversal Amount Refund amount
Capture Amount Transaction confirmation amount after DMS authorization
Approval Code Authorization code
ECI/SLI ECI
Support doc Cb Reason Code These fields are related to dispute management
Support doc Cb Reason Name These fields are related to dispute management
Described Services/Merchandise These fields are related to dispute management
Actual Services/Merchandise These fields are related to dispute management
Merchant Response These fields are related to dispute management
Tried to Resolve with Merchant These fields are related to dispute management
Last Contact Date These fields are related to dispute management
Contact Name These fields are related to dispute management
Contact Method These fields are related to dispute management
Cb Comments These fields are related to dispute management
Cb Documents These fields are related to dispute management
Cb Additional Files These fields are related to dispute management
Destination The parameter passed to the Purpose field
Transaction commission Total transaction fee
Destination Card No 6 + 4 of destination card
Destination bank Destination card issuer
Source BIN country code ISO 3166-1 alpha-2 country code of source card issuer (determined by BIN)
Source BIN country name Country name of source card issuer (determined by BIN)
Destination BIN country code ISO 3166-1 alpha-2 country code of destination card issuer (determined by BIN)
Destination BIN country name Country name of destination card issuer (determined by BIN)
Auth credit code Auth Credit Code is indicated as auth code when performing AFT and when performing OCT
Auth verification value Cardholder authentication check values. Indicated only after payment for the order and in case of appropriate permission.
Transaction XID Electronic commercial transaction identifier. Indicated only after payment for the order and in case of appropriate permission.
Transaction RRN RRN - Retrieval Reference Number
Card MPI status A separate tool for checking card participation in 3-D Secure, may be Y / N
Is 3DS A tool for checking if transaction is 3DS-validated, may be True / False
Is enrolled A tool for checking if transaction is enrolled, may be True / False
First name Customer first name
Last name Customer last name
Processor Name Processor Name
Gate ID Gate ID
Gate descriptor Descriptor specified on the gate
Gate method Gate properties
Gate method 2 Gate properties
Gate business type Gate properties
Bank name Issuer of source card
DAPI IMEI Custom string provided by merchant in initial request, also used as unique device 32 symbol string identifier in DAPI.
Manager rate plan Manager rate plan name

2.2.4. Debug

To reproduce your API call, input all of the data from your original request, including the authentication tokens. Don’t forget to set the nonce and timestamp to the values you used. An OAuth signed URL should match regardless of the generating library. If the signatures differ, you know there is a bug in your OAuth signature code. Consumer key is a Merchant login, while consumer secret is a Merchant’s control key.

HTTP method
URL
parameters
version
consumer key
consumer secret
timestamp
nonce
signature method

normalized parameters
signature base string
signature
authorization header
              
            
              
            
              
            

2.2.5. Report example

Txid;Created Date;Bank Date;Merchant;End-Point ID;Project ID;Project Name;Currency;Site URL;Card type;Ip;Type;Status;Error Number;Error Description;Reason code;Reason;Comment;Amount;Processor ID;Card No;Name;Routing Number;Account Number;Email;Phone;Address;Zip;City;State;Country;Order Description;Merchat OID;Reversal Amount;Capture Amount;Approval Code;ECI/SLI;Support doc Cb Reason Code;Support doc Cb Reason Name;Described Services/Merchandise;Actual Services/Merchandise;Merchant Response;Tried to Resolve with Merchant;Last Contact Date;Contact Name;Contact Method;Cb Comments;Cb Documents;Cb Additional Files;Destination;Transaction commission;Destination Card No;Destination bank
3622270;2015-05-11 10:55:44;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;65.153.12.232;sale;filtered;10015;BIN country not in anti-black list;;;;10.420;;52XXXXXXXXXX7409;CARD HOLDER;;;john.smith@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;25ytg435g;;;;;;;;;;;;;;;;;www.twitch.tv/dreadztv;4.030;;
3622272;2015-05-11 10:57:24;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;65.153.12.232;sale;filtered;10048;Duplicate client order ID;;;;10.420;;51XXXXXXXXXX9510;CARD HOLDER;;;john.smith@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;25ytg435g;;;;;;;;;;;;;;;;;www.twitch.tv/dreadztv;4.030;;
3622273;2015-05-11 10:58:16;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;65.153.12.232;sale;filtered;10007;By given card number exists approved transaction with different e-mail.;;;;10.420;;51XXXXXXXXXX9510;CARD HOLDER;;;john.smith@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;uhjhh534e6;;;;;;;;;;;;;;;;;www.twitch.tv/dreadztv;4.030;;
3622274;2015-05-11 11:00:44;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;65.153.12.232;sale;approved;;;;;;10.420;PNTEST-3622274;51XXXXXXXXXX9510;CARD HOLDER;;;john.smith@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;uhjhh534e6;;;319866;;;;;;;;;;;;;;www.twitch.tv/dreadztv;0.418;;
3622275;2015-05-11 11:01:37;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;65.153.12.232;sale;filtered;10002;Card number in black list.;;;;10.420;;51XXXXXXXXXX9510;CARD HOLDER;;;john.smith@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;4wyhgretgserf;;;;;;;;;;;;;;;;;www.twitch.tv/dreadztv;4.030;;
3622276;2015-05-11 11:03:09;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;65.153.12.232;sale;filtered;10029;Bank number in black list.;;;;10.420;;51XXXXXXXXXX4234;CARD HOLDER;;;john.smith.2@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;r43twgf1q34;;;;;;;;;;;;;;;;;www.twitch.tv/dreadztv;4.030;;
3622277;2015-05-11 11:04:07;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;65.153.12.232;sale;filtered;10048;Duplicate client order ID;;;;10.420;;51XXXXXXXXXX2989;CARD HOLDER;;;john.smith.3@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;r43twgf1q34;;;;;;;;;;;;;;;;;www.twitch.tv/dreadztv;4.030;;
3622278;2015-05-11 11:04:26;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;65.153.12.232;sale;filtered;10030;IP address in black list.;;;;10.420;;51XXXXXXXXXX2989;CARD HOLDER;;;john.smith.3@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;2133414rqfawd;;;;;;;;;;;;;;;;;www.twitch.tv/dreadztv;4.030;;
3622279;2015-05-11 11:05:07;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;65.153.12.232;sale;filtered;10031;Email address in black list.;;;;10.420;;51XXXXXXXXXX2989;CARD HOLDER;;;john.smith.3@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;awgfq123f;;;;;;;;;;;;;;;;;www.twitch.tv/dreadztv;4.030;;
3622280;2015-05-11 11:05:52;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;65.153.12.232;sale;filtered;10069;Destination is in black list.;;;;10.420;;51XXXXXXXXXX2989;CARD HOLDER;;;john.smith.3@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;q3eg234gf;;;;;;;;;;;;;;;;;www.twitch.tv/dreadztv;4.030;;
3622281;2015-05-11 11:07:07;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;65.153.12.232;sale;filtered;10015;BIN country not in anti-black list;;;;10.420;;51XXXXXXXXXX2989;CARD HOLDER;;;john.smith.3@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;h46esgdf;;;;;;;;;;;;;;;;;www.twitch.tv/dreadztv;4.030;;
3622282;2015-05-11 11:14:07;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;42.61.255.235;sale;filtered;10079;Current country differs from the country of the first transaction;;;;10.420;;57XXXXXXXXXX6119;CARD HOLDER;;;john.smith.4@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;awertf1q2as;;;;;;;;;;;;;;;;;www.twitch.tv/dreadztv;4.030;;
3622283;2015-05-11 11:23:21;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;42.61.255.235;sale;filtered;10071;Cards count by destination.;;;;10.420;;57XXXXXXXXXX3696;CARD HOLDER;;;john.smith.4@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;6576ujhygrtwerf;;;;;;;;;;;;;;;;;www.twitch.tv/dreadztv;4.030;;
3622284;2015-05-11 11:24:36;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;42.61.255.235;sale;approved;;;;;;10.420;PNTEST-3622284;57XXXXXXXXXX3696;CARD HOLDER;;;john.smith.4@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;qfvcasdfds;;;739564;;;;;;;;;;;;;;www.twitch.tv/dreadztv1;0.418;;
3622285;2015-05-11 11:25:59;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;43.61.255.255;sale;filtered;10079;Current country differs from the country of the first transaction;;;;10.420;;57XXXXXXXXXX3696;CARD HOLDER;;;john.smith.4@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;1241r2eqwaqd;;;;;;;;;;;;;;;;;www.twitch.tv/dreadztv1;4.030;;
3622286;2015-05-11 11:27:34;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;65.153.12.232;sale;approved;;;;;;10.420;PNTEST-3622286;57XXXXXXXXXX2244;CARD HOLDER;;;john.smith.5@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;q3rtgfq134fre;;;518794;;;;;;;;;;;;;;www.twitch.tv/dreadztv2;0.418;;
3622287;2015-05-11 11:29:18;;Deviless;515;302;Misdistinguish;GBP;www.google.com;Master Card;49.213.127.235;sale;filtered;10028;IP country is in black list;;;;10.420;;57XXXXXXXXXX9128;CARD HOLDER;;;john.smith.6@gmail.com;12063582043;100 Main st;98102;Seattle;Washington;USA;POINT 1 BL Test;q3rtgfq134fre;;;;;;;;;;;;;;;;;www.twitch.tv/dreadztv3;4.030;;

2.2.6. Libraries

OAuth is used to authenticate client requests. We use a simplified flow in which there’s no external authenticator, and there’s no access token and its secret; only the last step of the flow is used.

Merchant login is specified as client identifier (aka consumer key), while merchant control is client shared-secret. The whole GET URL which will be used to make a request is used to calculate a HMAC-SHA signature and form an Authentication string which is sent in request’s header named ‘Authentication’.

Libraries which help making OAuth-secured requests: