Hosted Payment Page parameters

Last Updated: 7 Sep 2022

Request parameters

Header parameters

Parameter Required / Optional Description Data Type
Accept
Required
application/json
String
Content-Type
Required
application/json;charset=UTF-8
String
signature
Optional
The generated digital signature that ensures no tampering has occurred with a request sent to us. Read how to create it on the digital signature algorithm page.
String

Body parameters

transactionType String Required

Indicates whether the transaction is an authorization or a sale. An authorization places a hold on the cardholders funds and requires a follow-up capture transaction to be performed. The sale transaction performs the authorization and a capture at the same time. Possible Values:

  • sale
  • authorize

storeName String

The name of your store. This is displayed in the header of the hosted payments form.

successUrl String

The URL to which the cardholder is redirected following a successful transaction. This would typically be a webpage hosted by your server.

failureUrl String

The URL to which the hosted payment redirects the cardholder following a successful transaction.

declinedUrl String

The URL to which the hosted payment page redirects the cardholder following the transaction being declined by Truevo or the Issuer.

Response parameters

Parameter Description Data Type
redirect_url
If successful. The URL of the hosted payment page that has been created to capture the customer’s card details.
String
outcome
Object
status
Either “SUCCESS” or “FAILURE”
String
message
A reason or explanation of why the request failed.
String

Page Contents