--- title: "Reclaim transaction" method: POST path: "/transactions/{transactionId}/reclaim" tags: ["transactions"] --- # Reclaim transaction `POST /transactions/{transactionId}/reclaim` 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](/integrate/core-concepts/webhooks-and-events) handler to get transaction status updates. ## Path parameters - `transactionId` string, required ## Headers - `Authorization` string, required ## Request body - object - `merchantReference` string — 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. - `amount` string, 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 `200` OK - Transaction — A Trustly transaction object - `transactionId` string, 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](/integrate/api-fundamentals/status-codes-and-type-definitions#transaction-types) - `payment` Payment, required — A Trustly Payment - `paymentId` string, 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. - `merchant` PaymentMerchant, required - `merchantId` string — Unique Trustly Merchant ID. - `name` string — Merchants name. - `merchantReference` string, required — An external reference from the merchant. Ex: Order identifier from merchant e-commerce application. - `merchantId` string, required — Your Trustly Merchant Id. It will be provided to you. - `fingerprint` string, required — Internal use only - `verification` Verification, required - `status` '1' | '2' | '3' | '4' — Verification Status: * `1`: Automatic - Payment verification followed Trustly internal rules. * `2`: ToVerify - Payment transaction is held (status = OnHold) for further investigation and approval by the merchant. * `3`: Verified - Payment was verified and approved by the merchant or Trustly (see Verification Mode). * `4`: Refused - Payment was denied by the merchant or Trustly after verification. - `mode` '1' | '2' | '3' | '4' — Verification Mode: * `1`: VerifiedByMerchant * `2`: ApprovedByMerchant * `3`: VerifiedByTrustly * `4`: AmountAuthorizedByMerchant - `verifyCustomer` boolean — If true, the Customer information (name and zip code) was verified against information provided by the User's bank. - `account` Account, required - `providerId` string — Payment provider ID. - `paymentProvider` PaymentProvider — Details of the Financial institution - `paymentProviderId` string — A unique identifier for the Payment Provider. - `type` number, double - `name` string, required — Name of the payment provider - `instantPayoutAvailable` boolean — Whether payment provider supports instant payout. - `subType` '1000' | '2000' | '2001' — Financial Institution Account Type: * `1000`: Online Banking * `2000`: Manual Entry * `2001`: Manual Entry with Challenge Deposit - `swift` string - `address` Address — Valid mailing or billing address associated with the customer - `address1` string — Address line 1 (e.g., street or PO Box) - `address2` string — Address line 2 (e.g., apartment, suite or unit number) - `city` string — City, district, town or village - `state` string — State, province or region code - `zip` string — ZIP or Postal Code - `country` string, required — 2 character [ISO Country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `country` 'US' | 'CA' | 'UK' | 'DE' | 'AU' — 2-letter ISO country code of the financial institution - `instantPayment` boolean - `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. - `name` string — A description to identify a specific account (e.g. Test checking account) - `type` number, double — See Financial Institution Account Type Values. - `profile` number, double — See Financial Institution Account Profile Values - `accountNumber` string — Bank Account Number or VAN if `virtualAccountRoutingPair` is equal to `true`. - `iban` string — IBAN (International Bank Account Number) is an internationally agreed system of identifying bank accounts across national borders - `verified` boolean — Indicates if the account is verified or not. - `verification` FinancialInstitutionAccountVerification - `verified` boolean, required — true if the account is verified; false otherwise. - `type` '1' | '2' | '3', required — Verification Type: * `1`: Manual - The account was verified with manual account verification. For example, Manual Electronic Check and Micro Challenge Deposit. * `2`: Online Banking verification - The Account was verified using the Trustly Online Banking application. * `3`: Database verification - The Account was verified using the Trustly database or a Third-Party Service. - `hasEnoughFunds` boolean, required — If true, there is enough balance in account. - `verificationDate` integer, required — The date and time the verification was completed as a UNIX timestamp. - `score` '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' — Verification Score: * `0`: Invalid input. The account or routing number are invalid. (Verified Mapping = false) * `1`: There is a strong indication that the account is invalid. (Verified Mapping = false) * `2`: There are active non-bankable returns on this account that are less than 3 years old. (Verified Mapping = false) * `3`: There are administrative returns on this account. (Verified Mapping = false) * `4`: The format appears to be suspicious. (Verified Mapping = false) * `5`: There is no data on this account or format. (Verified Mapping = false) * `6`: We have not seen this account, but the format appears to be valid. (Verified Mapping = true) * `7`: We have seen this account but have not received a final disposition on the transaction. (Verified Mapping = true) * `8`: We have seen this account, but not in the last 6 months, and have seen no returns associated with the account. (Verified Mapping = true) * `9`: We have seen this account in the last 6 months and have seen no returns associated with the account. (Verified Mapping = true) * `10`: This account has been directly validated with/by the financial institution or 3rd party. We have the highest confidence that this account is valid. (Verified Mapping = true) - `thirdPartyScore` '0' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900' | '999' — Verification Third-Party Score: * `0`: Failed RT validation. (Verified Mapping = 0) * `100`: The supplier has a strong indication that this account is invalid. (Verified Mapping = 1) * `200`: The supplier has active non-bankable debt(s) on this account that are less than 3 years old. (Verified Mapping = 2) * `300`: The supplier has administrative returns on this account. (Verified Mapping = 3) * `400`: The supplier does not have Neg data on this account, but the format appears to be suspicious. (Verified Mapping = 4) * `500`: The supplier does not have data on this account or format. (Verified Mapping = 5) * `600`: The supplier has not seen this account, but the format appears valid. (Verified Mapping = 6) * `700`: The supplier has seen this account, but did not receive a final disposition on the transaction. (Verified Mapping = 7) * `800`: The supplier has seen this account, but not in the last 6 months. (Verified Mapping = 8) * `900`: The supplier has seen this account in the last 6 months. (Verified Mapping = 9) * `999`: The supplier has the highest confidence that this account is valid. (Verified Mapping = 10) - `numberOfTries` number, double — Number of tries allowed. - `numberOfAttemptsLeft` number, double — Number of remaining attempts. - `source` number, double - `routingNumber` string — Bank Routing Number - `token` string — The Account Token - `accountNumberLastFour` string — The last 4 digits of the real account number. - `virtualAccountRoutingPair` boolean — Indicates if account is using virtual/tokenized account and routing numbers (VANs/TANs) or not. - `description` string — A summary description of the order. - `returnUrl` string — Return URL provided with the bank authorization. - `cancelUrl` string — Cancel URL provided with the bank authorization. - `currency` 'USD', required — 3-letter ISO Currency Code. Currently only USD is supported. - `amount` string, required — The total amount of the order, including tax and shipping. If transactionType is Recurring, this is the Setup Fee Amount. - `paymentProvider` PaymentProvider, required — Details of the Financial institution - `paymentProviderId` string — A unique identifier for the Payment Provider. - `type` number, double - `name` string, required — Name of the payment provider - `instantPayoutAvailable` boolean — Whether payment provider supports instant payout. - `subType` '1000' | '2000' | '2001' — Financial Institution Account Type: * `1000`: Online Banking * `2000`: Manual Entry * `2001`: Manual Entry with Challenge Deposit - `swift` string - `address` Address — Valid mailing or billing address associated with the customer - `address1` string — Address line 1 (e.g., street or PO Box) - `address2` string — Address line 2 (e.g., apartment, suite or unit number) - `city` string — City, district, town or village - `state` string — State, province or region code - `zip` string — ZIP or Postal Code - `country` string, required — 2 character [ISO Country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `country` 'US' | 'CA' | 'UK' | 'DE' | 'AU' — 2-letter ISO country code of the financial institution - `instantPayment` boolean - `allowedPaymentProviderType` integer[], required - `auth` PaymentAuth, required - `token` string — Authorization token. - `status` integer — See Authorization Status Values. - `message` string — Authorization message. - `authorization` string, required — Authorization token. - `authorizationStatus` number, double, required — Status of the related bank authorization. See Transaction Status Values. - `authorizationStatusMessage` string, required — Status message of the related bank authorization. - `pending` string, required — The total amount that is still pending completion. (10 characters with support for 2 decimal places) - `paid` string, required — The total amount that was already paid. (10 characters with support for 2 decimal places) - `refunded` string, required — The total amount that was refunded. (10 characters with support for 2 decimal places) - `reversed` string, required — The total amount that was reversed. (10 characters with support for 2 decimal places) - `balance` string, required — The balance of the amount paid, minus the amount reversed and/or refunded. (10 characters with support for 2 decimal places) - `createdAt` integer, required — The date and time the transaction was created as a UNIX timestamp. - `updatedAt` integer, required — The date and time the transaction was last updated as a UNIX timestamp. - `recordVersion` number, double, required — The current record version. - `paymentFlow` number, double, required — internal use only - `customer` Customer — The Trustly customer object, containing identification details and contact information. - `name` string, required — Full name of the Customer - `taxId` string — Customer tax ID (e.g. SSN [US], SIN [CA]). *May be required depending on industry and location.* - `address` Address, required — Valid mailing or billing address associated with the customer - `address1` string — Address line 1 (e.g., street or PO Box) - `address2` string — Address line 2 (e.g., apartment, suite or unit number) - `city` string — City, district, town or village - `state` string — State, province or region code - `zip` string — ZIP or Postal Code - `country` string, required — 2 character [ISO Country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `phone` string, required — Customer phone number. - `email` string, required — Customer email address. - `dateOfBirth` string — Customer date of birth. - `createdAt` integer — The record created date and time as a UNIX timestamp. - `updatedAt` integer — The record created date and time as a UNIX timestamp. - `customerId` string — A unique Trustly customer identifier. - `externalId` string — A unique merchant customer identifier. - `merchantId` string — A unique Trustly merchant identifier. - `enrollDate` integer — Date of the user's first transaction in your system, regardless of payment method used as a UNIX timestamp. - `vip` string — Range that determines how low-risk the customer represents to the merchant - `currency` string — Customer currency. - `balance` string — Customer account balance (not associated with a financial institution account). - `organizationNumber` string — Organization number for business accounts - `externalTier` string — It should describe the customer''s rank to the merchant (e.g. Gold, Diamond, 4 stars, etc.) - `personId` string — Unique customer identity throughout different banks. - `customData` CustomerCustomData — Object for sending merchant-specific custom data. - `driverLicense` DriverLicense - `number` string, required — Driver License number. - `state` string, required — 2 character ISO State code. - `nationalId` string — Customer National ID - `address` Address — Valid mailing or billing address associated with the customer - `address1` string — Address line 1 (e.g., street or PO Box) - `address2` string — Address line 2 (e.g., apartment, suite or unit number) - `city` string — City, district, town or village - `state` string — State, province or region code - `zip` string — ZIP or Postal Code - `country` string, required — 2 character [ISO Country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `recurrence` Recurrence — Recurring payment options - `startDate` string, date-time — Recurring payment start date as a UNIX timestamp. - `endDate` string, date-time — Recurring payment end date as a UNIX timestamp. - `nextOccurrence` string, date-time — When the next capture will be issued if using automatic captures as a UNIX timestamp. - `recurringAmount` string — Recurring payment amount. (maximum of 10 characters with support for 2 decimal places) - `debtSettlement` string — Any debt amount settlement done outside of the Trustly like discounts or when consumers pays one recurring debt using another payment method like traditional checks or credit cards. (maximum of 10 characters with support for 2 decimal places) - `frequency` integer — How many payments per frequencyUnit. Defaults to 1. Example: To define 2 recurring payments every 3 months set: frequency=2, frequencyUnit=3 and frequencyUnitType=3. - `frequencyUnit` number, double — Defines with frequencyUnitType the interval of the frequency of payments. - `frequencyUnitType` 'Day' | 'Week' | 'Month' | 'Year' — Frequency Unit Type - `automaticCapture` boolean — If true, payment captures are issued automatically. - `recurrenceId` string - `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 - `currency` 'USD', required — 3-letter ISO Currency Code. Currently only USD is supported. - `amount` string, required — The amount of the transaction. (10 characters with support for 2 decimal places) - `pending` string, required — The total amount that is still pending completion. (10 characters with support for 2 decimal places) - `paid` string, required — The total amount that was already paid. (10 characters with support for 2 decimal places) - `refunded` string, required — The total amount that was refunded. (10 characters with support for 2 decimal places) - `reversed` string, required — The total amount that was reversed. (10 characters with support for 2 decimal places) - `balance` string, required — The balance of the amount paid, minus the amount reversed and/or refunded. (10 characters with support for 2 decimal places) - `paymentProviderTransaction` PaymentProviderTransaction, required — Payment Provider Transaction - `paymentProviderTransactionId` string — Unique payment provider transaction identifier. - `status` string — See Payment Provider Transaction Status Codes. - `statusMessage` string — Payment provider transaction status message. - `signature` string - `statusDescription` string - `paymentProcessor` PaymentProviderTransactionPaymentProcessor - `paymentProcessorId` string - `type` integer - `name` string - `shortName` string - `url` string - `active` string - `thirdPartyDeclineCode` string - `clearingHouse` string - `instantSettle` boolean — Whether instant settlement was used for transaction. - `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](/integrate/api-fundamentals/status-codes-and-type-definitions#transaction-types) - `statusMessage` string, required — A descriptive status message. (120 characters) - `ip` string, required — The client IP address in IPv4 or IPv6 format. - `createdAt` integer, required — The date and time the transaction was created as a UNIX timestamp. - `processedAt` integer, required — The date and time the transaction was processed as a UNIX timestamp. - `completedAt` integer, required — The date and time the transaction was completed as a UNIX timestamp. - `updatedAt` integer, required — The date and time the transaction was last updated as a UNIX timestamp. - `ppTrxId` string — internal use only - `merchantReference` string, required — Merchants internal reference id for the transaction. - `expiredAt` integer — The date and time the preauthorization will expire as a UNIX timestamp. - `recordVersion` number, double, required — The current record version. - `originalTransactionId` string - `fee` string - `timeZone` string - `representmentScheduledAt` number, double - `paymentProcessorType` string - `statusCode` string - `preAuthorized` boolean --- [API](https://skmtc.dev/trustly/apis/api.md) · [All operations](https://skmtc.dev/trustly/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/trustly/api/revisions/2dad675032f1/schema)