APIPayments

Retrieve Payment

View as Markdown
Retrieves the details of a Payment. Supply the unique paymentId that was returned from your previous request, and Trustly will return the corresponding payment information.

Authentication

AuthorizationBasic

Path parameters

paymentIdstringRequired

Response

OK
requiredanyOptional
paymentIdstringOptional>=1 character

A unique payment identifier generated by Trustly (15 character max).

paymentTypeenumOptional

Financial Institution Account Type:

  • 1: Instant - Instant payment. The debit instruction is automatically initiated with that day’s batch after consumer authorization.
  • 2: Deferred - Deferred payment. Payment is authorized but the capture operation must be called to initiate the debit. You can start to initiate multiple captures that are less than or equal to the original transaction authorization amount.
  • 3: Recurring - Recurring payment. Same as deferred but associated to a payment agreement between consumer and merchant that defines how much and when the capture can be started.
  • 4: Disbursement - Disbursement payment. This payment type can only be used for disbursements.
  • 5: Verification - This payment type is used to verify the customer financial institution account as the payments will be done outside of the Trustly system.
  • 6: Retrieval Data retrieval. This payment type is used to retrieve account and user information from Trustly without an associated payment request. This payment type is not enabled by default. Contact Trustly if you need this feature.
merchantobjectOptional
merchantReferencestringOptional>=1 character

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

merchantIdstringOptional>=1 character
Your Trustly Merchant Id. It will be provided to you.
fingerprintstringOptional>=1 character
Internal use only
verificationobjectOptional
accountobjectOptional
descriptionstringOptional>=1 character
A summary description of the order.
returnUrlstringOptional>=1 character
Return URL provided with the bank authorization.
cancelUrlstringOptional>=1 character
Cancel URL provided with the bank authorization.
currencyenumOptional

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

amountstringOptional>=1 character
The total amount of the order, including tax and shipping. If transactionType is Recurring, this is the Setup Fee Amount.
paymentProviderobjectOptional
Details of the Financial institution
allowedPaymentProviderTypelist of integersOptional
authobjectOptional
authorizationstringOptional>=1 character
Authorization token.
authorizationStatusdoubleOptional
Status of the related bank authorization. See Transaction Status Values.
authorizationStatusMessagestringOptional>=1 character
Status message of the related bank authorization.
pendingstringOptional>=1 character

The total amount that is still pending completion. (10 characters with support for 2 decimal places)

paidstringOptional>=1 character

The total amount that was already paid. (10 characters with support for 2 decimal places)

refundedstringOptional>=1 character

The total amount that was refunded. (10 characters with support for 2 decimal places)

reversedstringOptional>=1 character

The total amount that was reversed. (10 characters with support for 2 decimal places)

balancestringOptional>=1 character

The balance of the amount paid, minus the amount reversed and/or refunded. (10 characters with support for 2 decimal places)

createdAtintegerOptional
The date and time the transaction was created as a UNIX timestamp.
updatedAtintegerOptional
The date and time the transaction was last updated as a UNIX timestamp.
recordVersiondoubleOptional
The current record version.
paymentFlowdoubleOptional
internal use only
customerobjectOptional
The Trustly customer object, containing identification details and contact information.
addressobjectOptional
Valid mailing or billing address associated with the customer
recurrenceobjectOptional
Recurring payment options
systemenumOptional

Financial Institution Account Type:

  • -1: None
  • 1: PayWithMyBank
  • 2: TrustlyAB
countryenumOptional

2-character ISO code of the country for the bank account that was selected. Currently only the US, CA, UK, DE, and AU are supported.

paymentProviderSubtypeenumOptional

Payment Provider Subtype:

  • 1000: EasyOnline
  • 2000: MEC
  • 2001: MCD