- Created by PAYONE Writer, last modified by PAYONE Admin on 2021-11-05
Introduction
Trustly is a payment initiation service provided by Trustly Group AB for customers of >3.300 banks in 29 European countries. A user intending to pay via Trustly will be directed to the user bank's online banking website. After authentication the user will confirm a pre-filled giro transfer (usually by TAN). The merchant is notified about an successful payment immediately and Trustly will provide a payment guarantee.
Preauthorization
Request "preauthorization" | ||||||||
Common Parameter | Required | Comment | ||||||
---|---|---|---|---|---|---|---|---|
+ | Format | |||||||
+ | Fixed Value sb | |||||||
+ | Format | |||||||
+ | Specifies the total gross amount of a payment transaction. Value is given in smallest currency unit, e.g. Cent of Euro; Pence of Pound sterling; Öre of Swedish krona. The amount must be less than or equal to the amount of the corresponding booking. Format NUMERIC(1..10) Permitted values max. +/- 19 999 999 99 | |||||||
+ | Fixed Value
EUR | |||||||
- | Individual parameter (per payment process) Format | |||||||
- | Dynamic text element on account statements Format (3 lines with 27 characters each) and credit card statements. | |||||||
- | Indicates whether customer is “present” and can enter their data in the shop (=yes). Or customer is not present and can not enter any data (=no). Format Permitted Values | |||||||
Parameter ( personal data ) | ||||||||
- | Format | |||||||
- | Format | |||||||
o | Value specifies business relation between merchant and customer Format b2c Indicates business to private customer b2b indicates business to business customer (company) | |||||||
- | Format | |||||||
- | Format Samples | |||||||
- | First name of customer; optional if company is used, i.e.: you may use Format | |||||||
+ | Last name of customer; optional if company is used, i.e.: you may use
Format CHAR(2..50) | |||||||
- | Company name of customer; The company name is optional if lastname is used, i.e.: you may use Format | |||||||
- | Format | |||||||
- | Format Samples | |||||||
- | Format | |||||||
- | Format | |||||||
+ | ||||||||
- | Format Permitted values Samples US Samples CA | |||||||
- | Format Special Remark email validation: Max. length for email is 254 characters. Validation is set up in the following way: Example: username[63]@domain_name[63].suffix[60].suffix[60].suffix[4] "@" and "." is counted as a character as well; in case of a total of three suffixes, this would allow a total of 254 characters. | |||||||
- | Format | |||||||
- | Date of birth of customer Format DATE(8), YYYYMMDD Samples 20190101 19991231 | |||||||
- | Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display). If the language is not transferred, the browser language will be used. For a non-supported language English will be used. Format LIST Permitted values ISO 639-1 (Language) 2-letter-codes | |||||||
- | Format | |||||||
- | Format Permitted values * currently not in use | |||||||
- | Person specific numbers or characters, e.g. number of passport / ID card Format | |||||||
- | Customer's IP-V4-address (123.123.123.123) or IP-V6-address Format | |||||||
Parameter ( delivery data ) | ||||||||
- | Format | |||||||
- | Format | |||||||
- | Format | |||||||
- | Format | |||||||
- | Format | |||||||
- | Format | |||||||
- | Format | |||||||
o | Format Permitted values Samples US Samples CA | |||||||
- | Format Permitted values Samples Some countries require additional information in parameter shipping_state | |||||||
Parameter ( online transfer ) | ||||||||
+ | Fixed Value
TRL | |||||||
+ | Account type/ country for use with BBAN (i.e. bankcode, bankaccount): DE DE: Mandatory with bankcode, bankaccount, optional with IBAN For other countries than DE please use IBAN or IBAN/BIC Format Permitted Values
DE DK EE ES FI IT MT NL NO PL SE | |||||||
o | Bank Identifier Code to be used for payment or to be checked Format BIC is optional for all Bank transfers within SEPA. For Accounts from Banks outside of SEPA, BIC is still required. | |||||||
o | Bank Identifier Code to be used for payment or to be checked Format BIC is optional for all Bank transfers within SEPA. For Accounts from Banks outside of SEPA, BIC is still required. | |||||||
+ | URL for "payment successful" Format Scheme | |||||||
+ | URL for "faulty payment" Format Scheme | |||||||
+ | URL for "Back" or "Cancel" Format Scheme |
mid=23456 (your mid) portalid=12345123 (your portalid) key=abcdefghijklmn123456789 (your key) api_version=3.10 mode=test (set to „live“ for live-requests) request=preauthorization encoding=UTF-8 aid=12345 (your aid) clearingtype=sb reference=Ref123456 amount=300 currency=EUR lastname=Mustermann country=DE onlinebanktransfertype=TRL bankcountry=DE successurl=http://www.your-success.url errorurl=http://www.your-error.url backurl=http://www.your-back.url
Response "preauthorization" | ||
Common Parameter | Required | Comment |
---|---|---|
status | + | Permitted Values
REDIRECT ERROR |
Parameter (REDIRECT) | ||
+ | Format | |
+ | Format | |
+ | Redirect URL → zMerchant system has to redirect customer to this URL to complete payment Format | |
Parameter (ERROR) | ||
+ | In case of error the PAYONE Platform returns an error code for your internal usage. Format | |
+ | In case of error the PAYONE Platform returns an error message for your internal usage. Format | |
- | The customermessage is returned to your system in order to be displayed to the customer. (Language selection is based on the end customer's language, parameter "language") Format |
status=REDIRECT redirecturl=http://www.aliasregistrationpage.com txid=345678901 userid=123456789
Capture / Multi-partial Capture
Request "capture" | |||
Common Parameter | Required | Short explanation | |
---|---|---|---|
+ | Format | ||
o | Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2 Required for multi partial capture (starting with the 2nd capture) Format Permitted values | ||
+ | Specifies the total gross amount of a payment transaction. Value is given in smallest currency unit, e.g. Cent of Euro; Pence of Pound sterling; Öre of Swedish krona. The amount must be less than or equal to the amount of the corresponding booking. Format Permitted values | ||
+ | Fixed Value
EUR | ||
- | Dynamic text element on account statements Format (3 lines with 27 characters each) and credit card statements. |
mid=23456 (your mid) portalid=12345123 (your portalid) key=abcdefghijklmn123456789 (your key) api_version=3.10 mode=test (set to „live“ for live-requests) request=capture encoding=UTF-8 txid=345678901 amount=300 currency=EUR
Response "capture" | |||||||||
Common Parameter | Required | Comment | |||||||
---|---|---|---|---|---|---|---|---|---|
status | + | Permitted Values
APPROVED PENDING ??? ERROR | |||||||
Parameter (APPROVED) | |||||||||
+ | Format | ||||||||
o | Format | ||||||||
Parameter (PENDING) | |||||||||
+ | Format | ||||||||
+ | Format | ||||||||
Parameter (ERROR) | |||||||||
+ | In case of error the PAYONE Platform returns an error code for your internal usage. Format | ||||||||
+ | In case of error the PAYONE Platform returns an error message for your internal usage. Format |
status=APPROVED txid=345678901 settleaccount=no
Authorization
Request "authorization" | ||||||||
Common Parameter | Required | Short explanation | ||||||
---|---|---|---|---|---|---|---|---|
+ | Format | |||||||
+ | Fixed Value
sb | |||||||
+ | Format | |||||||
+ | Specifies the total gross amount of a payment transaction. Value is given in smallest currency unit, e.g. Cent of Euro; Pence of Pound sterling; Öre of Swedish krona. The amount must be less than or equal to the amount of the corresponding booking. Format NUMERIC(1..10) Permitted values max. +/- 19 999 999 99 | |||||||
+ | Fixed Value
EUR | |||||||
- | Individual parameter (per payment process) Format | |||||||
- | Dynamic text element on account statements Format (3 lines with 27 characters each) and credit card statements. | |||||||
- | Indicates whether customer is “present” and can enter their data in the shop (=yes). Or customer is not present and can not enter any data (=no). Format Permitted Values | |||||||
- | Format | |||||||
Parameter ( personal data ) | ||||||||
- | Format | |||||||
- | Format | |||||||
o | Value specifies business relation between merchant and customer Format b2c Indicates business to private customer b2b indicates business to business customer (company) | |||||||
- | Format | |||||||
- | Format Samples | |||||||
o | First name of customer; optional if company is used, i.e.: you may use Format | |||||||
+ | Last name of customer; optional if company is used, i.e.: you may use
Format CHAR(2..50) | |||||||
- | Company name of customer; The company name is optional if lastname is used, i.e.: you may use Format | |||||||
- | Format | |||||||
- | Format Samples | |||||||
- | Format | |||||||
- | Format | |||||||
- | Format Permitted values Samples US Samples CA | |||||||
+ | ||||||||
- | Format Special Remark email validation: Max. length for email is 254 characters. Validation is set up in the following way: Example: username[63]@domain_name[63].suffix[60].suffix[60].suffix[4] "@" and "." is counted as a character as well; in case of a total of three suffixes, this would allow a total of 254 characters. | |||||||
- | Format | |||||||
- | Date of birth of customer Format DATE(8), YYYYMMDD Samples 20190101 19991231 | |||||||
- | Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display). If the language is not transferred, the browser language will be used. For a non-supported language English will be used. Format LIST Permitted values ISO 639-1 (Language) 2-letter-codes | |||||||
- | Format | |||||||
- | Format Permitted values * currently not in use | |||||||
- | Person specific numbers or characters, e.g. number of passport / ID card Format | |||||||
- | Customer's IP-V4-address (123.123.123.123) or IP-V6-address Format | |||||||
Parameter ( delivery data ) | ||||||||
- | Format | |||||||
- | Format | |||||||
- | Format | |||||||
- | Format | |||||||
- | Format | |||||||
- | Format | |||||||
- | Format | |||||||
- | Format Permitted values Samples US Samples CA | |||||||
- | Format Permitted values Samples Some countries require additional information in parameter shipping_state | |||||||
Parameter ( online transfer ) | ||||||||
+ | Fixed Value TRL | |||||||
+ | Account type/ country for use with BBAN (i.e. bankcode, bankaccount): DE DE: Mandatory with bankcode, bankaccount, optional with IBAN For other countries than DE please use IBAN or IBAN/BIC Format Permitted Values
DE DK EE ES FI IT MT NL NO PL SE | |||||||
- | Format | |||||||
- | Bank Identifier Code to be used for payment or to be checked Format BIC is optional for all Bank transfers within SEPA. For Accounts from Banks outside of SEPA, BIC is still required. | |||||||
+ | URL for "payment successful" Format Scheme | |||||||
+ | URL for "faulty payment" Format Scheme | |||||||
+ | URL for "Back" or "Cancel" Format Scheme |
mid=23456 (your mid) portalid=12345123 (your portalid) key=abcdefghijklmn123456789 (your key) api_version=3.10 mode=test (set to „live“ for live-requests) request=authorization encoding=UTF-8 aid=12345 (your aid) clearingtype=sb reference=Ref123456 amount=300 currency=EUR lastname=Mustermann country=DE onlinebanktransfertype=TRL bankcountry=DE successurl=http://www.your-success.url errorurl=http://www.your-error.url backurl=http://www.your-back.url
Response "authorization" | ||
Common Parameter | Required | Comment |
---|---|---|
status | + | Permitted Values
REDIRECT ERROR |
Parameter (REDIRECT) | ||
+ | Format | |
+ | Format | |
+ | Redirect URL → zMerchant system has to redirect customer to this URL to complete payment Format | |
Parameter (ERROR) | ||
+ | In case of error the PAYONE Platform returns an error code for your internal usage. Format | |
+ | In case of error the PAYONE Platform returns an error message for your internal usage. Format | |
- | The customermessage is returned to your system in order to be displayed to the customer. (Language selection is based on the end customer's language, parameter "language") Format |
status=REDIRECT redirecturl=http://www.aliasregistrationpage.com txid=345678901 userid=123456789
Debit
Request "debit" | ||||||||||
Common Parameter | Required | Short explanation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
+ | Format | |||||||||
+ | Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2 Required for multi partial capture (starting with the 2nd capture) Format Permitted values | |||||||||
+ | Gross amount of debit (in smallest currency unit! e.g. cent, max. 19 999 999 99) Credit: amount < 0 Payment request: amount > 0 The amount must be less than or equal to the amount of the outstanding payment request of the corresponding booking. Format | |||||||||
+ | Specifies currency for this transaction Format LIST Permitted values ISO 4217 (currencies) 3-letter-codes Samples EUR USD GBP | |||||||||
- | Dynamic text element on account statements Format (3 lines with 27 characters each) and credit card statements. | |||||||||
- | Use for changes of payment type - only to select new payment type. Format LIST
| |||||||||
- | Use account details from debtor's master data Format LIST
| |||||||||
- | Format | |||||||||
Parameter ( online transfer - for refunds only ) | ||||||||||
o | Format | |||||||||
o | Bank Identifier Code to be used for payment or to be checked Format BIC is optional for all Bank transfers within SEPA. For Accounts from Banks outside of SEPA, BIC is still required. | |||||||||
o | Account type/ country for use with BBAN (i.e. bankcode, bankaccount): DE DE: Mandatory with bankcode, bankaccount, optional with IBAN For other countries than DE please use IBAN or IBAN/BIC Format | |||||||||
o | Account number (BBAN) Format | |||||||||
o | Sort code (BBAN) (only in DE) Format | |||||||||
o | A SEPA mandate can be created if a payment is initiated (amount > 0). Can be used to enforce a merchant specific mandate identification. The mandate_identification has to be unique. Format If the mandate_identification is not set PAYONE will create an unique mandate identification (pattern: PO-nnnnnnnnnn). PPS (PAYONE Payment Service): This parameter must not be used! For PPS the PAYONE platform defines the mandate_identification | |||||||||
- | Account holder Format CHAR(1..50) |
mid=23456 (your mid) portalid=12345123 (your portalid) key=abcdefghijklmn123456789 (your key) api_version=3.10 mode=test (set to „live“ for live-requests) request=capture encoding=UTF-8 txid=345678901 sequencenumber=1 amount=1000 currency=EUR
Response "debit" | ||||||||
---|---|---|---|---|---|---|---|---|
Common Parameter | Required | Comment | ||||||
status | + | Permitted Values
APPROVED ERROR | ||||||
Parameter (APPROVED) | ||||||||
+ | Format | |||||||
+ | Format | |||||||
Parameter (ERROR) | ||||||||
+ | In case of error the PAYONE Platform returns an error code for your internal usage. Format | |||||||
- | In case of error the PAYONE Platform returns an error message for your internal usage. Format | |||||||
- | The customermessage is returned to your system in order to be displayed to the customer. (Language selection is based on the end customer's language, parameter "language") Format |
status=APPROVED txid=345678901 settleaccount=no
Refund
Request "refund" | ||||||||
Common Parameter | Required | Short explanation | ||||||
---|---|---|---|---|---|---|---|---|
+ | Format | |||||||
+ | Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2 Required for multi partial capture (starting with the 2nd capture) Format Permitted values | |||||||
+ | Always provide a negative amount Format | |||||||
+ | Specifies currency for this transaction Format LIST Permitted values ISO 4217 (currencies) 3-letter-codes Samples EUR USD GBP | |||||||
- | Dynamic text element on account statements Format (3 lines with 27 characters each) and credit card statements. | |||||||
- | Use account details from debtor's master data Format LIST
| |||||||
- | Format |
mid=23456 (your mid) portalid=12345123 (your portalid) key=abcdefghijklmn123456789 (your key) api_version=3.10 mode=test (set to „live“ for live-requests) request=capture encoding=UTF-8 txid=345678901 sequencenumber=2 amount=1000 currency=EUR
Response "refund" | ||
Common Parameter | Required | Comment |
---|---|---|
status | + | Permitted Values
APPROVED PENDING ERROR |
Parameter (APPROVED) | ||
+ | Format | |
Parameter (PENDING) | ||
+ | Format | |
Parameter (ERROR) | ||
+ | In case of error the PAYONE Platform returns an error code for your internal usage. Format | |
+ | In case of error the PAYONE Platform returns an error message for your internal usage. Format |
status=APPROVED txid=345678901
Specials
- Partial Captures are supported but the account of the customer will be debit with the Preauthorization ?????
- Partial Refunds are not supported ?????
- Reversal is not supported ?????
Examples of Usage
Sale
Order & Delivery
Returns
- No labels