Generate eReceipt for your Transaction - Nayax Developer Portal

Generate eReceipt for your Transaction

curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/ereceipt/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "TrasactionID": 123,
  "TransactionDateTime": "2023-11-07T05:31:56Z",
  "TrasactionSiteID": 123,
  "MachineID": 123,
  "FullName": "<string>",
  "Email": "<string>"
}
'

import requests

url = "https://qa-lynx.nayax.com/operational/v1/ereceipt/generate"

payload = {
    "TrasactionID": 123,
    "TransactionDateTime": "2023-11-07T05:31:56Z",
    "TrasactionSiteID": 123,
    "MachineID": 123,
    "FullName": "<string>",
    "Email": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    TrasactionID: 123,
    TransactionDateTime: '2023-11-07T05:31:56Z',
    TrasactionSiteID: 123,
    MachineID: 123,
    FullName: '<string>',
    Email: '<string>'
  })
};

fetch('https://qa-lynx.nayax.com/operational/v1/ereceipt/generate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://qa-lynx.nayax.com/operational/v1/ereceipt/generate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'TrasactionID' => 123,
    'TransactionDateTime' => '2023-11-07T05:31:56Z',
    'TrasactionSiteID' => 123,
    'MachineID' => 123,
    'FullName' => '<string>',
    'Email' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://qa-lynx.nayax.com/operational/v1/ereceipt/generate"

	payload := strings.NewReader("{\n  \"TrasactionID\": 123,\n  \"TransactionDateTime\": \"2023-11-07T05:31:56Z\",\n  \"TrasactionSiteID\": 123,\n  \"MachineID\": 123,\n  \"FullName\": \"<string>\",\n  \"Email\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://qa-lynx.nayax.com/operational/v1/ereceipt/generate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"TrasactionID\": 123,\n  \"TransactionDateTime\": \"2023-11-07T05:31:56Z\",\n  \"TrasactionSiteID\": 123,\n  \"MachineID\": 123,\n  \"FullName\": \"<string>\",\n  \"Email\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://qa-lynx.nayax.com/operational/v1/ereceipt/generate")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"TrasactionID\": 123,\n  \"TransactionDateTime\": \"2023-11-07T05:31:56Z\",\n  \"TrasactionSiteID\": 123,\n  \"MachineID\": 123,\n  \"FullName\": \"<string>\",\n  \"Email\": \"<string>\"\n}"

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

{
  "ReceiptURL": "<string>",
  "EmailSent": true,
  "EreceiptID": 123
}

Generate eReceipt for your Transaction

curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/ereceipt/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "TrasactionID": 123,
  "TransactionDateTime": "2023-11-07T05:31:56Z",
  "TrasactionSiteID": 123,
  "MachineID": 123,
  "FullName": "<string>",
  "Email": "<string>"
}
'

import requests

url = "https://qa-lynx.nayax.com/operational/v1/ereceipt/generate"

payload = {
    "TrasactionID": 123,
    "TransactionDateTime": "2023-11-07T05:31:56Z",
    "TrasactionSiteID": 123,
    "MachineID": 123,
    "FullName": "<string>",
    "Email": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    TrasactionID: 123,
    TransactionDateTime: '2023-11-07T05:31:56Z',
    TrasactionSiteID: 123,
    MachineID: 123,
    FullName: '<string>',
    Email: '<string>'
  })
};

fetch('https://qa-lynx.nayax.com/operational/v1/ereceipt/generate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://qa-lynx.nayax.com/operational/v1/ereceipt/generate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'TrasactionID' => 123,
    'TransactionDateTime' => '2023-11-07T05:31:56Z',
    'TrasactionSiteID' => 123,
    'MachineID' => 123,
    'FullName' => '<string>',
    'Email' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://qa-lynx.nayax.com/operational/v1/ereceipt/generate"

	payload := strings.NewReader("{\n  \"TrasactionID\": 123,\n  \"TransactionDateTime\": \"2023-11-07T05:31:56Z\",\n  \"TrasactionSiteID\": 123,\n  \"MachineID\": 123,\n  \"FullName\": \"<string>\",\n  \"Email\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://qa-lynx.nayax.com/operational/v1/ereceipt/generate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"TrasactionID\": 123,\n  \"TransactionDateTime\": \"2023-11-07T05:31:56Z\",\n  \"TrasactionSiteID\": 123,\n  \"MachineID\": 123,\n  \"FullName\": \"<string>\",\n  \"Email\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://qa-lynx.nayax.com/operational/v1/ereceipt/generate")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"TrasactionID\": 123,\n  \"TransactionDateTime\": \"2023-11-07T05:31:56Z\",\n  \"TrasactionSiteID\": 123,\n  \"MachineID\": 123,\n  \"FullName\": \"<string>\",\n  \"Email\": \"<string>\"\n}"

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

{
  "ReceiptURL": "<string>",
  "EmailSent": true,
  "EreceiptID": 123
}

Authorizations

Authorization

string

header

required

Enter your Bearer token. It's required to authenticate API requests.

Body

application/json

The details of the transaction for which the eReceipt is to be generated.

Represents the details required to generate an electronic receipt (eReceipt) for a transaction.

TrasactionID

integer<int64>

The unique identifier of the transaction for which the eReceipt is being generated.

TransactionDateTime

string<date-time>

The date and time when the transaction occurred.

TrasactionSiteID

integer<int32>

The unique identifier of the site where the transaction took place.

MachineID

integer<int64>

The unique identifier of the machine involved in the transaction.

FullName

string | null

The full name of the individual for whom the eReceipt is being generated.

Email

string | null

The email address to which the eReceipt will be sent.

Response

200 - application/json

The eReceipt was successfully generated.

Represents the response after generating an electronic receipt (eReceipt), including the receipt URL and status.

ReceiptURL

string | null

The URL where the generated eReceipt can be accessed.

EmailSent

boolean

Indicates whether the eReceipt was successfully sent via email.

EreceiptID

integer<int64>

The unique identifier of the generated eReceipt.