AchAuthorizationEvidence
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The ACH authorization the account holder gave when this bank account was saved: where it was given, under which SEC code, which authorization text and version, when, from which IP address, and the transaction that saved the account. The full authorization text is on that transaction.
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 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
channel
required |
AchAuthorizationEvidenceChannel AchAuthorizationEvidenceChannel | Where the authorization was given: the hosted payment page, the Virtual Terminal, or the API.
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.
| ||||||||
secCode
required |
string | The NACHA Standard Entry Class the authorization was given under: `WEB`, `TEL` or
`PPD`.
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.
| ||||||||
kind
required |
AchAuthorizationEvidenceKind AchAuthorizationEvidenceKind | Which authorization text applies: the single-debit, save-only or recurring hosted page text, or an
operator or API attestation.
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.
| ||||||||
statementVersion
required |
string | The version hash (`sha256:` followed by hex) of the authorization text, as recorded on the
save transaction.
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.
| ||||||||
acceptedAt
required |
string (date-time) | When the authorization was accepted or attested, in UTC.
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.
| ||||||||
consumerIp
required |
string | The IP address the payer accepted the authorization from. Recorded for a hosted payment page
authorization; null for a Virtual Terminal or API attestation, where no payer is on the page.
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.
| ||||||||
saveTransactionId
required |
string (uuid) | The id of the transaction that saved this bank account. Its record carries the full authorization
text.
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.