PATCH /v1.1/online-payments/payment-request/code/reminder

Request headers

Attribute	Type	Condition	Description
X-Request-ID	UUID	Mandatory	ID of the request, unique to the call.
Authorization	String	Mandatory	The oAuth2 Bearer token
API-Key	String	Mandatory	The Client ID obtained from the myPOS Account

Request Body

Attribute	Type	Condition	Description
gsm	String	Optional	The phone number to which to send a reminder for an already sent payment request. At least one of the two attributes is required to send the request.
email	String	Optional	The email address to which to send a reminder for an already sent payment request. At least one of the two attributes is required to send the request.

Response headers

Attribute	Type	Condition	Description
X-Request-ID	UUID	Mandatory	ID of the request, unique to the call.
Content-Type	String	Mandatory	application/json

Response body

Attribute	Type	Condition	Description
-	Payment Request Details	Mandatory	Fields with details for payment request.

Examples

curl --location --request PATCH 'https://transactions-api.mypos.com/v1.1/online-payments/payment-request/BI8QOBJQKTWN45/reminder' \
--header 'API-Key: MY_API_KEY' \
--header 'X-Request-ID: 232465ab-66ea-4776-b3f0-f7a123f988e4' \
--header 'Authorization: Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP' \
--header 'Content-Type: application/json' \
--data-raw '{
    "gsm":"+359899999999",
    "email":"client@gmail.com"
}'

import requests

url = "https://transactions-api.mypos.com/v1.1/online-payments/payment-request/BI8QOBJQKTWN45/reminder"

payload="{\r\n    \"gsm\":\"+359899999999\",\r\n    \"email\":\"client@gmail.com\"\r\n}"
headers = {
  'API-Key': 'MY_API_KEY',
  'X-Request-ID': '232465ab-66ea-4776-b3f0-f7a123f988e4',
  'Authorization': 'Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP',
  'Content-Type': 'application/json'
}

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

var request = require('request');
var options = {
  'method': 'PATCH',
  'url': 'https://transactions-api.mypos.com/v1.1/online-payments/payment-request/BI8QOBJQKTWN45/reminder',
  'headers': {
    'API-Key': 'MY_API_KEY',
    'X-Request-ID': '232465ab-66ea-4776-b3f0-f7a123f988e4',
    'Authorization': 'Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"gsm":"+359899999999","email":"client@gmail.com"})

};
request(options, function (error, response) {

});

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://transactions-api.mypos.com/v1.1/online-payments/payment-request/BI8QOBJQKTWN45/reminder');
$request->setMethod('PATCH');
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'API-Key' => 'MY_API_KEY',
  'X-Request-ID' => '232465ab-66ea-4776-b3f0-f7a123f988e4',
  'Authorization' => 'Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP',
  'Content-Type' => 'application/json'
));
$request->setBody('{
\n    "gsm":"+359899999999",
\n    "email":"client@gmail.com"
\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

{
    "code": "BI8QOBJQKTWN45",
    "url": "https://mypos.eu/pr/BI8QOBJQKTWN45",
    "added_on": "2021-03-16 13:33:25",
    "client_name": "My client",
    "amount": 2.14,
    "currency": "EUR",
    "reason": "Payment Request Reason",
    "booking_text": "Booking Text",
    "attempts": 0,
    "expiry_on": "2021-04-16 23:59:59",
    "qr_generated": false,
    "email": "client@gmail.com",
    "gsm": "+359899999999",
    "status": 1
}