Global

Type Definitions

ApplePayConfig

Base configuration for Apple Pay

Type:
  • Object
Properties:
Name Type Description
merchantId Integer

Transpayrent's unique ID for the merchant.
merchantName String

Transpayrent's unique ID for the payment session that was returned as the id property in the response from the "Create Payment Session" API.
container Element

The container element in which the constructed "Buy with Apple Pay" button will be displayed
callback function

The callback function accepts a single argument:
event: The event that triggered the callback, will be either payment-initialization-initiated or payment-initialization-completed
Source:

ApplePayTransaction

The details for the payment transaction that will be authorized using Apple Pay

Type:
  • Object
Properties:
Name Type Description
paymentMethodIds Array.<PAYMENT_METHOD_ID>

List of Payment IDs returned by the Transpayrent Gateway upon initializing the payment transaction
country String

The country the payment transaction takes place in
amount Amount

The payment transaction's amount that will be authorized
save Boolean

Flag indicating whether the consumer has elected to securely store the card details that will be retrieved from Apple Pay upon successful authorization
Source:

AuthenticateConsumerRequest

A representation of the entered payment details and details of the consumer's browser attributes required for strong authentication of a payment transaction using 3D Secure or equivalent. Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

AuthenticationChallengeResult

A representation of an attempted authentication of the consumer for a payment transaction, which requires the consumer to complete an additional authentication challenge as part of the strong consumer authentication process using 3D Secure.
Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

AuthenticationFailureResult

A representation of a failed authentication of the consumer for a payment transaction using 3D Secure. The consumer should be informed of the authentication failure and asked to enter the details of another card upon receiving a failure authentication result or the payment transaction should be abandoned so no authorization is attempted.
Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

AuthenticationSuccessResult

A representation of the successful authentication of the consumer for a payment transaction using 3D Secure. The payment for the payment transaction should be authorized upon receiving a successful authentication result.
Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

AuthorizePaymentResponse

A representation of the details for the successful authorization of a payment transaction. Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

BaseConfig

Base configuration for all requests made to the Payment Gateway APIs.

Type:
  • Object
Properties:
Name Type Description
merchantId Integer

Transpayrent's unique ID for the merchant.
sessionId Long

Transpayrent's unique ID for the payment session that was returned as the id property in the response from the "Create Payment Session" API.
accessToken String

The access token for the payment session that was returned in the HTTP Header: x-transpayrent-access-token in the response from the "Create Payment Session" API.
Source:

Configuration

A representation of the configuration for completing the consumer's payment

Type:
  • Object
Properties:
Name Type Description
disable_authentication boolean

Boolean flag specifying whether Strong Consumer Authentication (SCA) should be disabled. Explicitly disabling SCA is useful for Mail Order / Telephone Order (MOTO) transactions.
Source:

CreatePaymentTransactionRequest

A representation of the consumer's payment transaction. Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

CreatePaymentTransactionResponse

A simplified representation of the created payment transaction. Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

GooglePayConfig

Base configuration for Google Pay

Type:
  • Object
Properties:
Name Type Description
merchantId Integer

Transpayrent's unique ID for the merchant.
merchantName String

Transpayrent's unique ID for the payment session that was returned as the id property in the response from the "Create Payment Session" API.
merchantOrigin String

The merchant's domain name registered with Google Pay. Default's to the domain name obtained from window.location.href
container Element

The container element in which the constructed "Buy with Google Pay" button will be displayed
callback function

The callback function accepts a single argument:
event: The event that triggered the callback, will be either payment-initialization-initiated or payment-initialization-completed
Source:

GooglePayTransaction

The details for the payment transaction that will be authorized using Google Pay

Type:
  • Object
Properties:
Name Type Description
paymentMethodIds Array.<PAYMENT_METHOD_ID>

List of Payment IDs returned by the Transpayrent Gateway upon initializing the payment transaction
country String

The country the payment transaction takes place in
amount Amount

The payment transaction's amount that will be authorized
save Boolean

Flag indicating whether the consumer has elected to securely store the card details that will be retrieved from Google Pay upon successful authorization
Source:

IFrameConfig

Configuration for the constructed iframe element which will be used to display the following:

  • authentication challenge
  • payment initialization
Type:
  • Object
Properties:
Name Type Description
container Element

The container element in which the constructed iframe will be displayed. Defaults to document.body.
css String

Optional CSS class(es) that will be applied to the constructed iframe.
callback String

An optional callback function which will be invoked just before the authentication challenge is initiated and just after the challenge is completed. The callback function accepts 2 arguments:
- event: The event that triggered the callback, will be either authentication-challenge-initiated, authentication-challenge-completed, payment-initialization-initiated or payment-initialization-completed
- iframe: The constructed iframe that is used for the authentication challenge or payment initialization
Source:
Example

Example callback function

 function (event, iframe) {
     switch (event) {
         case 'authentication-challenge-initiated':
             // DO SOMETHING BEFORE THE AUTHENTICATION CHALLENGE IS DISPLAYED
             break;
         case 'authentication-challenge-completed':
             // DO SOMETHING AFTER THE AUTHENTICATION CHALLENGE IS COMPLETE
             break;
         case 'payment-initialization-initiated':
             // DO SOMETHING BEFORE THE INITIALIZATION OF THE PAYMENT FOR THE PAYMENT TRANSACTION IS DISPLAYED
             break;
         case 'payment-initialization-completed':
             // DO SOMETHING AFTER INITIALIZATION OF THE PAYMENT FOR THE PAYMENT TRANSACTION IS COMPLETE
             break;
 }

InitializationDetails

A representation of the initialization details provided by the consumer for initializing the payment for a payment transaction through an upstream 3rd party provider such as Apple Pay, Google Pay or MobilePay Online.
Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

InitializeAuthenticationRequest

A representation of the payment details provided by the consumer for strong authentication of a payment transaction using 3D Secure or equivalent. Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

InitializeAuthenticationResponse

A representation of the details required to progress the 3D Secure process for strong consumer authentication. Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

InitializePaymentRequest

A representation of the initialization details provided by the consumer for initializing the payment for a payment transaction through an upstream 3rd party provider such as Apple Pay, Google Pay or MobilePay Online.
Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

InitializePaymentResponse

A representation of the details required to authorize the payment for a payment transaction using an upstream 3rd party provider such as Apple Pay, Google Pay or MobilePay Online.
Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

PAYMENT_METHOD_ID

The unique id for the payment method (AMEX, MasterCard, VISA etc.). Please refer to the online documentation for details on the object properties.

Type:
  • Enum
Source:
See:

PaymentDetails

A representation of a payment made using a payment card such as a MasterCard credit card or a VISA debit card. Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

PaymentSheetDetails

A representation of the details that will be passed to the 3rd party wallet when displaying the payment sheet. Please refer to the online documentation for details on the object properties.

Type:
  • Object
Properties:
Name Type Description
merchant_id Integer

Transpayrent's unique ID for the merchant
merchant_name String

The name of the merchant which will be displayed on the payment sheet by the 3rd party wallet
country COUNTRY

The numeric ISO-3166 code for the consumer's country
payment_method_ids Array.<PAYMENT_METHOD_ID>

List of Payment Method IDs returned in the response from "Create Payment Session"
amount Amount

The amount the consumer will be charged
save Boolean

Flag indicating whether the consumer's payment card will be securely stored in Transpayrent's Secure Vault
callback function

An optional callback function which will be invoked just before the authentication challenge is initiated and just after the challenge is completed. The callback function accepts the arguments: event: The event that triggered the callback, will be either payment-initialization-initiated or payment-initialization-completed
Source:
See:

SaveConsumerValuableRequest

A representation of the payment details for the payment instrument, such as a MasterCard credit card or a VISA debit card, which will be saved. Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

SaveConsumerValuableResponse

A representation of the details for successfully saving the provided payment card. Please refer to the online documentation for details on the object properties.

Type:
  • Object
Source:
See:

Status

A status response returned by the Payment Gateway when an API request fails.

Type:
  • Object
Properties:
Name Type Description
api String

The Payment Gateway API that returned the message(s).
status Integer

The HTTP Status Code returned by the Payment Gateway.
messages Array.<StatusMessage>

A list of messages returned by the Payment Gateway.
Source:

StatusMessage

A representation of a status message returned by the Transpayrent Payment Gateway.

Type:
  • Object
Source:
See: