Merchant API
Get Status by Payment ID
Home
Token
Merchant API
Customer
- 2FA
- AccessControl
- Active Session
- Credentials
- Customer
- Organization
- Profile Picture
Open Banking API
- Introduction
- POSTToken
- Account
- TPP
Merchant API
Get Status by Payment ID
This API helps the user to fetch status of the transaction at IPG side, by using the Payment ID
GET
/
payment
/
payments
/
{paymentId}
/
status-by-payment-id
curl --request GET \
--url https://gateway.cyrexa.com/ipg/1.0.0/payment/payments/{paymentId}/status-by-payment-id \
--header 'Authorization: Bearer <token>' \
--header 'organizationId: <organizationid>'
{
"data": {
"result": {
"code": 123,
"description": "<string>"
},
"paymentId": "<string>",
"timestamp": "<string>",
"paymentBrand": "<string>",
"paymentMode": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"amount": "<string>",
"descriptor": "<string>",
"currency": "<string>",
"card": {
"bin": "<string>",
"last4Digits": "<string>",
"holder": "<string>",
"expiryMonth": "<string>",
"expiryYear": "<string>"
},
"transactionStatus": "<string>",
"merchantTransactionId": "<string>",
"remark": "<string>",
"status": {
"detail": "<string>"
}
}
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Path Parameters
Response
200
text/plain
Success
curl --request GET \
--url https://gateway.cyrexa.com/ipg/1.0.0/payment/payments/{paymentId}/status-by-payment-id \
--header 'Authorization: Bearer <token>' \
--header 'organizationId: <organizationid>'
{
"data": {
"result": {
"code": 123,
"description": "<string>"
},
"paymentId": "<string>",
"timestamp": "<string>",
"paymentBrand": "<string>",
"paymentMode": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"amount": "<string>",
"descriptor": "<string>",
"currency": "<string>",
"card": {
"bin": "<string>",
"last4Digits": "<string>",
"holder": "<string>",
"expiryMonth": "<string>",
"expiryYear": "<string>"
},
"transactionStatus": "<string>",
"merchantTransactionId": "<string>",
"remark": "<string>",
"status": {
"detail": "<string>"
}
}
}