Sign in

v1

latestSwagger 2.0Apache 2.02026-07-141430111.3 KB
payment-gateway

Send Transaction Receipt Email

Sends the transaction receipt to multiple email addresses. Receipts can be sent only for successful transactions.

post/emailReceipt/{pgId}

Path parameters

pgIdstring required

pgId

Request body

developer_idstring

<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Use to indicate which company developed the integration to Qualpay or the name of the payment solution that is connected to Qualpay. Suggested usage is softwareABCv1.0 or companyXYZv2.0.

email_addressstring[] required

AN<br><strong>Description: </strong>An array of email addresses to which the transaction receipt should be sent to.

logo_urlstring

AN<br><strong>Description: </strong>A link to the logo image that will be included in the transaction receipt.

merchant_idinteger required

<strong>Format: </strong>Variable length, up to 12 N<br><strong>Description: </strong>Unique identifier on the Qualpay system.

vendor_idinteger

<strong>Format: </strong>Variable length, up to 12 N<br><strong>Description: </strong>Identifies the vendor to which this email receipt request applies.

Example request

{
  "developer_id": "QualpayV1.2",
  "email_address": [
    "jdoe@qualpay.com",
    "john.doe@qualpay.com"
  ],
  "logo_url": "https://app.qualpay.com/shared/images/qp-icon.png",
  "vendor_id": 212100026512
}

Response

Success

pg_idstring

<strong>Format: </strong>Fixed length, 32 AN<br><strong>Description: </strong>32-byte unique identifier generated by the payment gateway, returned in all valid responses.

rcodestring

<strong>Format: </strong>Fixed length, 3 AN<br><strong>Description: </strong>Response code from the payment gateway. "000" indicates success. Refer to <a href="/developer/api/reference#api-response-codes"target="_blank">Platform API Response Codes</a> for entire list of Payment Gateway Response Codes.

rmsgstring

<strong>Format: </strong>Variable length<br><strong>Description: </strong>Response text from the payment gateway.

Example response

{
  "pg_id": "d24ac6189b0b11e6966ca68d5edbef41",
  "rcode": "000",
  "rmsg": "Transaction Receipt sent"
}