latestOpenAPI 3.0.02026-08-0832102256.6 KB

6097bc689e41

Transactions

Render Receipt

Called by the Independent Software Vendor. Request a receipt by name or by receipt reference number from the gateway for a given transaction reference number. Returns base64 encoded receipt if found.

get/transactions/receipt/render

Query parameters

ref_numberstring required

The unique identifier of the transaction on the legacy gateway.

template_namestring

The unique identifier of the transaction template. Used only for payment fusion gateway.

Need to provide at least one of 'receipt_name'(The name of the receipt on the gateway) or 'receipt_ref_num'(The unique identifier of the receipt template on the gateway).

merchant_idstring required

The merchant identifier that will be used to connect to the gateway. Size range - 1..16

receipt_formatstring

The format of the receipt. Allowed values - "Text", "HTML"

text_versionboolean

Should render receipt as text

Headers

Authorizationstring api_id:api_token required

Needs to include Basic word before Base64 encoded api_id:api_token. The api_id is the identifier of the organization created on TAP; size range - up to 36 characters. The api_token is the unique token previously generated by TAP and provided securely to the organization; size range - 32. Example: Basic ODA5BVgrNdZkZmbiFlJlTThkYTA2eG00MzA5dHh1bWZnZgfdZDE=

Acceptstring required

Example:application/vnd.paymentfusion.v3.0.0+json

Specifies the requested API version. If this field is not specified or has an invalid format, the API will return an error. If the specified version does not exist, a 404 page will be displayed. Accepted values - application/vnd.paymentfusion.v3.0.0+json

Response

Success

receiptstring

The returned receipt

vstring

The API version that was used to handle the request.

Example response

{
  "receipt": "string",
  "v": "string"
}