TRtrustly
payments

Retrieve payment

Changed on

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.

get/payments/{paymentId}

Request

  • Base URL
    https://sandbox.trustly.one/api/v1
  • URL
    https://sandbox.trustly.one/api/v1/payments/{paymentId}
  • Auth
    HTTP basic

Path parameters

paymentIdstring required

The identifier of the payment object to be retrieved.

Response

OK

paymentIdstring required

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

paymentType'1' | '2' | '3' | '4' | '5' | '6' required

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.
merchantReferencestring required

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

merchantIdstring required

Your Trustly Merchant Id. It will be provided to you.

fingerprintstring required

Internal use only

descriptionstring

A summary description of the order.

returnUrlstring

Return URL provided with the bank authorization.

cancelUrlstring

Cancel URL provided with the bank authorization.

currency'USD' required

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

amountstring required
The total amount of the order, including tax and shipping. If transactionType is Recurring, this is the Setup Fee Amount.
allowedPaymentProviderTypeinteger[] required
authorizationstring required

Authorization token.

authorizationStatusnumber double required

Status of the related bank authorization. See Transaction Status Values.

authorizationStatusMessagestring required

Status message of the related bank authorization.

pendingstring required

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

paidstring required

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

refundedstring required

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

reversedstring required

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

balancestring required

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

createdAtinteger required

The date and time the transaction was created as a UNIX timestamp.

updatedAtinteger required

The date and time the transaction was last updated as a UNIX timestamp.

recordVersionnumber double required

The current record version.

paymentFlownumber double required

internal use only

system'-1' | '1' | '2'

Financial Institution Account Type:

  • -1: None
  • 1: PayWithMyBank
  • 2: TrustlyAB
country'US' | 'CA' | 'UK' | 'DE' | 'AU'

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.

paymentProviderSubtype'1000' | '2000' | '2001'

Payment Provider Subtype:

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

Changes

  • dd0a38d95088Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security HTTPBasic was added to the API

  • 1d5aabcc1d16Revision changes
    • info

      api operation id get-payments removed and replaced with payments_get-payments