Create a pre-authorization

post

https://integrations-sandbox.shopback.com/demo/merchant/tokenized-payment/v1/pre-auths

Places a hold on the funds associated with a payment token. Use capture to settle or void to release the hold.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

paymentToken

string

required

Payment token from POST /token. Resolves the user and their default card.

merchantUserId

string

required

Merchant's opaque identifier for the end user (e.g. user ID). Used to verify the payment token belongs to this user.

amount

number

required

Hold amount. Must be > 0. Also the capture amount.

currency

string

required

3-letter ISO currency code. Must match the merchant channel country currency.

merchantRef

string

required

Merchant's reference ID (e.g. trip ID). Used for idempotent duplicate detection.

merchantMetadata

object

Opaque JSON blob stored verbatim and returned on read endpoints. Max 5 keys; each string value must not exceed 200 characters.

Headers

X-ShopBack-Idempotent-Id

string

required

Unique key to safely retry the request without duplicate holds. Use a UUID per logical pre-auth attempt.

Responses

201