GET /v1.1/online-payments/link/<code>

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

Path parameters

Attribute	Type	Condition	Description
code	String	Mandatory	Unique code of the payment link.

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 Link Details	Mandatory	Fields with details for input link.

Examples

curl -L -X GET 'https://transactions-api.mypos.com/v1.1/online-payments/link/BPYCO5XTQXK40' \
-H 'API-Key: MY_API_KEY' \
-H 'X-Request-ID: 232465ab-66ea-4776-b3f0-f7a123f988e4' \
-H 'Authorization: Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP'

import requests

url = "https://transactions-api.mypos.com/v1.1/online-payments/link/BPYCO5XTQXK40"

payload = {}
headers = {
  'API-Key': 'MY_API_KEY',
  'X-Request-ID': '232465ab-66ea-4776-b3f0-f7a123f988e4',
  'Authorization': 'Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP',
  'Content-Type': 'application/json'
}

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

const request = require('request');
const options = {
  'method': 'GET',
  'url': 'https://transactions-api.mypos.com/v1.1/online-payments/link/BPYCO5XTQXK40',
  'headers': {
    'API-Key': 'MY_API_KEY',
    'X-Request-ID': '232465ab-66ea-4776-b3f0-f7a123f988e4',
    'Authorization': 'Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP',
    'Content-Type': 'application/json'
  }
};
request(options, (error, response) => {

});

<?php

$request = new HttpRequest();
$request->setUrl('https://transactions-api.mypos.com/v1.1/online-payments/link/BPYCO5XTQXK40');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'Authorization' => 'Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP',
  'API-Key' => 'MY_API_KEY',
  'X-Request-ID' => '232465ab-66ea-4776-b3f0-f7a123f988e4'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

{
    "created_on": "2020-09-15 11:01:21",
    "code": "BBEIYAROVBH84",
    "url": "https://mypos.com/vmp/btn/BBEIYAROVBH84",
    "custom_name": "Payment Link",
    "item_name": "Example Item",
    "enable": true,
    "item_price": 3.43,
    "total_amount": 6.86,
    "quantity": 2,
    "send_sms": true,
    "send_email": true,
    "hide_quantity": true,
    "ask_for_customer_name": true,
    "currency": "GBP",
    "pref_language": "BG",
    "website": "http://mypos.com",
    "expire_date": "2020-10-25 00:00:00",
    "account_number": "50767683555"
}