Get Async Payment Instruction Request Status
GET
https://beta-api.monoova.com/au/payto/pas-v1/PaymentInstructionAsync/request/{uniqueRequestId}
Path Parameters
- uniqueRequestIdstringrequiredExampleDescriptionDefault595a3202-e9aa-406e-a2a3-5efb6ca8b72aPattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Responses
200
- PAS.Application.Common.Dtos.AsyncJobResponseExample
{ "traceId": "1dabfaa9-abe8-4d2d-a69a-b723079d84ed", "uniqueRequestId": "595a3202-e9aa-406e-a2a3-5efb6ca8b72a", "paymentInitiationUID": "MONPIR12345", "status": "Processing" }Description- traceIdstringExampleDescriptionDefault1dabfaa9-abe8-4d2d-a69a-b723079d84edPattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- uniqueRequestIdstringExampleDescriptionDefault595a3202-e9aa-406e-a2a3-5efb6ca8b72aPattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- paymentInitiationUIDstringExampleDescriptionDefaultMONPIR12345Pattern^[a-zA-Z0-9_-]{1,35}$
- locationstringExampleDescriptionDefaulthttps://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction/MONPIR12345Pattern^https://.+$
- statusstringExampleDescriptionDefaultProcessingPattern^(Accepted|Processing|Completed|Failed|Expired)$
- errorCodestringExampleDescriptionDefaultPAS_AGREEMENT_NOT_FOUNDPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultThe PaymentAgreement with the provided ID was not found: MONPAG12345Pattern^.+$
201
- PAS.Application.Common.Dtos.AsyncJobResponseExample
{ "traceId": "1dabfaa9-abe8-4d2d-a69a-b723079d84ed", "uniqueRequestId": "595a3202-e9aa-406e-a2a3-5efb6ca8b72a", "paymentInitiationUID": "MONPIR12345", "location": "https://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction/MONPIR12345", "status": "Completed" }Description- traceIdstringExampleDescriptionDefault1dabfaa9-abe8-4d2d-a69a-b723079d84edPattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- uniqueRequestIdstringExampleDescriptionDefault595a3202-e9aa-406e-a2a3-5efb6ca8b72aPattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- paymentInitiationUIDstringExampleDescriptionDefaultMONPIR12345Pattern^[a-zA-Z0-9_-]{1,35}$
- locationstringExampleDescriptionDefaulthttps://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction/MONPIR12345Pattern^https://.+$
- statusstringExampleDescriptionDefaultProcessingPattern^(Accepted|Processing|Completed|Failed|Expired)$
- errorCodestringExampleDescriptionDefaultPAS_AGREEMENT_NOT_FOUNDPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultThe PaymentAgreement with the provided ID was not found: MONPAG12345Pattern^.+$
400
- PAS.Application.Common.Dtos.ErrorResponseExample
{ "traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "errors": [ { "errorCode": "PAS_JOBID_INVALID", "errorMessage": "uniqueRequestId 595a3202 is invalid" } ] }Description- traceIdstringExampleDescriptionDefault4ea61012-2d9b-413d-a5b4-90ad69a68741Pattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- errorsPAS.Application.Common.Dtos.ErrorDto[]Description
- errorCodestringExampleDescriptionDefaultPAS_AMT_REQUIREDPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultpaymentDetails.amount is requiredPattern^.+$
401
403
- PAS.Application.Common.Dtos.ErrorResponseExample
{ "traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "errors": [ { "errorCode": "PAS_FORBIDDEN_ERROR", "errorMessage": "Not allowed to get async request status for account 6279059778044302" } ] }Description- traceIdstringExampleDescriptionDefault4ea61012-2d9b-413d-a5b4-90ad69a68741Pattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- errorsPAS.Application.Common.Dtos.ErrorDto[]Description
- errorCodestringExampleDescriptionDefaultPAS_AMT_REQUIREDPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultpaymentDetails.amount is requiredPattern^.+$
404
- PAS.Application.Common.Dtos.ErrorResponseExample
{ "traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "errors": [ { "errorCode": "PAS_JOB_NOT_FOUND_ERROR", "errorMessage": "Request not found for uniqueRequestId 595a3202-e9aa-406e-a2a3-5efb6ca8b72a" } ] }Description- traceIdstringExampleDescriptionDefault4ea61012-2d9b-413d-a5b4-90ad69a68741Pattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- errorsPAS.Application.Common.Dtos.ErrorDto[]Description
- errorCodestringExampleDescriptionDefaultPAS_AMT_REQUIREDPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultpaymentDetails.amount is requiredPattern^.+$
422
- PAS.Application.Common.Dtos.AsyncJobResponseExample
{ "traceId": "1dabfaa9-abe8-4d2d-a69a-b723079d84ed", "uniqueRequestId": "595a3202-e9aa-406e-a2a3-5efb6ca8b72a", "paymentInitiationUID": "MONPIR12345", "status": "Failed", "errorCode": "PAS_AGREEMENT_NOT_FOUND", "errorMessage": "The PaymentAgreement with the provided ID was not found: MONPAG12345" }Description- traceIdstringExampleDescriptionDefault1dabfaa9-abe8-4d2d-a69a-b723079d84edPattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- uniqueRequestIdstringExampleDescriptionDefault595a3202-e9aa-406e-a2a3-5efb6ca8b72aPattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- paymentInitiationUIDstringExampleDescriptionDefaultMONPIR12345Pattern^[a-zA-Z0-9_-]{1,35}$
- locationstringExampleDescriptionDefaulthttps://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction/MONPIR12345Pattern^https://.+$
- statusstringExampleDescriptionDefaultProcessingPattern^(Accepted|Processing|Completed|Failed|Expired)$
- errorCodestringExampleDescriptionDefaultPAS_AGREEMENT_NOT_FOUNDPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultThe PaymentAgreement with the provided ID was not found: MONPAG12345Pattern^.+$
500
- PAS.Application.Common.Dtos.ErrorResponseExample
{ "traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "errors": [ { "errorCode": "PAS_UNEXPECTED_ERROR", "errorMessage": "Internal server error. Please contact Monoova support." } ] }Description- traceIdstringExampleDescriptionDefault4ea61012-2d9b-413d-a5b4-90ad69a68741Pattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- errorsPAS.Application.Common.Dtos.ErrorDto[]Description
- errorCodestringExampleDescriptionDefaultPAS_AMT_REQUIREDPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultpaymentDetails.amount is requiredPattern^.+$
502
- PAS.Application.Common.Dtos.ErrorResponseExample
{ "traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "errors": [ { "errorCode": "PAS_NPP_GATEWAY_ERROR", "errorMessage": "Error returned from NPP gateway - service unavailable" } ] }Description- traceIdstringExampleDescriptionDefault4ea61012-2d9b-413d-a5b4-90ad69a68741Pattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- errorsPAS.Application.Common.Dtos.ErrorDto[]Description
- errorCodestringExampleDescriptionDefaultPAS_AMT_REQUIREDPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultpaymentDetails.amount is requiredPattern^.+$
504
- PAS.Application.Common.Dtos.ErrorResponseExample
{ "traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "errors": [ { "errorCode": "PAS_NPP_GATEWAY_TIMEOUT", "errorMessage": "Timeout calling NPP gateway" } ] }Description- traceIdstringExampleDescriptionDefault4ea61012-2d9b-413d-a5b4-90ad69a68741Pattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- errorsPAS.Application.Common.Dtos.ErrorDto[]Description
- errorCodestringExampleDescriptionDefaultPAS_AMT_REQUIREDPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultpaymentDetails.amount is requiredPattern^.+$
curl
curl --request GET \
--url https://beta-api.monoova.com/au/payto/pas-v1/PaymentInstructionAsync/request/{uniqueRequestId} \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://beta-api.monoova.com/au/payto/pas-v1/PaymentInstructionAsync/request/{uniqueRequestId}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://beta-api.monoova.com/au/payto/pas-v1/PaymentInstructionAsync/request/{uniqueRequestId}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://beta-api.monoova.com/au/payto/pas-v1/PaymentInstructionAsync/request/{uniqueRequestId}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// OK. The request is still being processed.
{
"traceId": "1dabfaa9-abe8-4d2d-a69a-b723079d84ed",
"uniqueRequestId": "595a3202-e9aa-406e-a2a3-5efb6ca8b72a",
"paymentInitiationUID": "MONPIR12345",
"location": "https://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction/MONPIR12345",
"status": "Processing",
"errorCode": "PAS_AGREEMENT_NOT_FOUND",
"errorMessage": "The PaymentAgreement with the provided ID was not found: MONPAG12345"
}201
// Created. The request completed successfully. location contains the URL of the created payment instruction.
{
"traceId": "1dabfaa9-abe8-4d2d-a69a-b723079d84ed",
"uniqueRequestId": "595a3202-e9aa-406e-a2a3-5efb6ca8b72a",
"paymentInitiationUID": "MONPIR12345",
"location": "https://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction/MONPIR12345",
"status": "Processing",
"errorCode": "PAS_AGREEMENT_NOT_FOUND",
"errorMessage": "The PaymentAgreement with the provided ID was not found: MONPAG12345"
}400
// Bad Request. The request failed validation. See errors for details.
{
"traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
"errors": [
{
"errorCode": "PAS_AMT_REQUIRED",
"errorMessage": "paymentDetails.amount is required"
}
]
}401
// Unauthorized. The bearer token is missing, invalid or expired. Bearer tokens are valid for 24 hours; generate a new token and retry.
403
// Forbidden. Your account is not permitted to perform this operation.
{
"traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
"errors": [
{
"errorCode": "PAS_AMT_REQUIRED",
"errorMessage": "paymentDetails.amount is required"
}
]
}404
// Not Found. The async request could not be found.
{
"traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
"errors": [
{
"errorCode": "PAS_AMT_REQUIRED",
"errorMessage": "paymentDetails.amount is required"
}
]
}422
// Unprocessable Content. The background job failed. See errorCode and errorMessage for the reason.
{
"traceId": "1dabfaa9-abe8-4d2d-a69a-b723079d84ed",
"uniqueRequestId": "595a3202-e9aa-406e-a2a3-5efb6ca8b72a",
"paymentInitiationUID": "MONPIR12345",
"location": "https://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction/MONPIR12345",
"status": "Processing",
"errorCode": "PAS_AGREEMENT_NOT_FOUND",
"errorMessage": "The PaymentAgreement with the provided ID was not found: MONPAG12345"
}500
// Internal Server Error. An unexpected error occurred. Contact Monoova support if the problem persists.
{
"traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
"errors": [
{
"errorCode": "PAS_AMT_REQUIRED",
"errorMessage": "paymentDetails.amount is required"
}
]
}502
// Bad Gateway. An upstream service, such as the NPP gateway, returned an error. Retry the request later.
{
"traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
"errors": [
{
"errorCode": "PAS_AMT_REQUIRED",
"errorMessage": "paymentDetails.amount is required"
}
]
}504
// Gateway Timeout. An upstream service, such as the NPP gateway, did not respond in time. Retry the request later.
{
"traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
"errors": [
{
"errorCode": "PAS_AMT_REQUIRED",
"errorMessage": "paymentDetails.amount is required"
}
]
}