Accept payments from customers or deposits from players

Overview

You can use the Deposit API method to accept payments from customers in general or accept deposits from players in gaming. For example, in a gaming app, you can integrate with Trustly so that players can make deposit in the game.

If you plan to use Deposit in the Netherlands, see iDeal.

Request example

{
  "method": "Deposit",
  "params": {
    "Signature": "f4ThjuMqbsdG6u ... S16VbzD4h==",
    "UUID": "258a2184-2842-b485-25ca-293525152425",
    "Data": {
      "Username": "merchant_username",
      "Password": "merchant_password",
      "NotificationURL": "https://URL_to_your_notification_service/dajskldjakls123",
      "EndUserID": "12345",
      "MessageID": "your_unique_deposit_id",
      "Attributes": {
        "Country": "SE",
        "Locale": "sv_SE",
        "Currency": "SEK",
        "Amount": "103.00",
        "IP": "123.123.123.123",
        "MobilePhone": "+46709876543",
        "Firstname": "John",
        "Lastname": "Doe",
        "Email": "[email protected]",
        "NationalIdentificationNumber": "790131-1234",
        "SuccessURL": "https://yourpage.com/success",
        "FailURL": "https://yourpage.com/fail"
      }
    }
  },
  "version": "1.1"
}
{
  "method": "Deposit",
  "params": {
    "Signature": "f4ThjuMqbsdG6u ... S16VbzD4h==",
    "UUID": "258a2184-2842-b485-25ca-293525152425",
    "Data": {
      "Username": "merchant_username",
      "Password": "merchant_password",
      "NotificationURL": "https://URL_to_your_notification_service/dajskldjakls123",
      "EndUserID": "12345",
      "MessageID": "your_unique_deposit_id",
      "Attributes": {
        "Country": "SE",
        "Locale": "sv_SE",
        "Currency": "SEK",
        "Amount": "103.00",
        "IP": "123.123.123.123",
        "MobilePhone": "+46709876543",
        "Firstname": "John",
        "Lastname": "Doe",
        "Email": "[email protected]",
        "NationalIdentificationNumber": "790131-1234",
        "SuccessURL": "https://yourpage.com/success",
        "FailURL": "https://yourpage.com/fail",
        "RecipientInformation": {
          "Partytype": "PERSON",
          "Firstname": "Mark",
          "Lastname": "Smith",
          "CountryCode": "ES",
          "CustomerID": "123456789",
          "Address": "Main street 1, 12345, Barcelona",
          "DateOfBirth": "1980-01-30"
        }
      }
    }
  },
  "version": "1.1"
}
{
  "method": "Deposit",
  "params": {
    "Signature": "f4ThjuMqbsdG6u ... S16VbzD4h==",
    "UUID": "258a2184-2842-b485-25ca-293525152425",
    "Data": {
      "Username": "merchant_username",
      "Password": "merchant_password",
      "NotificationURL": "https://URL_to_your_notification_service/dajskldjakls123",
      "EndUserID": "12345",
      "MessageID": "your_unique_deposit_id",
      "Attributes": {
        "Country": "SE",
        "Locale": "sv_SE",
        "Currency": "SEK",
        "Amount": "103.00",
        "IP": "123.123.123.123",
        "MobilePhone": "+46709876543",
        "Firstname": "John",
        "Lastname": "Doe",
        "Email": "[email protected]",
        "NationalIdentificationNumber": "790131-1234",
        "SuccessURL": "https://yourpage.com/success",
        "FailURL": "https://yourpage.com/fail",
        "PSPMerchant": "merchant_name",
        "PSPMerchantURL": "https://merchantURL.com/",
        "MerchantCategoryCode": "1234",
        "RecipientInformation": {
          "Address": "Merchant Road 101",
          "CountryCode": "SE",
          "CustomerID": "merch_001",
          "DateOfBirth": "5563427391",
          "Firstname": "Merchant Ltd",
          "Lastname": null,
          "Partytype": "ORGANISATION"
        }
      }
    }
  },
  "version": "1.1"
}

Request parameters

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

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 deposit.YesText12345678
AttributesAttributes for this method. See Attributes.YesObject{ "Locale": "sv_SE" }

Attributes

The parameter Attributes is an object of attributes.

Note: New attributes may be added in future versions of the API, but existing attributes will never be removed.

Attribute nameDescriptionRequiredTypeExample
CurrencyThe currency of the end-user's account in the merchant's system.YesTextEUR
FirstnameThe end-user's first name.YesTextSteve
LastnameThe end-user's last name.YesTextSmith
CountryThe ISO 3166-1-alpha-2 code of the end-user's country. This will be used for pre-selecting the country for the end-user in the iframe.

Note: This will only have an effect for new end-users. If an end-user has done a previous order (with the same EndUserID), the country that was last used will be pre-selected.
YesTextSE
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.

This will be used to pre-select the language in the trustly iframe.
YesTexten_US
ShopperStatementThe text to show on the end-user's bank statement after Trustly's own 10 digit reference (which always will be displayed first). The reference must let the end user identify the merchant based on this value. So the ShopperStatement should contain either your brand name, website name, or company name.

If possible, try to keep this text as short as possible to maximise the chance that the full reference will fit into the reference field on the customer's bank since some banks allow only a limited number of characters. If the full ShopperStatement does not fit into the reference it will be truncated from the end.
YesTextMyBrand.com
SuccessURLThe URL to which the end-user should be redirected after a successful deposit. 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/thank_you.html
FailURLThe URL to which the end-user should be redirected after a failed deposit. 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/payment_error.html
EmailThe email address of the end user. YesText[email protected]
MobilePhoneThe mobile phone number of the end-user in international format.NoText+46709876543
AmountThe amount to deposit. See format in Currencies. Do not use this attribute in combination with SuggestedMinAmount or SuggestedMaxAmount. Only digits. Use dot (.) as decimal separator.NoText103.50
SuggestedMinAmountThe minimum amount the end-user is allowed to deposit in the currency specified by Currency. Only digits. Use dot (.) as decimal separator.NoText5.00
SuggestedMaxAmountThe maximum amount the end-user is allowed to deposit in the currency specified by Currency. Only digits. Use dot (.) as decimal separator.NoText500.00
AccountIDThe AccountID of a returning customer. Allows for a quicker payment experience in some markets, see Trustly Express.NoText1234567890
IPThe IP-address of the end-user.NoText83.140.44.184
TemplateURLThe TemplateURL should be used if you want to design your own payment page but have it hosted on Trustly's side. The URL of your template page should be provided in this attribute in every Deposit API call. Our system will then fetch the content of your template page, insert the Trustly iframe into it and host the entire page on Trustly’s side. In the response to the Deposit request, you will receive a URL to the hosted template page which you should redirect the user to (the hosted page cannot be iframed).

There are some security restrictions to the TemplateURL:

All images must have absolute URLs. Every link must use HTTPS. * Tags like: script, iframe, frame, frameset, object, applet, etc will not be allowed as they present a security risk.

In addition, the template page must contain in some part of the code the following tag that we will use to insert Trustly’s iFrame:

<!-- TRUSTLY-PAYMENT-PAGE-GOES-HERE -->

The trustly payment window on the hosted page will default to 600px width. To dynamically adjust it to a mobile screen, please add the following to your CSS: "iframe {width: 100% !important;}"
NoTexthttps://example.org/checkout_trustly.html
URLTargetThe html target/framename of the SuccessURL. Only _top, _self and _parent are suported.NoText_top
NationalIdentificationNumberThe end-user's social security number / personal number / birth number / etc. Useful for some banks for identifying transactions and KYC/AML.

If a Swedish personid ("personnummer") is provided, it will be pre-filled when the user logs in to their bank.
NoText790131-1234
UnchangeableNationalIdentificationNumberThis 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.NoText1
ShippingAddressCountryThe ISO 3166-1-alpha-2 code of the shipping address country.NoTextSE
ShippingAddressPostalCodeThe postalcode of the shipping address.NoTextSE-11253
ShippingAddressCityThe city of the shipping address.NoTextStockholm
ShippingAddressLine1Shipping address streetNoTextMain street 1
ShippingAddressLine2Additional shipping address information.NoTextApartment 123, 2 stairs up
ShippingAddressThe entire shipping address. This attribute should only be used if you are unable to provide the shipping address information in the 5 separate attributes above (ShippingAddressCountry, ShippingAddressCity, ShippingAddressPostalCode, ShippingAddressLine1, ShippingAddressLine2)NoTextMain street 1, SE-11253, Stockholm, Sweden.
[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.
NoTextyourCustomReturnToAppURL://
ExternalReferenceThe ExternalReference is a reference set by the merchant for any purpose and does not need to be unique for every API call. The ExternalReference will be included in version 1.2 of the settlement report, ViewAutomaticSettlementDetailsCSV.NoText23423525234
PSPMerchantHuman-readable identifier of the consumer-facing merchant (e.g. legal name or trade name).

Note: It is required for using Express Merchant Onboarding and aggregate traffic under a master processing account. It is also mandatory for E-wallets used directly in your checkout, where you use Trustly to transfer funds from the customer's e-money account ("funding stage") into your e-money account.
Yes*TextMerchant Ltd.
PSPMerchantURLURL of the consumer-facing website where the order is initiated.

Note: It is required for using Express Merchant Onboarding and aggregate traffic under a master processing account. It is also mandatory for E-wallets used directly in your checkout, where you use Trustly to transfer funds from the customer's e-money account ("funding stage") into your e-money account.
NoTextwww.merchant.com
MerchantCategoryCodeVISA category codes describing the merchant's nature of business.

Note: It is required for using Express Merchant Onboarding and aggregate traffic under a master processing account. It is also mandatory for E-wallets used directly in your checkout, where you use Trustly to transfer funds from the customer's e-money account ("funding stage") into your e-money account.
NoText5499
RecipientInformationInformation about the Payee (ultimate creditor). The burden of identifying who the Payee for any given transaction is lies with the Trustly customer.

** Required for some merchants and partners, see RecipientInformation attributes.
NoObject{"Firstname": "Mark" ...}

RecipientInformation attributes

Attribute nameDescriptionRequiredTypeExample
PartytypePartytype can be "PERSON" or "ORGANISATION" (if the recipient is an organisation/company).YesTextPERSON
FirstnameFirst name of the person, or the name of the organisation.YesTextMark
LastnameLast name of the person (NULL for organisation).YesTextSmith
CountryCodeThe ISO 3166-1-alpha-2 code of the country that the recipient resides in.YesTextES
CustomerIDPayment account number or an alternative consistent unique identifier (e.g. customer number).

Note: this is not a transaction ID or similar. This identifier must stay consistent across all transactions relating to this recipient (payee).
NoText123456789
AddressFull address of the recipient, excluding the country.NoTextMain street 1, 12345, Barcelona
DateOfBirthDate of birth (YYYY-MM-DD) of the beneficiary, or organisational number for the organisation.NoText1980-01-30

Response example

{
  "result": {
    "signature": "4F8hjuMqbsH0Ku ... S16VbzRsw==",
    "uuid": "258a2184-2842-b485-25ca-293525152425",
    "method": "Deposit",
    "data": {
      "orderid": "2190971587",
      "url": "https://checkout.trustly.com/checkout?OrderID=1234567890&SessionID=..."
    }
  },
  "version": "1.1"
}

Response attributes

The result returned is an object with the following elements:

Hash keyDescriptionTypeExample
orderidThe globally unique OrderID the deposit was assigned in our system.Text5843996816
urlThe URL that should be loaded so that the end-user can complete the deposit.Texthttps://checkout.trustly.com/checkout?OrderID=1234567890&SessionID=...

Failed deposits

If a credit notification has been sent, but Trustly never receives the funds, a debit notification will be sent to the merchant's NotificationURL. If you receive a debit after credit you should try to stop the order. If you are successfully able to stop the order before sending it to the end-user (or in case the user holds a balance on your side and you are able to lower the amount from their balance), you should respond with status "OK" to the debit notification. If you have already processed the order and are unable to recover the money you should respond with status "FAILED".

If you reply “OK” to the debit notification and the deposit still settles after that (which is not expected, but possible), Trustly's system will make an automatic refund to the end-user's bank account.

If you reply “FAILED” to the debit notification and the deposit settles after that, no automatic refund will be made.

You can trigger a debit notification in our test environment by running the D1 test case (see Acceptance testing.

Automatic refunds

If a Deposit is aborted during the payment process, a cancel notification is sent to the merchant. If Trustly for unknown reasons still receives the money for the Deposit, an automatic Refund is triggered and the end user will get the money back the the same bank account that they paid from. 

If the settlement report (ViewAutomaticSettlementDetailsCSV) is used by the merchant, both the settled Deposit and the automatic Refund will appear on the report. The sum of those two transactions will always be zero.

Error codes

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

Error NumError 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.
615ERROR_INVALID_AMOUNTThe Amount s invalid. The amount must be > 0 with 2 decimals.
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.
622ERROR_INVALID_CURRENCY_CODEThe currency code is invalid. See this page for valid currencies.
623ERROR_INVALID_PARAMETERSSome value or parameter in the deposit 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 serialized incorrectly.
637ERROR_DUPLICATE_MESSAGE_IDThe MessageID has been used before.
638ERROR_ENDUSER_IS_BLOCKEDThe enduser that initiated the payment is blocked.
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
698ERROR_INVALID_IPThe IP attribute sent is invalid. Only one IP address can be sent.
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 may need to remove the following attributes from the Deposit data: RequestDirectDebitMandate, QuickDeposit, ChargeAccountID.
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.
732ERROR_PAY_AND_PLAY_NOT_ALLOWEDTrustly's Pay N Play product is not enabled on the merchant's user in Trustly's system. If you want to use Pay N Play, please reach out to your Trustly contact.
734ERROR_NOT_SECURE_NOTIFICATIONURLThe NotificationURL must be using HTTPS, not plain HTTP.
737ERROR_INVALID_COUNTRYThe Country code sent in the Deposit data is invalid. The expected format is explained in Deposit with KYC attributes.