Sign in
transactions

Establish a new transaction for authorization

This endpoint creates a new unauthorized transaction and returns a URL to be provided for a user to authorize the transaction. After the user has authorized the transaction with a bank, the transaction can be used with other Trustly APIs to retrieve account data or process payments.

For more details and descriptions of the fields supported by this endpoint see Establish Data object.

Note for Money Transfer If your application is configured for "Money Transfer" many properties in the customer, beneficiary and beneficiaryAccount objects will be required. See Send money for more details.

post/establish

Query parameters

createTransactionboolean

If true, Trustly will return a transactionId that can be used with other API's. Either createTransaction or notify is required.

notifyboolean

If true, Trustly will notify the User via SMS or Email with a URL that can be used to complete the transaction. Either createTransaction or notify is required.

channelstring

Comma separated list of notification channels. Currently only sms and email are supported. Example: sms,email will send a notification via SMS and email to the User. Required if notify is true.

Headers

Authorizationstring required

Request body

merchantIdstring required

Your Trustly-provided Merchant ID.

accessIdstring required

Your Trustly-provided client application access ID.

amountstring

The amount of the transaction. This represents the maximum amount of the transactions that can be processed with the Authorization. If the amount is 0.00, there will be no upper bound on the transaction. (10 characters with support for 2 decimal places)

currency'USD' | 'CAD' required

3-letter ISO Currency Code.

descriptionstring

A summary description of the order. Do not pass Consumer PII (name, email address, etc) in this field.

returnUrlstring required

The URL where the user should be redirected to when the user successfully authorizes the transaction (must be a valid URL or function).

cancelUrlstring required

The URL where the user should be redirected to if the user exits or the transaction is canceled (must be a valid URL or function).

notificationUrlstring

Notification URL to use for notifications associated with this transaction. This overrides the notification URL configured by Trustly during onboarding.

paymentType'Retrieval' | 'Deferred' | 'Disbursement' | 'Instant' | 'Recurring' | 'Verification'

Specifies the type of transaction to create. Possible values are Instant, Deferred, Disbursement, Recurring, Verification, and Retrieval. Default is Retrieval.

Note: If your application is configured for "Money Transfer" and utilizes the "Instant" paymentType several properties under customer, beneficiary and beneficiaryAccount will be required.

See Send money for more details.

requestSignaturestring required

Request Signature used to secure the request.

displayAmountstring

Optionally displays the provided transaction amount to the user throughout the Lightbox experience.

Note: This value must be sent as a JSON string (for example, "10.50"), not as a numeric value.

merchantReferencestring required

A unique identifier that you create to represent the Transaction in the Trustly system.

kycTypestring

Specifies the KYC (Know Your Customer) type. This field is optional and can only be used by merchants configured for Trustly ID.

Response

OK

merchantIdstring

Your Merchant ID.

paymentTypenumber double

The Payment Type of the transaction to create. Currently only Disbursement, Deferred, and Instant are supported.

returnUrlstring

Return URL to use when the transaction is completed.

cancelUrlstring

Cancel URL to use if the user cancels the transaction.

notificationUrlstring

Notification URL to use for notifications associated with this transaction. This overrides the notification URL configured at the merchant level.

datastring
accessIdstring

Your client application access id. It will be provided to you.

requestSignaturestring

Request Signature that can be validated to verify the response authenticity.

transactionIdstring

Transaction ID retrieved from Trustly.

merchantReferencestring

An external reference from the merchant. Ex: Order identifier from merchant e-commerce application.

descriptionstring

Merchant order description

currency'USD'

3-letter ISO Currency Code. Currently only USD is supported.

kycType'OnlineBanking'

Specifies the KYC (Know Your Customer) type as number. The possible value is 1 (OnlineBanking). This field is optional and can only be used by merchants configured for Trustly ID.

amountstring

The amount of the transaction. This represents the maximum amount of the transactions that can be processed with the Authorization. If the amount is 0.00, there will be no upper bound on the transaction. (10 characters with support for 2 decimal places)

urlstring required

Changes

No recorded changes to this endpoint across all 1 revision of this API.