GET/v1.1/online-payments/button/<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 button. |
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 Button Details |
Mandatory |
Fields with details for input button. |
Examples
curl -L -X GET 'https://transactions-api.mypos.com/v1.1/online-payments/button/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/button/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/button/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/button/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-14 18:02:34",
"code": "BPYCO5XTQXK40",
"url": "https://mypos.com/mypos.eu/trunk/public/vmp/btn/BPYCO5XTQXK40",
"custom_name": "Payment Button",
"item_name": "API Button",
"enable": true,
"item_price": 3.43,
"total_amount": 6.86,
"quantity": 2,
"button_size": 1,
"send_sms": true,
"send_email": true,
"ask_for_customer_name": true,
"ask_for_shipping_address": true,
"ask_for_customer_email": true,
"ask_for_customer_phone_number": false,
"currency": "EUR",
"pref_language": "EN",
"website": "http://mypos.eu",
"cancel_url": "http://mypos.eu/cancel",
"return_url": "http://mypos.eu/return",
"account_number": "50767683555"
}