Diagnose Interface

The Diagnose request will send a request to the payment gateway which will verify the capture or chargeback status of a transaction. If the requested transaction has a capture or chargeback, the status of this will be sent back. If the Diagnose requests are send correctly to the system, the Diagnose interface will send back the transactions via XML Response.

Below is the diagnose URL for our test environment ( diagnose )

POST URL: https://sandbox.powerpay21.com/pay/backoffice/tx_diagnose

1. REQUEST PARAMETERS WITH TRANSACTION-ID

The POST request should contain the following mandatory components:

Test Credentials

EXAMPLE :

Diagnose Request & Response with transaction-id

Diagnose Request

Field Name	Type	Length		Mandatory?	Description
merchantid	alphanumeric	40 characters		✔	merchant identification
type	alphanumeric			✔	tx
transactionid	numeric	empty or transactionid	payment gateway transaction identification	✔	numeric
signature	hex	40 characters	SHA1–Hash	✔	Signature Calculation

Diagnose Response

Field Name	Type	Content	Description
amount	numeric	empty or amount value	amount
creation_date	alphanumeric	creation date	Date and time for transaction insert into payment gateway
currency	char	empty or currency value	currency
custom1	alphanumeric	Custom1	Custom 1
error_code	alphanumeric	Error Code	0-successful, 2000-pending, otherwise-failed
order_id	alphanumeric	empty or orderid value	orderid in the merchant shop system
type	char	Type	Type

2. REQUEST PARAMETERS WITH ORDER-ID

The POST request should contain the following mandatory components:

Test Credentials

EXAMPLE :

Diagnose Request & Response with orderid

Diagnose Request

Field Name	Type	Length	Format	Mandatory?	Description
merchantid	alphanumeric	40 characters		✔	merchant identification
type	character			✔	orderid
orderid	alphanumeric	max 30 characters		✔	orderid in merchant shop system
start_date	alphanumeric	10 characters	dd.mm.yyyy	✔	start time frame
end_date	alphanumeric	10 characters	dd.mm.yyyy	✔	end time frame
signature	hex	40 characters	SHA1–Hash	✔	Signature Calculation

Diagnose Response

Field Name	Type	Content	Description
amount	numeric	empty or amount value	amount
creation_date	alphanumeric	creation date	Date and time for transaction insert into payment gateway
currency	char	empty or currency value	currency
custom1	alphanumeric	Custom1	Custom 1
error_code	alphanumeric	Error Code	0-successful, 2000-pending, otherwise-failed
order_id	alphanumeric	empty or orderid value	orderid in the merchant shop system
type	char	Type	Type

3. REQUEST PARAMETERS WITH TYPE = CAPTURE

The POST request should contain the following mandatory components:

Test Credentials

EXAMPLE :

Diagnose Request & Response for Capture

Diagnose Request

Field Name	Type	Length	Format	Mandatory?	Description
merchantid	alphanumeric	40 characters		✔	merchant identification
type	character			✔	capture
start_date	alphanumeric	10 characters	dd.mm.yyyy	✔	start time frame
end_date	alphanumeric	10 characters	dd.mm.yyyy	✔	end time frame
signature	hex	40 characters	SHA1–Hash	✔	Signature Calculation

Diagnose Response

Field Name	Type	Format	Description
orderid	alphanumeric	empty or orderid value	orderid in the merchant shop system
transactionid	numeric	empty or transactionid	payment gateway transaction identification
amount	numeric	amount or empty value	number
currency	char	empty or currency value	currency
booking_date	alphanumeric	dd.mm.yyyy	booking time frame
issue_date	alphanumeric	dd.mm.yyyy	issued time frame

4. REQUEST PARAMETERS WITH TYPE = CHB ( CHARGEBACKS)

The POST request should contain the following mandatory components:

Test Credentials

EXAMPLE :

Diagnose Request & Response for Chargeback

Diagnose Request

Field Name	Type	Length	Format	Mandatory?	Description
merchantid	alphanumeric	40 characters		✔	merchant identification
type	alphanumeric			✔	chb
transactionid	numeric	empty or transactionid	payment gateway transaction identification	✔	numeric
start_date	alphanumeric	10 characters	dd.mm.yyyy	✔	start time frame
end_date	alphanumeric	10 characters	dd.mm.yyyy	✔	end time frame
signature	hex	40 characters	SHA1–Hash	✔	Signature Calculation

Diagnose Response

Field Name	Type	Format	Description
orderid	alphanumeric	empty or orderid value	orderid in the merchant shop system
transactionid	numeric	empty or transactionid	payment gateway transaction identification
amount	numeric	amount or empty value	number
currency	char	empty or currency value	currency
booking_date	alphanumeric	dd.mm.yyyy	booking time frame
issue_date	alphanumeric	dd.mm.yyyy	issued time frame

5. REQUEST PARAMETERS WITH TYPE = PENDING

The POST request should contain the following mandatory components:

Test Credentials

EXAMPLE :

Diagnose Request & Response for Pending

Diagnose Request

Field Name	Type	Length	Format	Mandatory?	Description
merchantid	alphanumeric	40 characters		✔	merchant identification
type	character			✔	pending
start_date	alphanumeric	10 characters	dd.mm.yyyy	✔	start time frame
end_date	alphanumeric	10 characters	dd.mm.yyyy	✔	end time frame
signature	hex	40 characters	SHA1–Hash	✔	Signature Calculation

Diagnose Response

Field Name	Type	Format	Description
orderid	alphanumeric	empty or orderid value	orderid in the merchant shop system
transactionid	numeric	empty or transactionid	payment gateway transaction identification
amount	numeric	amount or empty value	number
currency	char	empty or currency value	currency
booking_date	alphanumeric	dd.mm.yyyy	booking time frame
issue_date	alphanumeric	dd.mm.yyyy	issued time frame

6. REQUEST PARAMETERS WITH TYPE = FAILED

The POST request should contain the following mandatory components:

Test Credentials

EXAMPLE :

Diagnose Request & Response for Failed

Diagnose Request

Field Name	Type	Length	Format	Mandatory?	Description
merchantid	alphanumeric	40 characters		✔	merchant identification
type	character			✔	failed
start_date	alphanumeric	10 characters	dd.mm.yyyy	✔	start time frame
end_date	alphanumeric	10 characters	dd.mm.yyyy	✔	end time frame
signature	hex	40 characters	SHA1–Hash	✔	Signature Calculation

Diagnose Response

Field Name	Type	Format	Description
orderid	alphanumeric	empty or orderid value	orderid in the merchant shop system
transactionid	numeric	empty or transactionid	payment gateway transaction identification
amount	numeric	amount or empty value	number
currency	char	empty or currency value	currency
booking_date	alphanumeric	dd.mm.yyyy	booking time frame
issue_date	alphanumeric	dd.mm.yyyy	issued time frame

7. REQUEST PARAMETERS WITH TYPE = RETRIEVAL-REQUEST

The POST request should contain the following mandatory components:

Test Credentials

EXAMPLE :

Diagnose Request & Response for Retrieval-request

Diagnose Request

Field Name	Type	Length	Format	Mandatory?	Description
merchantid	alphanumeric	40 characters		✔	merchant identification
type	character			✔	retrieval_request
start_date	alphanumeric	10 characters	dd.mm.yyyy	✔	start time frame
end_date	alphanumeric	10 characters	dd.mm.yyyy	✔	end time frame
signature	hex	40 characters	SHA1–Hash	✔	Signature Calculation

Diagnose Response

Field Name	Type	Format	Description
orderid	alphanumeric	empty or orderid value	orderid in the merchant shop system
transactionid	numeric	empty or transactionid	payment gateway transaction identification
amount	numeric	amount or empty value	number
currency	char	empty or currency value	currency
booking_date	alphanumeric	dd.mm.yyyy	booking time frame
issue_date	alphanumeric	dd.mm.yyyy	issued time frame

8. REQUEST PARAMETERS WITH TYPE = REFUND

The POST request should contain the following mandatory components:

Test Credentials

EXAMPLE :

Diagnose Request & Response for Refund

Diagnose Request

Field Name	Type	Length	Format	Mandatory?	Description
merchantid	alphanumeric	40 characters		✔	merchant identification
type	character			✔	refund
start_date	alphanumeric	10 characters	dd.mm.yyyy	✔	start time frame
end_date	alphanumeric	10 characters	dd.mm.yyyy	✔	end time frame
signature	hex	40 characters	SHA1–Hash	✔	Signature Calculation

Diagnose Response

Field Name	Type	Format	Description
orderid	alphanumeric	empty or orderid value	orderid in the merchant shop system
transactionid	numeric	empty or transactionid	payment gateway transaction identification
amount	numeric	amount or empty value	number
currency	char	empty or currency value
error_code	alphanumeric	Error code
issue_date	alphanumeric	dd.mm.yyyy
refund_date	alphanumeric	dd.mm.yyyy

Here is a list of the possible types one can get in the response

type=invoce -> authorized
type=booked -> captured
type=refund
type=chargeback
type=retrieval_request
type=partial booking -> partial capture
type=reversal

Note: The end_date is inclusive, e.g. if you want to get a list of all transactions imported into the payment gateway on the 1st of May 2015 for example, your start_date and end_date would both be <01.05.2015>.