Resend an Existing Webhook Notification

POST

https://api.mpay.com.au/subscriptions/v2/resend/{id}

Resends a webhook notification that was previously generated, for example after your endpoint returned an error.

Path Parameters

idstringrequired
Example
885321
Description
Required. The Id of the webhook notification you want to resend. Use the webhookId returned by the Webhook Notifications Report endpoint.
Default
885321
Pattern
^[0-9]{1,12}$

Responses

200Success. The notification was queued for resending and the processing result is returned.

subscriptionListResponse_V2
- durationMsinteger
  Example
  213
  Description
  This value represents the total time in milliseconds that the Platform took to process the request.
  Default
  213
  Pattern
  ^[0-9]{1,7}$
- statusstring
  Example
  Ok
  Description
  This is the status of the request. A code of 'Ok' indicates no errors.
  Default
  Ok
  Pattern
  ^[A-Za-z]{2,30}$
- statusDescriptionstring
  Example
  Operation completed successfully
  Description
  This is a description of the status. If an 'Ok' status is returned, then this will be 'Operation completed successfully'.
  Default
  Operation completed successfully
  Pattern
  ^.{1,500}$
- debugobject
  Description
  Diagnostic detail about how the request was processed. These fields are intended for troubleshooting and support enquiries only.
  - signInMAccountDetailsstring
    Example
    mAccount: 4210000000 (Active)
    Description
    Conditional. Diagnostic detail about the signed-in mAccount used to authenticate the request. Returned for troubleshooting only.
    Default
    mAccount: 4210000000 (Active)
    Pattern
    ^.{0,500}$
  - finalSignInMAccountFinancialsstring
    Example
    Balance: 15000.00, Available: 15000.00
    Description
    Conditional. Snapshot of the signed-in mAccount financial position after the request was processed. Returned for troubleshooting only.
    Default
    Balance: 15000.00, Available: 15000.00
    Pattern
    ^.{0,500}$
  - initialSignInMAccountFinancialsstring
    Example
    Balance: 15000.00, Available: 15000.00
    Description
    Conditional. Snapshot of the signed-in mAccount financial position before the request was processed. Returned for troubleshooting only.
    Default
    Balance: 15000.00, Available: 15000.00
    Pattern
    ^.{0,500}$
  - traceLogIdstring
    Example
    8f3c1d92-5b47-4a10-9f2e-6c7d81ab0e55
    Description
    Unique trace identifier for this request. Quote this value when raising a support enquiry with Monoova.
    Default
    8f3c1d92-5b47-4a10-9f2e-6c7d81ab0e55
    Pattern
    ^[A-Za-z0-9-]{1,64}$
  - exceptionIdinteger
    Example
    40312
    Description
    Conditional. Identifier of the exception raised while processing the request. Null when the request completed without error.
    Default
    40312
    Pattern
    ^[0-9]{1,10}$
  - exceptionMsgstring
    Example
    Notification could not be resent because the subscription is inactive.
    Description
    Conditional. Description of the exception raised while processing the request. Empty when the request completed without error.
    Default
    Notification could not be resent because the subscription is inactive.
    Pattern
    ^.{0,500}$

400

Bad request. The request could not be processed because one or more fields are missing, malformed, or failed validation. Check the statusDescription for the field at fault, correct it and retry.

errorResponse
Example
```
{
  "durationMs": 12,
  "status": "Error",
  "statusDescription": "Validation failed: targetUrl is required and must be a valid URL."
}
```
Description
Standard error envelope returned for 400, 401 and 500 responses.
- durationMsinteger
  Example
  12
  Description
  This value represents the total time in milliseconds that the Platform took to process the request.
  Default
  12
  Pattern
  ^[0-9]{1,7}$
- statusstring
  Example
  Error
  Description
  This is the status of the request. A code of 'Ok' indicates no errors. For an error response this will be a failure code such as 'Error', 'Unauthorized' or 'Exception'.
  Default
  Error
  Pattern
  ^[A-Za-z]{2,30}$
- statusDescriptionstring
  Example
  Validation failed: targetUrl is required and must be a valid URL.
  Description
  This is a description of the status. For an error response this explains what failed and, where possible, names the field at fault.
  Default
  Validation failed: targetUrl is required and must be a valid URL.
  Pattern
  ^.{1,500}$

401

Unauthorized. The request did not include valid basic authentication credentials, or the API key supplied is inactive or not permitted to use this endpoint. Confirm the API key is passed as the basic authentication username and retry.

errorResponse
Example
```
{
  "durationMs": 4,
  "status": "Unauthorized",
  "statusDescription": "Authentication failed. Check the API key supplied as the username."
}
```
Description
Standard error envelope returned for 400, 401 and 500 responses.
- durationMsinteger
  Example
  12
  Description
  This value represents the total time in milliseconds that the Platform took to process the request.
  Default
  12
  Pattern
  ^[0-9]{1,7}$
- statusstring
  Example
  Error
  Description
  This is the status of the request. A code of 'Ok' indicates no errors. For an error response this will be a failure code such as 'Error', 'Unauthorized' or 'Exception'.
  Default
  Error
  Pattern
  ^[A-Za-z]{2,30}$
- statusDescriptionstring
  Example
  Validation failed: targetUrl is required and must be a valid URL.
  Description
  This is a description of the status. For an error response this explains what failed and, where possible, names the field at fault.
  Default
  Validation failed: targetUrl is required and must be a valid URL.
  Pattern
  ^.{1,500}$

500

Internal server error. An unexpected error occurred while processing the request. The request may not have been completed — do not assume the subscription changed. Retry the request and, if the error persists, contact Monoova support quoting the statusDescription.

errorResponse
Example
```
{
  "durationMs": 5312,
  "status": "Exception",
  "statusDescription": "An unexpected error occurred while processing the request. Please contact Monoova support."
}
```
Description
Standard error envelope returned for 400, 401 and 500 responses.
- durationMsinteger
  Example
  12
  Description
  This value represents the total time in milliseconds that the Platform took to process the request.
  Default
  12
  Pattern
  ^[0-9]{1,7}$
- statusstring
  Example
  Error
  Description
  This is the status of the request. A code of 'Ok' indicates no errors. For an error response this will be a failure code such as 'Error', 'Unauthorized' or 'Exception'.
  Default
  Error
  Pattern
  ^[A-Za-z]{2,30}$
- statusDescriptionstring
  Example
  Validation failed: targetUrl is required and must be a valid URL.
  Description
  This is a description of the status. For an error response this explains what failed and, where possible, names the field at fault.
  Default
  Validation failed: targetUrl is required and must be a valid URL.
  Pattern
  ^.{1,500}$

curl

curl --request POST \
     --url https://api.mpay.com.au/subscriptions/v2/resend/{id} \
     --header 'accept: application/json'

javascript

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

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

fetch("https://api.mpay.com.au/subscriptions/v2/resend/{id}", 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://api.mpay.com.au/subscriptions/v2/resend/{id}")

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"

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

python

import requests
import json

url = "https://api.mpay.com.au/subscriptions/v2/resend/{id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// Success. The notification was queued for resending and the processing result is returned.
{
  "durationMs": 213,
  "status": "Ok",
  "statusDescription": "Operation completed successfully",
  "debug": {
    "signInMAccountDetails": "mAccount: 4210000000 (Active)",
    "finalSignInMAccountFinancials": "Balance: 15000.00, Available: 15000.00",
    "initialSignInMAccountFinancials": "Balance: 15000.00, Available: 15000.00",
    "traceLogId": "8f3c1d92-5b47-4a10-9f2e-6c7d81ab0e55",
    "exceptionId": 40312,
    "exceptionMsg": "Notification could not be resent because the subscription is inactive."
  }
}

400

// Bad request. The request could not be processed because one or more fields are missing, malformed, or failed validation. Check the statusDescription for the field at fault, correct it and retry.
{
  "durationMs": 12,
  "status": "Error",
  "statusDescription": "Validation failed: targetUrl is required and must be a valid URL."
}

401

// Unauthorized. The request did not include valid basic authentication credentials, or the API key supplied is inactive or not permitted to use this endpoint. Confirm the API key is passed as the basic authentication username and retry.
{
  "durationMs": 12,
  "status": "Error",
  "statusDescription": "Validation failed: targetUrl is required and must be a valid URL."
}

500

// Internal server error. An unexpected error occurred while processing the request. The request may not have been completed — do not assume the subscription changed. Retry the request and, if the error persists, contact Monoova support quoting the statusDescription.
{
  "durationMs": 12,
  "status": "Error",
  "statusDescription": "Validation failed: targetUrl is required and must be a valid URL."
}