Receipt Service

Create Receipt Request

post

Send a transaction receipt to a customer by email.

Header parameters

api-keyanyRequired

An access API key issued to you by Xplor Pay.

Body

application/jsonapplication/xml

idstringOptional

The unique transaction identifier for which the system sends the receipt.

Example: text

email-addressstringOptional

The customer's email address that receives the transaction receipt.

Example: text

Responses

200

Successful Transaction

application/jsonapplication/xml

payloadTypestringOptional

The type of payload returned with the response.

Example: receiptResponse

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

post

/rest/v2/receipts

HTTPcURLJavaScriptPython

POST /rest/v2/receipts HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "id": "text",
  "email-address": "text"
}

application/jsonapplication/xml

{
  "receipt-response": {
    "id": "text",
    "email-address": "text",
    "display-message": "text"
  },
  "payloadType": "receiptResponse"
}