PartialApprovalData
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Durable record of a partial approval: the issuer authorized less than the requested amount, and the gateway captured the evidence plus the lifecycle of the decision that followed.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
disposition
required |
PartialApprovalDisposition PartialApprovalDisposition | Where the partial approval currently sits in its decision lifecycle.
`null` is equivalent to `Pending`:
the shape a document written by the detection step alone can take.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
dispositionSetAtUtc
required |
string (date-time) | UTC timestamp of the moment `disposition` last moved. Set alongside every
disposition write, including the initial transition to
`Pending` at detection time, so the age of a stuck
pending disposition is measurable.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
dispositionDeadlineUtc
required |
string (date-time) | UTC instant by which a `Pending` disposition must be
resolved before the gateway voids the reduced authorization on the operator's behalf.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
voidReason
required |
string | Why the reduced authorization was voided, for the merchant audit trail. Only meaningful
when `disposition` is `Voided`;
`null` otherwise.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
requestedAmount
required |
number (double) | The amount the gateway asked the issuer to authorize, in major currency units, snapshotted
at detection time. Kept here rather than read back from the response because a subsequent
reversal overwrites `/ResponseData`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
approvedAmount
required |
number (double) | The lesser amount the issuer actually authorized, in major currency units, snapshotted at
detection time. The shortfall a split tender needs to collect is
`requestedAmount` minus this value.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.