Third party status poll

GET https://{domainname}/client/v1/{customerId}/payments/{paymentId}/thirdpartystatus

Payments

Through this API you can retrieve information that is specific to a payment.

Request

Polls a third party for the status of the payment.

Currently only available for payments performed with payment products 3012 (Bancontact) and 863 (WeChat Pay). In the case of Bancontact, it is used to determine if the customer is paying using the Bancontact app and if so, what the payment status is.

Request example

SDK: JavaScript

This scenario you will probably use the most

// Note: a successful response from Create Session can be used directly as sessionDetails
var sessionDetails = {
    "clientSessionId": "<clientSessionId from Create Session>",
    "customerId": "<customerId from Create Session>",
    "clientApiUrl": "<clientApiUrl from Create Session>",
    "assetUrl": "<assetUrl from Create Session>"
};
var session = new connect(sessionDetails);

var paymentId = "paymentId";

session.getThirdPartyPaymentStatus(paymentId).then(function (thirdPartyPaymentStatus) {
    // Process third party payment status
}, function () {
    // Indicate an error occurred
});

Responses

Please find below an overview of the possible responses.

Response 200 - OKThirdPartyStatusResponse

The response contains the current third party status.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
thirdPartyStatus	string	no	read close
close Description The status returned by the third party. Possible values: WAITING - The customer has not connected to the third party INITIALIZED - Authentication in progress AUTHORIZED - Payment in progress COMPLETED - The customer has completed the payment at the third party

Response example