getPayments

The getPayments web method can be used for retrieving the list of payments and their details (states) for a given merchantTransactionID.

📘

merchantTransaction : payment

The general case is to have a single payment for a given merchantTransactionID. It is also possible, however, to have several payments associated with the same merchantTransactionID, e.g. in case of Redirect Integration when the user retries several times.

If the Merchant System implements the Payment Service Listener v3 API then the information about the created payments will be pushed to him, and the the getPayments web method will not be needed. In certain cases, however, the merchant may decide to invoke getPayments immediately after initiatePayment web method to pull immediately the status of the newly created payment.

getPaymentsRequest fields

field (type, required)

description

merchantID
(stringID, required)

Merchant ID

shopID
(stringID, required)

Shop ID

merchantTransactionID
(stringID, required)

Merchant’s transaction ID (order ID, purchase ID, sale ID ...). There is 1:n relationship between Merchant Transaction and Payment entities in the context of PXP Financial Payment Service.

isExecuted
(boolean)

If specified, filters for executed payments only

getPaymentsResponse fields

field (type, required)

description

payments
(array of paymentWithState, required)

Contains a collection of paymentWithState entities associated with the given merchantTransactionID.

Language
Authentication
Basic
base64
: