Skip to main content
POST
Record a manual payment against an order

Authorizations

X-API-KEY
string
header
required

API key for the Twice API

Path Parameters

orderId
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

paymentMethod
object
required
amount
integer
required
Required range: x <= 9007199254740991
issuedAt
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
paymentLines
object
invoiceAllocations
object

Response

200

id
string
required
type
enum<string>
required
Available options:
sale,
deposit_auth,
deposit_capture,
refund,
refund_reverse,
cancel,
expire
status
enum<string>
required
Available options:
pending,
succeeded,
failed,
voided
pricing
object
required
receiptNumber
number | null
required
issuedAt
string
required
lines
object
required
transactions
object
required
modificationSummary
object
required
createdAt
string
required
updatedAt
string
required
orderId
string
originalPaymentId
string
meta
any
tenantInfo
object