3.18. /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

Integration

Production

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

https://gate.connpay.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 ConnPay.

end-point-id

Endpoint id used for the transaction.

consumer_key

Connecting party’s login in the system.

consumer_secret

Connecting party’s control key.

Response Parameters

Parameter Name

Description

request_serial_number

A unique number assigned by the server ConnPay for a specific request from the connecting party.

document_path

The link to download the document.

Request Example

Success Response Example

{
  "request_serial_number": "00000000-0000-0000-0000-000001fd4472",
  "document_path": "https://sandbox.connpay.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

Request Builder

HTTP method
URL
parameters
version
consumer key
consumer secret
timestamp

nonce

signature method

normalized parameters
signature base string
signature
authorization header