Let customers select their bank accounts within the Trustly flow

Overview

Initiates a new order where customers can select and verify one of their bank accounts.

You can find more information about how to present the Trustly URL in Trustly URL presentation.

When the account has been verified an Account notification is immediately sent to the NotificationURL.

A typical flow is:

  1. The merchant makes an API-call to SelectAccount and redirects the end-user to the url.
  2. The end-user selects his/her bank and completes the identification process.
  3. The end-user is redirected back to the merchant at the SuccessURL, note that the account might not be verified yet at this point.
  4. When the account is verified, Trustly sends an Account notification to the merchant's system with information about the selected account

Request example

{
  "method": "SelectAccount",
  "params": {
    "Data": {
      "Attributes": {
        "Country": "SE",
        "Firstname": "Steve",
        "IP": "83.140.44.184",
        "Lastname": "Smith",
        "Locale": "sv_SE",
        "Email": "[email protected]",
        "MobilePhone": "+46709876543",
        "NationalIdentificationNumber": "197901311234",
        "DateOfBirth": "1979-01-31",
        "SuccessURL": "https://your_success_page.com"
      },
      "EndUserID": "12345",
      "MessageID": "your_unique_id",
      "NotificationURL": "https://URL_to_your_notification_service",
      "Password": "merchant_password",
      "Username": "merchant_username"
    },
    "Signature": "Hh+sfaUnbtMKW[...]9YngA9bTpiqxw==",
    "UUID": "258a2184-2842-b485-25ca-293525152425"
  },
  "version": "1.1"
}

Request parameters

Parameter nameDescriptionRequiredTypeExample
UsernameThe username.YesTextjoe
PasswordThe password.YesTextsecret
NotificationURLThe URL to which notifications for this order should be sent to. This URL should be hard to guess and not contain a ? ("question mark").YesTexthttps://example.com/trustly/
notification/a2b63j23dj23883jhfhfh
EndUserIDID, username, hash or anything uniquely identifying the end-user to be identified.

Preferably the same ID/username as used in the merchant's own backoffice in order to simplify for the merchant's support department.
YesText123123
MessageIDYour unique ID for the account selection order. Each order you create must have an unique MessageID.YesText12345678
AttributesOptional attributes for this method. See Attributes.YesObject{ "Locale": "sv_SE" }

Attributes

Attribute nameDescriptionReq.TypeExample
LocaleThe end-users localization preference in the format [language[_territory]]. Language is the ISO 639-1 code and territory the ISO 3166-1-alpha-2 code.YesTexten_US
CountryThe ISO 3166-1-alpha-2 code of the end-user's country. This will be used for preselecting the correct country for the end-user in the iframe.YesChar(2)SE
FirstnameThe end-user's firstname.YesTextSteve
LastnameThe end-user's lastname.YesTextSmith
SuccessURLThe URL to which the end-user should be redirected after he/she has completed the initial identification process. Do not put any logic on that page since it's not guaranteed that the end-user will in fact visit it.YesTexthttps://example.com/
thank_you.html
FailURLThe URL to which the end-user should be redirected after a failed/aborted account selection. Do not put any logic on that page since it's not guaranteed that the end-user will in fact visit it.YesTexthttps://trustly.com/
error.html
RequestDirectDebitMandateOnly for Trustly Direct Debit.
Request a direct debit mandate from the selected account. 1 or 0. See section "Direct Debit Mandates" below for details.
NoNumeric1
EmailThe email address of the end user.

*This attribute is required when using RequestDirectDebitMandate = 1.
Yes*Text[email protected]
TemplateURLThe URL to your template page. Read more about the TemplateURL on the Deposit pageNoTexthttps://example.org/
checkout_trustly.html
URLTargetThe html target/framename of the SuccessURL. Only _top, _self and _parent are supported.NoText_top
NationalIdentification
Number
The end-user's social security number / personal number / birth number / etc.

If a Swedish personid ("personnummer") is provided, it will be pre-filled when the user logs in to their bank.
NoText197901311234
UnchangeableNational
IdentificationNumber
This attribute disables the possibility to change/type in national identification number when logging in to a Swedish bank. If this attribute is sent, the attribute NationalIdentificationNumber needs to be correctly included in the request. Note: This is only available for Swedish banks.NoNumeric1
ShopperStatementOnly for Trustly Direct Debit.
The text to show in the email sent to end users for mandate requests
The ShopperStatement should contain either your brand name, website name, or company name.
NoTextMyBrand.com
IPThe IP-address of the end-user.NoText83.140.44.184
MobilePhoneThe mobile phone number to the end-user in international format.NoText+46709876543
DateOfBirthThe end-user's date of birth.NoText1979-01-31
[DEPRECATED, see ReturnToAppURL instead]

URLScheme
Please note that when rendering the Trustly Checkout from a native app you are required to pass your application's URLScheme as an attribute to the order initiation request. By doing so, Trustly can redirect users back to your app after using external identification apps such as Mobile BankID. Please visit this link for more info. It must not be included for transactions that are not originating from an appNoTextyourCustomURLScheme://
ReturnToAppURLWhen rendering the Trustly Checkout in a native app you are required to pass your application's url as an attribute to the order initiation request. By doing so, Trustly can redirect users back to your app after using external identification apps such as Mobile BankID: Please visit this link for more info. It must not be included for transactions that are not originating from an app.

NOTE! This value is only used for redirecting users back to the native app within the flows. See also SuccessURL and FailURL descriptions.
NoTextyouCustomAppURL://
PSPMerchantHuman-readable identifier of the consumer-facing merchant (e.g. legal name or trade name)NoTextMerchant Ltd.
PSPMerchantURLURL of the consumer-facing website where the order is initiatedNoTextwww.merchant.com
MerchantCategoryCodeVISA category codes describing the merchant's nature of business.NoText5499

🚧

PSPMerchant, PSPMerchantURL and MerchantCategoryCode

PSPMerchant, PSPMerchantURL and MerchantCategoryCode are mandatory attributes for Trustly Partners that are using Express Merchant Onboarding (EMO) and aggregate traffic under a master processing account.

Response example

{
    "result": {
        "signature": "R9+hjuMqbsH0Ku ... S16VbzRsw==",
        "uuid": "258a2184-2842-b485-25ca-293525152425",
        "method": "SelectAccount",
        "data": {
            "orderid": "2190971587",
            "url": "https://trustly.com/_/bec96a48-d454-448e-a9ba-25fea8eeba3f"
        }
    },
    "version": "1.1"
}

Response attributes

The result returned is a hash with the following attributes.

Hash keyDescriptionTypeExample
orderidThe globally unique OrderID the account selection order was assigned in our system.BigInt7653345737
urlThe URL that should be loaded so that the end-user can complete the identification process.Texthttps://trustly.com/_/2f6b14fa-446a-4364-92f8-84b738d589ff

Direct Debit Mandates

If the RequestDirectDebitMandate attribute is set, the behavior of the order changes with respect to how account notifications are emitted:

  1. Once the normal order flow is done and the end-user has chosen an account, an Account notification without the directdebitmandate attribute can be sent to the NotificationURL if the account is not immediately ready to be charged.
  2. If the end-user's bank has approved the mandate on the selected account and the account can be charged, an account notification with the directdebitmandate attribute set to "1" is sent.
  3. If creating the mandate is rejected by the end-user's bank or an active mandate is cancelled, an account notification with the directdebitmandate attribute set to "0" is sent.
  4. If the mandate at some point is revoked additional notificications will be sent to all selectaccount orders concerned. It will have the directdebitmandate attribute set to indicate the new status of the mandate.

Error codes

These error codes can be returned for SelectAccount calls. To handle errors, see Error handling.

Error NumberError CodeDescription
602ERROR_FUNCTION_ACCESS_DENIEDThe merchant does not have access to this function.
607ERROR_HOST_ACCESS_DENIEDThe IP address of the merchant has not been added to Trustly's IP-whitelist.
616ERROR_INVALID_CREDENTIALSThe username and/or password used in the API call is incorrect.
620ERROR_UNKNOWNThere could be several reasons for this error, please reach out to your Trustly contact for details.
623ERROR_INVALID_PARAMETERSSome value or parameter in the API call does not match the expected format.
636ERROR_UNABLE_TO_VERIFY_RSA_SIGNATUREThe signature could not be verified using the merchant's public key. Either the wrong private key was used to generate the signature, or the the data object used to create the signature was serialised incorrectly.
637ERROR_DUPLICATE_MESSAGE_IDThe MessageID sent in the API call has been used before.
639ERROR_NO_PUBLIC_KEYNo public key has been configured for the merchant on Trustly's side.
642ERROR_INVALID_EMAILThe email attribute is missing or invalid (this is a requirement when using Trustly Direct Debit).
645ERROR_INVALID_LOCALEThe Locale attribute is sent with an incorrect value.
688ERROR_DUPLICATE_UUIDThis UUID has been used before.
696ERROR_ENDUSERID_IS_NULLThe EndUserID sent in the request is null
697ERROR_MESSAGEID_IS_NULLThe MessageID sent in the request is null
700ERROR_MALFORMED_SUCCESSURLThe SuccessURL sent in the request is malformed. It must be a valid http(s) address.
701ERROR_MALFORMED_FAILURLThe FailURL sent in the request is malformed. It must be a valid http(s) address.
702ERROR_MALFORMED_TEMPLATEURLThe TemplateURL sent in the request is malformed. It must be a valid http(s) address.
703ERROR_MALFORMED_URLTARGETThe URLTarget sent in the request is malformed.
704ERROR_MALFORMED_MESSAGEIDThe MessageID sent in the request is malformed.
705ERROR_MALFORMED_NOTIFICATIONURLThe NotificationURL sent in the request is malformed. It must be a valid https address.
706ERROR_MALFORMED_ENDUSERIDThe EndUserID sent in the request is malformed.
712ERROR_DIRECT_DEBIT_NOT_ALLOWEDTrustly Direct Debit (TDD) is not enabled on the merchant's user in Trusty's system. If you want to use TDD, please reach out to your Trustly contact. If you don't want to use TDD and still get this error message, you need to remove the RequestDirectDebitMandate attribute from the SelectAccount data.
717ERROR_INVALID_ORDER_ATTRIBUTEOne or more attributes are sent with the incorrect value. Please reach out to your Trustly contact for more information.
718ERROR_DISABLED_USERThe merchant's user is disabled in Trustly's system.
734ERROR_NOT_SECURE_NOTIFICATIONURLThe NotificationURL must be using HTTPS, not plain HTTP.
737ERROR_INVALID_COUNTRYThe Country code is invalid.