APIPay In endpointsTransaction utilities

Send receipt

View as MarkdownOpen in Claude
Send a payment receipt for a transaction.

Authentication

requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

OR
AuthorizationBearer

OAuth2 Bearer access token from the client-credentials flow. See OAuth authentication.

Path parameters

transIdstringRequired

ReferenceId for the transaction (PaymentId).

Query parameters

emailstringOptional
Email address where the payment receipt should be sent. If not provided, the email address on file for the user owner of the transaction is used.

Response

Success
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

pageIdentifierstring
Auxiliary validation used internally by payment pages and components.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error