GET PaymentStatusCheck by context, contextId

Overview

Retrieve payment status by context id and paymentProcessAuditId

Request

GET /[context]/[contextId]/PaymentStatusCheck?paymentProcessAuditAdyenId=[paymentProcessAuditAdyenId]

Request Information

Request Parameters

Name
Type
Requirement
Description
context
String
Mandatory 
Context in Request URI should be 'bookings' or 'customers'
contextId
Integer
Mandatory 
ContextId in Request URI should be Booking ID or Customer ID
paymentProcessAuditAdyenId
String
Optional 
Adyen ID of the payment process audit record created when the payment was processed. This is used to retrieve payment status for a specific payment process audit record in Payment Status Check endpoint

Response Information

Response Properties

Name
Type
Description
paymentStatuses
List<PaymentStatusResponse>
List of Payment Statuses

Paymentstatuses

Name
Type
Description
paymentProcessAuditAdyenId
Integer
Adyen payment process audit ID
paymentStatus
String
Status of the payment
adyenPaymentType
String
Adyen payment type for payment
failureMessage
String
Failure message if payment was unsuccessful

Response Codes

HTTP status code
Description
200 OK
The resource was retrieved successfully
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
404 Not Found
The specified resource was not found
500 Internal Server Error
An unexpected error occurred on the API server

Response Example

{
  "paymentStatuses": [
    {
      "paymentProcessAuditAdyenId": 123456,
      "paymentStatus": "pending",
      "adyenPaymentType": "payto",
      "failureMessage": "Payment failed due to insufficient funds"
    },
    {
      "paymentProcessAuditAdyenId": 123456,
      "paymentStatus": "pending",
      "adyenPaymentType": "payto",
      "failureMessage": "Payment failed due to insufficient funds"
    }
  ]
}