3.27. /api/v2/card-insurance-document

Introduction

Card insurance document is initiated through HTTPS POST request by using URLs and the parameters specified below. Use OAuth HMAC-SHA1 for authentication. See Statuses.

Note

After a successful transaction, it is necessary to generate a request to download the insurance policy with the Payer’s data in PDF format.

API URLs

Note

The path in API URL should not be hardcoded, as it may be changed in future.

Integration

Production

https://sandbox.payneteasy.com/paynet/api/v2/card-insurance-document/ENDPOINTID

https://gate.payneteasy.com/paynet/api/v2/card-insurance-document/ENDPOINTID

Request Parameters

Parameter Name

Description

client-order-id

Unique order identifier assigned by Connecting Party.

order_id

Order id assigned to the order by Payneteasy.

Response Parameters

Parameter Name

Description

request_serial_number

A unique number assigned by the server Payneteasy for a specific request from the Connecting Party.

document_path

The link to download the document.

Request Example

POST /paynet/api/v2/card-insurance-document/3213 HTTP/1.1
User-Agent: curl/8.7.1
Accept: */*
Authorization: OAuth realm="",oauth_version="1.0",oauth_consumer_key="merchantlogin",oauth_signature_method="HMAC-SHA1",oauth_signature="IibClG%2FGfoxiGvKSyRovTH0P1Pg%3D"
Content-Length: 120
Content-Type: application/x-www-form-urlencoded
Connection: close

client-order-id=Value&oauth_consumer_key=merchantlogin&oauth_signature_method=HMAC-SHA1&oauth_version=1.0&order_id=Value

Success Response Example

{
  "request_serial_number": "00000000-0000-0000-0000-000001fd4472",
  "document_path": "https://sandbox.payneteasy.com/paynet/api/v2/download/card-ins-12345678912345678912"
}

Note

The received link must be displayed in the Payer’s browser.

Warning

The file is available for a single download only.

Fail Response Example

HTTP/1.1 403
Server: server
Date: Fri, 14 Feb 2025 10:27:47 GMT
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Connection: close
X-XSS-Protection: 1
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000
Content-Length: 102

type=error
&serial-number=00000000-0000-0000-0000-000002f38fde
&error-message=Forbidden
&error-code=-1

Request Builder

HTTP method
URL
parameters
version
consumer key
consumer secret
timestamp

nonce

signature method

normalized parameters
signature base string
signature
authorization header