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: Swift
This scenario you will probably use the most
-
import IngenicoConnectKit let clientSessionId = "<clientSessionId from Create Session>" let customerId = "<customerId from Create Session>" let baseURL = "<clientApiUrl from Create Session>" let assetBaseURL = "<assetUrl from Create Session>" let appIdentifier = "<your app name>" let session = Session(clientSessionId: clientSessionId, customerId: customerId, baseURL: baseURL, assetBaseURL: assetBaseURL, appIdentifier: appIdentifier) // Retrieve this ID with a createPayment call that you have done via the S2S API let paymentId = "<id of the current payment>" session.communicator.thirdPartyStatus(paymentId: paymentId, success: { thirdPartyStatusResponse in // Process thirdPartyStatus }, failure: { error in Macros.DLog(message: "Error while retrieving thirdPartyStatus: \(error.localizedDescription)") })
Responses
Please find below an overview of the possible responses.
Response 200 - OKThirdPartyStatusResponse
The response contains the current third party status.
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
thirdPartyStatus | string | no | read close |
close
DescriptionThe status returned by the third party.
Possible values:
|
Response example
SDK: Swift
This scenario you will probably use the most
-
{ "thirdPartyStatus" : "WAITING" }