TRtrustly
transactions

Preauthorize transaction

Changed on

The Preauthorize API allows the merchant to pre-authorize one or more captures up to the total pre-authorized amount on a pre-authorized period interval in hours. Captures after the pre-authorized period interval are treated as normal Captures (will need to pass the full balance and risk analysis to be guaranteed).

post/transactions/{transactionId}/capture/preAuth

Request

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

Path parameters

transactionIdstring required

Authorization Transaction ID retrieved from a Trustly Deferred or Recurring transaction.

Request body

merchantReferencestring required

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

periodinteger required

Number of hours the preauthorization will be valid for.

amountstring required

The amount to be authorized. (maximum of 10 characters with support for 2 decimal places). Required if the bank authorization was created with an amount of 0.00. If not specified, then the full amount of the bank authorization will be used.

splitTokenstring

Token received on the Authorize event.

externalTierstring

The merchant's tier associated with the customer (e.g. vip).

metadata.remittance.withdrawalMethod'BankDeposit' | 'Cash' | 'DebitCard' | 'DigitalWallet' | 'HomeDelivery'

The method by which the recipient will receive the funds.

interactionIdstring

Optional interaction ID parameter for Preauthorization and Capture APIs, inclusion of which signifies consumer interaction tied to data obtained from getTrustlyInteraction function. If not specified, Trustly assumes the consumer is present in session. Set to "consumerNotPresent" to signify that the transaction is merchant-initiated and the consumer is not present.

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-capture-preauth removed and replaced with transactions_post-transactions-transactionId-capture-preauth