Signature Service

Submit Transaction Signature

post

Submit a captured transaction signature image for a specified transaction.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

This model represents the signature

transaction-idinteger · int32Required

Unique identifier of the transaction associated with the signature.

Example: 1

base-64-imagestringRequired

Base64-encoded image data of the captured transaction signature.

Example: a base64EncodedImage

createdstringRequired

Date and time when the signature was created.

Example: text

Responses

200

ok

This model represents the signature response payload

payloadTypestringRequired

The type of payload returned in response.

Example: signature

401

Unauthorized

403

Forbidden

404

Not Found

post/rest/v2/signature

POST /rest/v2/signature HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "transaction-id": 1,
  "base-64-image": "a base64EncodedImage",
  "created": "text"
}

{
  "signature": {
    "transaction-id": 1,
    "base-64-image": "a base64EncodedImage",
    "created": "text"
  },
  "payloadType": "signature"
}

Get Transaction Signature

get

Retrieve the signature image and related details for a specified transaction using the transaction ID.

Path parameters

transactionIdinteger · int32Required

Unique identifier of the transaction associated with the signature.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

ok

This model represents the signature response payload

payloadTypestringRequired

The type of payload returned in response.

Example: signature

401

Unauthorized

403

Forbidden

404

Not Found

get/rest/v2/signature/{transactionId}

GET /rest/v2/signature/{transactionId} HTTP/1.1
api-key: text
Accept: */*

{
  "signature": {
    "transaction-id": 1,
    "base-64-image": "a base64EncodedImage",
    "created": "text"
  },
  "payloadType": "signature"
}