Preauthorize a transaction

post

https://sandbox.trustly.one/api/v1/transactions/{transactionId}/capture/preAuth

Verify that an account is valid and has a positive balance without placing a hold on specific funds.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

transactionId

string

required

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

Form Data

merchantReference

string

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.

period

int32

required

1 to 6

Defaults to 0

Number of hours the preauthorization will be valid for.

amount

string

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.

splitToken

string

Token received on the Authorize event.

externalTier

string

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

metadata.remittance.withdrawalMethod

string

enum

The method by which the recipient will receive the funds.

Allowed:

interactionId

string

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.

Headers

Content-Type

string

Defaults to application/x-www-form-urlencoded

application/x-www-form-urlencoded

Response

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK