PayID Resolution

curl --request POST \
     --url https://sand-api.monoova.com/au/core/payman-v1/PayId/PayIdResolution \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data-raw '{
     "payId": "[email protected]",
     "payIdType": "email"
     }'

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "payId": "[email protected]",
   "payIdType": "email"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://sand-api.monoova.com/au/core/payman-v1/PayId/PayIdResolution", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

require "uri"
require "json"
require "net/http"

url = URI("https://sand-api.monoova.com/au/core/payman-v1/PayId/PayIdResolution")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "payId": "[email protected]",
   "payIdType": "email"
})

response = https.request(request)
puts response.read_body

import requests
import json

url = "https://sand-api.monoova.com/au/core/payman-v1/PayId/PayIdResolution"

payload = json.dumps({
   "payId": "[email protected]",
   "payIdType": "email"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

// OK. The request was processed successfully and the PayID resolution result is returned.
{
  "traceId": "0HMV9K2P4N7QT:00000001",
  "payIdName": "JOHN SMITH",
  "payIdRegistered": "2024-03-18T09:15:00Z",
  "bankAccountNumber": "123456789"
}

// Bad Request. The request failed validation, for example payId doesn't match the format for the supplied payIdType. The errors array names each failure through errorCode, with a readable errorMessage. Correct the request before you send it again; resending the identical request returns the same 400.
Error codes returned with this status:

PAY_PAYID_VALUE_REQUIRED: payId is missing.
PAY_PAYID_VALUE_INVALID: payId doesn't match the format for the supplied payIdType.
PAY_PAYID_TYPE_REQUIRED: payIdType is missing.
PAY_PAYID_TYPE_INVALID: payIdType isn't one of the accepted values.
PAY_REQUEST_EMPTY: the request body is empty.
PAY_REQ_BODY_INVALID: the request body is badly formed and can't be parsed.
PAY_VALIDATION_ERROR: the request failed validation; errorMessage gives the detail.
PAY_INPUT_INJECTION_DETECTED: the request contains potentially malicious content.
PAY_VERSION_INVALID: the request version is invalid.
PAY_VERSION_UNSUPPORTED: the request version isn't supported.
{
  "traceId": "0HMV9K2P4N7QT:00000002",
  "errors": [
    {
      "errorCode": "PAY_PAYID_VALUE_INVALID",
      "errorMessage": "Invalid PayId value. Please provide a valid value based on the PayId type."
    }
  ]
}

// Unauthorized. The bearer token is missing, malformed or has expired. Generate a new token and send it in the Authorization header as Bearer <token>. Don't retry with the same token. To generate a token, see https://developer.monoova.com/api/generate-a-bearer-token.
{
  "traceId": "0HMV9K2P4N7QT:00000003",
  "errors": [
    {
      "errorCode": "TBC_401_ERROR_CODE",
      "errorMessage": "TBC - confirm the 401 error message before publishing."
    }
  ]
}

// Forbidden. The bearer token was accepted, but your account isn't permitted to use PayID Resolution. This is an access problem, not a data problem: the same request keeps returning 403 until Monoova updates your account's access. Contact Monoova support and don't retry automatically.
{
  "traceId": "0HMV9K2P4N7QT:00000004",
  "errors": [
    {
      "errorCode": "TBC_403_ERROR_CODE",
      "errorMessage": "TBC - confirm the 403 error message before publishing."
    }
  ]
}

// Not Found. No PayID matching the supplied payId was found. Check the payId and payIdType values before you try again.
Error codes returned with this status:

PAY_PAYID_NOT_FOUND: the PayID wasn't found.
{
  "traceId": "0HMV9K2P4N7QT:00000005",
  "errors": [
    {
      "errorCode": "PAY_PAYID_NOT_FOUND",
      "errorMessage": "PayId [email protected] not found."
    }
  ]
}

// Internal Server Error. An unexpected error occurred while processing the request. Quote the traceId when you contact Monoova support.
Error codes returned with this status:

PAY_UNEXPECTED_ERROR: an unexpected internal error occurred.
PAY_OBJ_CREATE_ERROR: an internal record couldn't be created.
{
  "traceId": "0HMV9K2P4N7QT:00000006",
  "errors": [
    {
      "errorCode": "PAY_UNEXPECTED_ERROR",
      "errorMessage": "Internal server error. Please contact Monoova support."
    }
  ]
}

// Bad Gateway. The NPP gateway returned an error while resolving the PayID, and errorMessage includes the detail returned by the gateway. Try again later, and quote the traceId if you contact Monoova support.
Error codes returned with this status:

PAY_NPP_GATEWAY_ERROR: the NPP gateway returned an error.
{
  "traceId": "0HMV9K2P4N7QT:00000007",
  "errors": [
    {
      "errorCode": "PAY_NPP_GATEWAY_ERROR",
      "errorMessage": "Error returned from NPP gateway - <error detail from the NPP gateway>"
    }
  ]
}

// Gateway Timeout. An upstream gateway didn't respond in time. Try again later, and quote the traceId if you contact Monoova support.
Error codes returned with this status:

PAY_NPP_GATEWAY_TIMEOUT: the NPP gateway timed out.
PAY_CPL_GATEWAY_TIMEOUT: the CPL gateway timed out.
{
  "traceId": "0HMV9K2P4N7QT:00000008",
  "errors": [
    {
      "errorCode": "PAY_NPP_GATEWAY_TIMEOUT",
      "errorMessage": "Timeout from NPP gateway"
    }
  ]
}