List Payments

get https://sandbox.trustly.one/api/v1/payments

Returns a list of transactions. It can be paged and filtered by appending arguments to the query string of the request.

Query Params

paymentType

array of strings

Returns payments of this Payment Type. It is possible to filter by multiple values by repeating this argument.

paymentType

merchantReference

string

Returns transactions of the payments associated with this merchant reference.

authorization.status

array of strings

Returns transactions of the payments at this payment Authorization Status.

authorization.status

verification.status

array of strings

Returns transactions of the payments at this payment Verification Status.

verification.status

paymentId

string

Returns payments of this identification.

merchant.merchantId

string

Returns payments by this merchant identification.

description

string

Returns payments by description.

paymentProvider.paymentProviderId

string

Returns payments by this payment provider identification.

customer.customerId

string

Returns payments by this customer identification.

fingerprint

string

Returns payments by this fingerprint.

createdAt.start

string

Returns payments after this creation date

createdAt.end

string

Returns payments before this creation date

updatedAt.start

string

Returns payments after this update date

updatedAt.end

string

Returns payments before this update date

amount.min

string

Returns payments for that minimum amount.

amount.max

string

Returns payments for that maximum amount.

paid.min

string

Returns payments for that minimum paid.

paid.max

string

Returns payments for that maximum paid.

refunded.min

string

Returns payments with this minimum refund amount.

refunded.max

string

Returns payments with this maximum refund amount.

orderBy

string

List payments by order field.

sortOrder

string

Returns payments by this sort order

startIndex

string

Returns payments from that offset

count

string

Returns the maximum number of payments specified by this field

Headers

Content-Type

string

Defaults to application/json

application/json

Response

Response body

object

payments

array of objects

required

length ≥ 1

payments*

object

required

string

paymentId

string

length ≥ 1

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

paymentType

integer

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.

1 2 3 4 5 6

merchant

object

merchantReference

string

length ≥ 1

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

merchantId

string

length ≥ 1

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

fingerprint

string

length ≥ 1

Internal use only

verification

object

account

object

description

string

length ≥ 1

A summary description of the order.

returnUrl

string

length ≥ 1

Return URL provided with the bank authorization.

cancelUrl

string

length ≥ 1

Cancel URL provided with the bank authorization.

currency

string

length ≥ 1

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

USD

amount

string

length ≥ 1

The total amount of the order, including tax and shipping. If transactionType is Recurring, this is the Setup Fee Amount.

paymentProvider

object

Details of the Financial institution

allowedPaymentProviderType

array of integers

allowedPaymentProviderType

auth

object

authorization

string

length ≥ 1

Authorization token.

authorizationStatus

number

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

authorizationStatusMessage

string

length ≥ 1

Status message of the related bank authorization.

pending

string

length ≥ 1

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

paid

string

length ≥ 1

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

refunded

string

length ≥ 1

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

reversed

string

length ≥ 1

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

balance

string

length ≥ 1

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

createdAt

integer

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

updatedAt

integer

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

recordVersion

number

The current record version.

paymentFlow

number

internal use only

customer

object

Base level end user definition

address

object

Valid mailing or billing address associated with the customer

recurrence

object

Recurring payment options

system

integer

Financial Institution Account Type:

-1: None
1: PayWithMyBank
2: TrustlyAB

-1 1 2

country

string

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.

US CA UK DE AU

paymentProviderSubtype

integer

Payment Provider Subtype:

1000: EasyOnline
2000: MEC
2001: MCD

1000 2000 2001

startIndex

number

required

itemsPerPage

number

required

200OK