3.2. Remote transactions report

3.2.1. Remote transactions report

User who has a merchant account in Apropay 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.apropay.com/paynet-ui/services/transaction-report. Parameters are passed in URL. Following parameters are recognized:

3.2.2. Remote Transactions Report Request

Note

Request must have content-type=application/x-www-form-urlencoded and Authorization headers.
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.

3.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.

Note

Response has Content-Type: text/html;charset=utf-8 header. All fields are x-www-form-urlencoded, with (0xA) character at the end of each parameter’s value.
Transactions Report Response Parameter Description
Txid Transaction ID in Apropay, also referred as Order ID.
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 Connecting Party’s name.
End-Point ID Endpoint ID.
Project ID Connecting Party’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 Connecting Party’s 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.
First name Customer first name. For transfer transactions: sender first name (if sent), or receiver first name.
Last name Customer last name. For transfer transactions: sender last name (if sent), or receiver last name.
Order Description Payment description passed by API.
Merchant OID ID of transaction on Connecting Party’s side.
Auxiliary transaction merchant OID ID of master transaction in Merchant order ID field, if there are no master transactions, it will be the same as Merchant OID field.
Reversal Amount Refund amount.
Capture Amount Transaction confirmation amount after DMS authorization.
Approval Code Authorization code.
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.
Transaction ARN ARN - Acquirers Reference Number.
Card MPI status A separate tool for checking card participation in 3-D Secure, may be Y / N.
Electronic Commerce Indicator ECI.
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.
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.
What is not as described ...
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.
Gate ID Gate ID.
Gate Name Gate Name.
Gate descriptor Descriptor specified on the gate.
Gate method Gate properties.
Gate method 2 Gate properties.
Gate business type Gate properties.
Gate MID Gate MID.
View Receipt URL ...
Destination The parameter passed to the Purpose field.
Client commission Total transaction fee.
Destination Card No 6 + 4 of destination card.
Destination bank Destination card issuer.
Bank name Issuer of source card.
DAPI IMEI Custom string provided by Connecting Party in initial request, also used as unique device 32 symbol string identifier in DAPI.
BIN country code ISO 3166-1 alpha-2 country code of source card issuer (determined by BIN).
BIN country 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).
Processor Processor Name.
Processor ID Processor ID.
Processor Error Code Processor Error Code.
CardRefId Card reference ID obtained at Card Registration Stage.
Initial tx bank date (Server TZ) ...
Initial tx bank date (User TZ) ...
Initial tx Amount ...
External merchant identifier ...
Manager rate plan Manager rate plan name.
Bank name attr ...
Bank branch ...
Account name ...
Status change date ...
Manager rate plan id Manager rate plan id.
Currency for processing ...
Amount in currency for processing ...
Capture amount in currency for processing ...
Reversal amount in currency for processing ...
Currency rate for processing ...
Provider currency rate ...
Fee in currency for processing ...
Transaction ID Internal ID in Apropay which helps to distinguish several processing attempts within one transaction (Txid).
Reseller commission Reseller transaction fee.
Manager commission Manager transaction fee.
Dealer commission Dealer transaction fee.
Processor commission Processor transaction fee.
Card expiration date Expiration date for source card.
Destination card expiration date Expiration date for destination card.
Last routing type Last routing type used in balancing for this transaction.
Last routing value Last routing value used in balancing for this transaction.
IPs region Region of Connecting Party relative to card BIN region. For MasterCard possible values are: Domestic, European (EEA), European (SEPA NON EEA), European (NON SEPA NON EEA), Interregional (Inter-European), Interregional. For Visa possible values are: Domestic, European (EEA), European (Non-EEA GB, GI), European (Non-EEA CH), European (Non-EEA AD, MC, SM, VA), Interregional (Non-EEA IL, TR), Interregional. If BIN country cannot be determined, processor region value will be: Unknown.
Processor region Card BIN region. Possible values are: EU, NON EU. If BIN country cannot be determined, processor region value will be: Unknown.
Manager ID Manager ID.
Manager name Manager name.
Creation time ...
Customer level ...
Customer IP address country ...

3.2.4. Postman Collection

3.2.5. 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 1.0a signed URL should match regardless of the generating library. If the signatures differ, you know there is a bug in your OAuth 1.0a 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
              
            
              
            
              
            

3.2.6. Report example

Txid;Created Date (Server TZ);Created Date (User TZ);Created Date (Server TZ, no time);Bank Date (Server TZ);Bank Date (User TZ);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 tx ID;Card No;Name;Routing Number;Account Number;Email;Phone;Address;Zip;City;State;Country;First Name;Last Name;Order Description;Merchant OID;Auxiliary transaction merchant OID;Reversal Amount;Capture amount;Approval Code;Auth Credit Code;Auth Verification Value;Transaction XID;Transaction RRN;Transaction ARN;Card MPI Status;Electronic Commerce Indicator;Is 3D;Is Enrolled;Support doc Cb reason code;Support doc Cb reason;Described services/merchandise;What is not as described;Merchant response;Tried to resolve with merchant;Last contact date;Contact name;Contact method;Cb Comments;Cb Documents;Cb additional files;Gate ID;Gate Name;Gate Descriptor;Gate Method;Gate Method 2;Gate Business type;Gate MID;View Receipt URL;Destination;Client commission;Destination Card No;Destination bank name;Bank name;DAPI IMEI;BIN country code;BIN country;Destination BIN country code;Destination BIN country;Processor;Processor Error Code;CardRefId;Initial tx bank date (Server TZ);Initial tx bank date (User TZ);Initial tx Amount;External merchant identifier;Manager rate plan;Bank name attr;Bank branch;Account name;Status change date;Manager rate plan id;Currency for processing;Amount in currency for processing;Capture amount in currency for processing;Reversal amount in currency for processing;Currency rate for processing;Provider currency rate;Fee in currency for processing;Transaction id;Reseller commission;Manager commission;Dealer commission;Processor commission;Card expiration date;Destination card expirationDate;Last routing type;Last routing value;IPs region;Processor region;Manager ID;Manager name;Creation time;Customer level
1810032;2023-05-01T17:38:43.00;2023-05-01T17:38:43.00;01.05.2023;;;Demo merchant A;7829;2251;Test Rub Project;RUB;;MasterCard;85.132.102.1;sale;filtered;10137;Billing country blacklisted for merchant;;;;100.000;;555544XXXXXX1111;TEST HOLDER;;;j***b@brown.demo;8***01122;Red*** 1;***;***;;RUS;Jacob;Brown;Test payment;ylT2sut-hqXHxTFspRVUd9Uvcsg;ylT2sut-hqXHxTFspRVUd9Uvcsg;;;;;;;;;;;No;;;;;;;;;;;;;;3197;Test RUB;DEMO2;;;;;https://sandbox.apropay.com/paynet/view-receipt/7829/b6123559-fc64-32fd-9c91-af49a92aa2b9;purpose?;0.000;;;NATIONAL BANK OF RAS AL-KHAIMAH (RAKBANK);;AE;United Arab Emirates;;;Test processor;;;2023-05-01T17:38:43.00;2023-05-01T17:38:43.00;100.000;;zrt;;;;2023-05-01T17:38:43.00;398;RUB;100.000;;;;;;1537212;0.000;0.000;0.000;0.000;203604;;route by Source Credit Card Issuer Country;OTHERS;Unknown;Unknown;76;test_manager;;
1812039;2023-05-04T19:11:29.00;2023-05-04T19:11:29.00;04.05.2023;;;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;Visa;34.129.65.121;preauth;declined;1015;SECURE_3D_TIMEOUT;;;;5.000;;444455XXXXXX1111;TEST HOLDER;;;a***v@example.com;+3***12233;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Test payment;902B4FF5;902B4FF5;;;;;;;3,1244E+11;;;;Yes;;;;;;;;;;;;;;2470;A VISA CC Ams EUR;DEMO1;;;;test1;https://sandbox.apropay.com/paynet/view-receipt/6655/a4b048ad-47ce-33ed-af73-68c7646cee0c;;0.000;;;UNKNOWN;;US;United States;;;Test processor;timeout;;2023-05-04T19:11:29.00;2023-05-04T19:11:29.00;5.000;;2% cyprus;;;;2023-05-04T19:11:29.00;582;USD;5.500;;;1.099663612901000;1.099663612901000;;1539210;0.000;0.000;0.000;0.000;202401;;route by Customer Loyalty;OTHERS;Unknown;Unknown;76;test_manager;;
1812040;2023-05-04T19:11:29.00;2023-05-04T19:11:29.00;04.05.2023;;;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;Visa;34.129.65.121;preauth;declined;1015;SECURE_3D_TIMEOUT;;;;5.000;;444455XXXXXX1111;TEST HOLDER;;;a***v@example.com;+3***12233;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Test payment;902B4FF5;902B4FF5;;;;;;;3,12424E+11;;;;Yes;;;;;;;;;;;;;;2470;A VISA CC Ams EUR;DEMO1;;;;test1;https://sandbox.apropay.com/paynet/view-receipt/6655/270932f6-6687-3127-a32a-2baa6eb1b3f6;;0.000;;;UNKNOWN;;US;United States;;;Test processor;timeout;;2023-05-04T19:11:29.00;2023-05-04T19:11:29.00;5.000;;2% cyprus;;;;2023-05-04T19:11:29.00;582;USD;5.500;;;1.099663612901000;1.099663612901000;;1539211;0.000;0.000;0.000;0.000;202401;;route by Customer Loyalty;OTHERS;Unknown;Unknown;76;test_manager;;
1812037;2023-05-04T19:11:30.00;2023-05-04T19:11:30.00;04.05.2023;;;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;Visa;34.129.65.121;sale;declined;1015;SECURE_3D_TIMEOUT;;;;5.000;;444455XXXXXX1111;TEST HOLDER;;;a***v@example.com;+3***12233;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Rebill order description;902B4FF5;902B4FF5;;;;;;;3,12425E+11;;;;Yes;;;;;;;;;;;;;;2470;A VISA CC Ams EUR;DEMO1;;;;test1;https://sandbox.apropay.com/paynet/view-receipt/6655/711a99be-e32f-3abe-9740-e4bda0c2d372;;0.000;;;UNKNOWN;;US;United States;;;Test processor;timeout;;2023-05-04T19:11:30.00;2023-05-04T19:11:30.00;5.000;;2% cyprus;;;;2023-05-04T19:11:30.00;582;USD;5.500;;;1.099663612901000;1.099663612901000;;1539212;0.000;0.000;0.000;0.000;202401;;route by Customer Loyalty;OTHERS;Unknown;Unknown;76;test_manager;;
1812038;2023-05-04T19:11:30.00;2023-05-04T19:11:30.00;04.05.2023;;;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;Visa;34.129.65.121;sale;declined;1015;SECURE_3D_TIMEOUT;;;;5.000;;444455XXXXXX1111;TEST HOLDER;;;a***v@example.com;+3***12233;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Rebill order description;902B4FF5;902B4FF5;;;;;;;3,12454E+11;;;;Yes;;;;;;;;;;;;;;2470;A VISA CC Ams EUR;DEMO1;;;;test1;https://sandbox.apropay.com/paynet/view-receipt/6655/52e5301a-55a7-3939-9f9c-6a0114e32c15;;0.000;;;UNKNOWN;;US;United States;;;Test processor;timeout;;2023-05-04T19:11:30.00;2023-05-04T19:11:30.00;5.000;;2% cyprus;;;;2023-05-04T19:11:30.00;582;USD;5.500;;;1.099663612901000;1.099663612901000;;1539213;0.000;0.000;0.000;0.000;202401;;route by Customer Loyalty;OTHERS;Unknown;Unknown;76;test_manager;;
1812041;2023-05-04T19:16:26.00;2023-05-04T19:16:26.00;04.05.2023;;;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;Visa;65.153.12.213;sale;declined;1015;SECURE_3D_TIMEOUT;;;;10.420;;444455XXXXXX1111;TEST HOLDER;;;j***h@gmail.com;1***82043;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Test Order Description;902B4FF5;902B4FF5;;;;;;;3,1243E+11;;;;Yes;;;;;;;;;;;;;;2470;A VISA CC Ams EUR;DEMO1;;;;test1;https://sandbox.apropay.com/paynet/view-receipt/6655/06636793-308d-33eb-8a21-77f92b00cd5d;;0.000;;;UNKNOWN;;US;United States;;;Test processor;timeout;190926;2023-05-04T19:16:26.00;2023-05-04T19:16:26.00;10.420;;2% cyprus;;;;2023-05-04T19:16:26.00;582;USD;11.460;;;1.099663612901000;1.099663612901000;;1539214;0.000;0.000;0.000;0.000;202401;;route by Customer Loyalty;OTHERS;Unknown;Unknown;76;test_manager;;
1812042;2023-05-04T19:16:26.00;2023-05-04T19:16:26.00;04.05.2023;;;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;Visa;65.153.12.213;sale;declined;1015;SECURE_3D_TIMEOUT;;;;10.420;;444455XXXXXX1111;TEST HOLDER;;;j***h@gmail.com;1***82043;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Test Order Description;902B4FF5;902B4FF5;;;;;;;3,12453E+11;;;;Yes;;;;;;;;;;;;;;2470;A VISA CC Ams EUR;DEMO1;;;;test1;https://sandbox.apropay.com/paynet/view-receipt/6655/d9a800f3-d915-3099-a769-01f9fcb7d356;;0.000;;;UNKNOWN;;US;United States;;;Test processor;timeout;;2023-05-04T19:16:26.00;2023-05-04T19:16:26.00;10.420;;2% cyprus;;;;2023-05-04T19:16:26.00;582;USD;11.460;;;1.099663612901000;1.099663612901000;;1539215;0.000;0.000;0.000;0.000;202401;;route by Customer Loyalty;OTHERS;Unknown;Unknown;76;test_manager;;
1812688;2023-05-05T17:18:52.00;2023-05-05T17:18:52.00;05.05.2023;;;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;Visa;89.147.253.161;transfer;filtered;10204;Customer data validation failed (firstname, lastname, cardholder, email, phone);;;;10.420;;421070XXXXXX5721;John Doe;;;;;;;;;;;;Your order description;1;1;;;;;;;;;;;No;;;;;;;;;;;;;;2470;A VISA CC Ams EUR;DEMO1;;;;test1;https://sandbox.apropay.com/paynet/view-receipt/6655/402efad3-7e4a-3497-8bd4-792a11074f7f;;0.000;423261XXXXXX1636;JPMORGAN CHASE BANK N.A.;DEMIRBANK OJSC;;AZ;Azerbaijan;US;United States;Test processor;;190924;2023-05-05T17:18:52.00;2023-05-05T17:18:52.00;10.420;;2% cyprus;;;;2023-05-05T17:18:52.00;582;EUR;10.420;;;;;;1539816;0.000;0.000;0.000;0.000;209912;;route by Customer Loyalty;NEW FOR MERCHANT;Unknown;Unknown;76;test_manager;;
1817526;2023-05-16T16:15:13.00;2023-05-16T16:15:13.00;16.05.2023;;;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;Visa;85.132.52.251;sale;approved;;;;;;100.000;PNTEST-1817526;444455XXXXXX1111;TEST HOLDER;;;a***v@example.com;+3***12233;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Test payment;test;1817525;100.000;;504362;502894;;;3,1367E+11;179416949;;;Yes;;;;;;;;;;;;;;2470;A VISA CC Ams EUR;DEMO1;;;;test1;https://sandbox.apropay.com/paynet/view-receipt/6655/fdf7267b-876b-36b8-84a7-2fea7a3685e4;;2.200;;;UNKNOWN;;US;United States;;;Test processor;;;2023-05-16T16:15:13.00;2023-05-16T16:15:13.00;100.000;;2% cyprus;;;;2023-05-16T16:16:11.00;582;USD;108.740;;;1.087320537745000;1.087320537745000;;1544050;0.000;2.200;0.000;1.000;202701;;route by Customer Loyalty;OTHERS;Unknown;Unknown;76;test_manager;;
1817526;2023-05-16T16:15:16.00;2023-05-16T16:15:16.00;16.05.2023;;;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;Visa;85.132.52.251;reversal;approved;;;;;Auto-return;100.000;1,68424E+12;444455XXXXXX1111;TEST HOLDER;;;a***v@example.com;+3***12233;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Test payment;test;1817525;100.000;;504362;502894;;;3,13665E+11;179416949;;;Yes;;;;;;;;;;;;;;2470;A VISA CC Ams EUR;DEMO1;;;;test1;https://sandbox.apropay.com/paynet/view-receipt/6655/fdf7267b-876b-36b8-84a7-2fea7a3685e4;;0.000;;;UNKNOWN;;US;United States;;;Test processor;;;2023-05-16T16:15:13.00;2023-05-16T16:15:13.00;100.000;;2% cyprus;;;;2023-05-16T16:16:11.00;582;USD;108.740;;;1.087320537745000;1.087320537745000;;1544051;0.000;0.000;0.000;0.000;202701;;route by Customer Loyalty;OTHERS;Unknown;Unknown;76;test_manager;;
1817526;2023-05-16T16:16:11.00;2023-05-16T16:16:11.00;16.05.2023;2023-05-16T00:00:00.00;2023-05-16T00:00:00.00;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;Visa;85.132.52.251;chargeback;approved;;;11,1;Card Recovery Bulletin;manual;100.000;1,68424E+12;444455XXXXXX1111;TEST HOLDER;;;a***v@example.com;+3***12233;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Test payment;test;1817525;100.000;;504362;502894;;;3,13665E+11;179416949;;;Yes;;;;;;;;;;;;;;2470;A VISA CC Ams EUR;DEMO1;;;;test1;https://sandbox.apropay.com/paynet/view-receipt/6655/fdf7267b-876b-36b8-84a7-2fea7a3685e4;;0.000;;;UNKNOWN;;US;United States;;;Test processor;;;2023-05-16T16:15:13.00;2023-05-16T16:15:13.00;100.000;;2% cyprus;;;;2023-05-16T16:16:11.00;582;USD;108.740;;;1.087320537745000;1.087320537745000;;1544053;0.000;0.000;0.000;0.000;202701;;route by Customer Loyalty;OTHERS;Unknown;Unknown;76;test_manager;;
1817507;2023-05-16T16:17:24.00;2023-05-16T16:17:24.00;16.05.2023;;;Demo merchant A;9068;1712;Demo Ams EUR;EUR;;Any;85.132.52.251;sale;declined;920084;Request failed: Timer expired. User not paid. Request failed: Timer expired. User not paid.;;;;100.000;;999999XXXXXX9999;Unknown holder;;;a***v@example.com;+3***12233;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Test payment;test;1817503;;;;;;;;;;;No;;;;;;;;;;;;;;4441;Test demo EUR;DEMO3;;;;;https://sandbox.apropay.com/paynet/view-receipt/9068/7f44aae1-10fe-3f05-8271-d94f539fdf6a;;0.000;;;;;;;;;Test processor;920084;;2023-05-16T16:17:24.00;2023-05-16T16:17:24.00;100.000;;2% cyprus;;;;2023-05-16T16:17:24.00;582;EUR;100.000;;;;;;1544054;0.000;0.000;0.000;0.000;202412;;route by Source Credit Card Type;ANY_CREDIT_CARD;Unknown;Unknown;76;test_manager;;
1817527;2023-05-16T16:28:20.00;2023-05-16T16:28:20.00;16.05.2023;;;Demo merchant A;9068;1712;Demo Ams EUR;EUR;;Any;85.132.52.251;sale;declined;920084;Request failed: Timer expired. User not paid. Request failed: Timer expired. User not paid.;;;;100.000;;999999XXXXXX9999;Unknown holder;;;a***v@example.com;+3***12233;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Test payment;test;1817525;;;;;;;;;;;No;;;;;;;;;;;;;;4441;Test demo EUR;DEMO3;;;;;https://sandbox.apropay.com/paynet/view-receipt/9068/33e28fb1-6443-30a1-bac2-d5d1648e38cd;;0.000;;;;;;;;;Test processor;920084;;2023-05-16T16:28:20.00;2023-05-16T16:28:20.00;100.000;;2% cyprus;;;;2023-05-16T16:28:20.00;582;EUR;100.000;;;;;;1544078;0.000;0.000;0.000;0.000;202412;;route by Source Credit Card Type;ANY_CREDIT_CARD;Unknown;Unknown;76;test_manager;;
1824084;2023-05-26T14:44:38.00;2023-05-26T14:44:38.00;26.05.2023;;;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;BANK WIRE;85.132.52.251;transfer;approved;;;;;;55.550;1,6851E+12;;Test full name;7812013775;4,096E+19;j***h@gmail.com;7***29876;;;;;;;;Test payment;inv9157586;inv9157586;;;829695;;;;;;;;No;;;;;;;;;;;;;;2471;B MC CC Ams EUR;AMSTERDAM;;;;;https://sandbox.apropay.com/paynet/view-receipt/6655/43b0c106-0f10-307a-99f8-b3df4823337d;;0.000;;;;;;;;;Test processor;;;2023-05-26T14:44:38.00;2023-05-26T14:44:38.00;55.550;;2% cyprus;;;;2023-05-26T14:44:38.00;582;USD;59.580;;;1.072435511772000;1.072435511772000;;1549073;0.000;0.000;0.000;0.000;0;;route by Purpose;OTHERS;Unknown;Unknown;76;test_manager;2023-05-26T14:44:12.00;
1824082;2023-05-26T15:31:23.00;2023-05-26T15:31:23.00;26.05.2023;;;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;BANK WIRE;85.132.52.251;transfer;declined;1015;SECURE_3D_TIMEOUT;;;;55.550;;;Test ful name;7812013775;4,096E+19;j***h@gmail.com;7***29876;;;;;;;;Test payment;inv9157586;inv9157586;;;;;;;3,14622E+11;;;;Yes;;;;;;;;;;;;;;2471;B MC CC Ams EUR;AMSTERDAM;;;;;https://sandbox.apropay.com/paynet/view-receipt/6655/e5b22b51-c51a-37e3-be9c-3ea581ccf583;;0.000;;;;;;;;;Test processor;timeout;;2023-05-26T15:31:23.00;2023-05-26T15:31:23.00;55.550;;2% cyprus;;;;2023-05-26T15:31:23.00;582;USD;59.580;;;1.072435511772000;1.072435511772000;;1549088;0.000;0.000;0.000;0.000;0;;route by Purpose;OTHERS;Unknown;Unknown;76;test_manager;2023-05-26T14:42:49.00;
1824083;2023-05-26T15:31:23.00;2023-05-26T15:31:23.00;26.05.2023;;;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;BANK WIRE;85.132.52.251;transfer;declined;1015;SECURE_3D_TIMEOUT;;;;500.000;;;Test;7812013775;4,096E+19;j***h@gmail.com;7***29876;;;;;;;;;34T43R77N;34T43R77N;;;;;;;3,14692E+11;;;;Yes;;;;;;;;;;;;;;2471;B MC CC Ams EUR;AMSTERDAM;;;;;https://sandbox.apropay.com/paynet/view-receipt/6655/b580d3c7-8ff1-3cb3-8292-87486edd18c0;;0.000;;;;;;;;;Test processor;timeout;;2023-05-26T15:31:23.00;2023-05-26T15:31:23.00;500.000;;2% cyprus;;;;2023-05-26T15:31:23.00;582;USD;536.220;;;1.072435511772000;1.072435511772000;;1549089;0.000;0.000;0.000;0.000;0;;route by Purpose;OTHERS;Unknown;Unknown;76;test_manager;2023-05-26T14:44:10.00;
1824985;2023-05-29T14:45:00.00;2023-05-29T14:45:00.00;29.05.2023;;;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;Visa;188.253.224.81;sale;approved;;;;;;100.000;PNTEST-1824985;444455XXXXXX1111;TEST HOLDER;;;a***v@example.com;+3***12233;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Test payment;test;1824984;;;115524;407275;;;3,1496E+11;647547344;;;Yes;;;;;;;;;;;;;;2470;A VISA CC Ams EUR;DEMO1;;;;test1;https://sandbox.apropay.com/paynet/view-receipt/6655/3317093d-b5b3-3d09-aa9b-28e1c80166d8;;2.200;;;UNKNOWN;;US;United States;;;Test processor;;;2023-05-29T14:45:00.00;2023-05-29T14:45:00.00;100.000;;2% cyprus;;;;2023-05-29T15:07:30.00;582;USD;107.320;;;1.072435511772000;1.072435511772000;;1550036;0.000;2.200;0.000;1.000;202701;;route by Customer Loyalty;OTHERS;Unknown;Unknown;76;test_manager;2023-05-29T14:40:11.00;
1824987;2023-05-29T14:56:48.00;2023-05-29T14:56:48.00;29.05.2023;;;Demo merchant A;9068;1712;Demo Ams EUR;EUR;;Any;188.253.224.81;sale;declined;920084;Request failed: Timer expired. User not paid. Request failed: Timer expired. User not paid.;;;;100.000;;999999XXXXXX9999;Unknown holder;;;a***v@example.com;+3***12233;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Test payment;test;1824984;;;;;;;;;;;No;;;;;;;;;;;;;;4441;Test demo EUR;DEMO3;;;;;https://sandbox.apropay.com/paynet/view-receipt/9068/e626abe4-52eb-3a25-ae93-19de6ca44023;;0.000;;;;;;;;;Test processor;920084;;2023-05-29T14:56:48.00;2023-05-29T14:56:48.00;100.000;;2% cyprus;;;;2023-05-29T14:56:48.00;582;EUR;100.000;;;;;;1550041;0.000;0.000;0.000;0.000;202412;;route by Source Credit Card Type;ANY_CREDIT_CARD;Unknown;Unknown;76;test_manager;2023-05-29T14:41:45.00;
1824985;2023-05-29T15:07:30.00;2023-05-29T15:07:30.00;29.05.2023;2023-05-29T00:00:00.00;2023-05-29T00:00:00.00;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;Visa;188.253.224.81;retrieval;approved;;;;;manual;100.000;PNTEST-1824985;444455XXXXXX1111;TEST HOLDER;;;a***v@example.com;+3***12233;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Test payment;test;1824984;;;115524;407275;;;3,1496E+11;647547344;;;Yes;;;;;;;;;;;;;;2470;A VISA CC Ams EUR;DEMO1;;;;test1;https://sandbox.apropay.com/paynet/view-receipt/6655/3317093d-b5b3-3d09-aa9b-28e1c80166d8;;0.000;;;UNKNOWN;;US;United States;;;Test processor;;;2023-05-29T14:45:00.00;2023-05-29T14:45:00.00;100.000;;2% cyprus;;;;2023-05-29T15:07:30.00;582;USD;107.320;;;1.073134088104000;1.073134088104000;;1550043;0.000;0.000;0.000;0.000;202701;;route by Customer Loyalty;OTHERS;Unknown;Unknown;76;test_manager;2023-05-29T14:40:11.00;
1826965;2023-05-31T16:42:20.00;2023-05-31T16:42:20.00;31.05.2023;;;Demo merchant A;6655;1712;Demo Ams EUR;EUR;;Visa;188.253.237.101;sale;approved;;;;;;100.000;PNTEST-1826965;444455XXXXXX1111;TEST HOLDER;;;a***v@example.com;+3***12233;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Test payment;test;1826964;;;432862;200594;;;3,15182E+11;302446749;;;Yes;;;;;;;;;;;;;;2470;A VISA CC Ams EUR;DEMO1;;;;test1;https://sandbox.apropay.com/paynet/view-receipt/6655/861f0fd1-9f2e-3acf-9a05-b7f8c927eae3;;2.200;;;UNKNOWN;;US;United States;;;Test processor;;;2023-05-31T16:42:20.00;2023-05-31T16:42:20.00;100.000;;2% cyprus;;;;2023-05-31T16:42:20.00;582;USD;107.220;;;1.072140012909000;1.072140012909000;;1551928;0.000;2.200;0.000;1.000;202601;;route by Customer Loyalty;OTHERS;Unknown;Unknown;76;test_manager;2023-05-31T16:37:25.00;
1826966;2023-05-31T16:53:50.00;2023-05-31T16:53:50.00;31.05.2023;;;Demo merchant A;9068;1712;Demo Ams EUR;EUR;;Any;188.253.237.101;sale;declined;920084;Request failed: Timer expired. User not paid. Request failed: Timer expired. User not paid.;;;;100.000;;999999XXXXXX9999;Unknown holder;;;a***v@example.com;+3***12233;Wes***HX;***;Ams***en;;NLD;Firstname;Lastname;Test payment;test;1826964;;;;;;;;;;;No;;;;;;;;;;;;;;4441;Test demo EUR;DEMO3;;;;;https://sandbox.apropay.com/paynet/view-receipt/9068/4e6c1674-aeb1-3d5e-bbe4-0af9c37fd95d;;0.000;;;;;;;;;Test processor;920084;;2023-05-31T16:53:50.00;2023-05-31T16:53:50.00;100.000;;2% cyprus;;;;2023-05-31T16:53:50.00;582;EUR;100.000;;;;;;1551934;0.000;0.000;0.000;0.000;202412;;route by Source Credit Card Type;ANY_CREDIT_CARD;Unknown;Unknown;76;test_manager;2023-05-31T16:38:47.00;

3.2.7. Custom reports

Users who has an account in Apropay system are able to get a custom report via special POST request made to our API.

URL for this request is: | https://gate.apropay.com/paynet-ui/services/v2/rpt-engine. Report parameters are being sent via JSON.

Warning

JSON templates and supported formats for required custom reports could be provided by support managers upon request.

3.2.8. Custom reports Debug

HTTP method
URL
FileName File name and format should be the same in JSON (UserData)
User data Input JSON content
version
consumer key
consumer secret
timestamp
nonce
signature method

signature base string
signature
authorization header
                                
                            

3.2.9. Libraries

We are using OAuth 1.0a version 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. See more details at OAuth

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 1.0a-secured requests: