TRtrustly
transactions

Reclaim transaction

Changed on

Reclaims a previously completed Deposit transaction (minimum of 0.99). You can optionally reclaim partially. You can do so as many times as you wish until the entire deposited amount has been reclaimed.

A Deposit transaction can only be reclaimed after the transaction has been processed and completed.

Ensure you also implement an event notification handler to get transaction status updates.

post/transactions/{transactionId}/reclaim

Request

  • Base URL
    https://sandbox.trustly.one/api/v1
  • URL
    https://sandbox.trustly.one/api/v1/transactions/{transactionId}/reclaim
  • Auth
    HTTP basic

Path parameters

transactionIdstring required

Deposit Transaction ID retrieved from a Trustly Deposit transaction.

Request body

merchantReferencestring

A specific merchant reference for this reclaim. For example, this could be a merchant order number or the same merchant reference value used in the original establish call.

amountstring required

The amount to be reclaimed which can be less or equal than the current balance of the deposit transaction being reclaimed. If the value is omitted the remaining balance is reclaimed. (maximum of 10 characters with support for 2 decimal places)

Response

OK

transactionIdstring required

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

transactionType'0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '10' required

Type of transaction record. See Transaction Types

currency'USD' required

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

amountstring required

The amount of the transaction. (10 characters with support for 2 decimal places)

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)

status'0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '10' | '11' | '12' | '13' | '14' required

Status code of the Payment Provider Transaction record. See Transaction Types

statusMessagestring required

A descriptive status message. (120 characters)

ipstring required

The client IP address in IPv4 or IPv6 format.

createdAtinteger required

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

processedAtinteger required

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

completedAtinteger required

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

updatedAtinteger required

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

ppTrxIdstring

internal use only

merchantReferencestring required

Merchants internal reference id for the transaction.

expiredAtinteger

The date and time the preauthorization will expire as a UNIX timestamp.

recordVersionnumber double required

The current record version.

originalTransactionIdstring
feestring
timeZonestring
representmentScheduledAtnumber double
paymentProcessorTypestring
statusCodestring
preAuthorizedboolean

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 post-transactions-transactionId-reclaim removed and replaced with transactions_post-transactions-transactionId-reclaim