Skip to main content
POST
Refund a 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
paymentLines
object
idempotencyKey
string<uuid>
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)$

Response

200

refundPayment
object
required
originalPayment
object
required
refundedAmount
number
required
totalRefundedForTransaction
number
required
transactionFullyRefunded
boolean
required