Skip to main content
POST
Capture an authorised deposit hold on a deposit-auth transaction

Authorizations

X-API-KEY
string
header
required

API key for the Twice API

Path Parameters

transactionId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

Body

amount
integer
required
Required range: x <= 9007199254740991
reason
string
taxLines
object
email
string<email>
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
sendEmail
boolean
default:false

Response

200

status
enum<string>
required
Available options:
success