Sign in
banking.v1.PaymentConsentService

GetConsentInvitation

The redacted invitation behind an emailed token. Side-effect free. Unknown, expired, spent, burned and closed tokens all return the SAME NOT_FOUND.

post/banking.v1.PaymentConsentService/GetConsentInvitation

Request

  • The document declares no server URL.
  • Auth: none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

tokenstring

The opaque single-use token from the mail. Never the code.

Response

Success

payment_idstring
state'PAYMENT_STATE_UNSPECIFIED' | 'PAYMENT_STATE_PENDING' | 'PAYMENT_STATE_APPROVED' | 'PAYMENT_STATE_EXECUTED' | 'PAYMENT_STATE_EXECUTION_FAILED' | 'PAYMENT_STATE_REJECTED' | 'PAYMENT_STATE_EXPIRED' | 'PAYMENT_STATE_CANCELLED'

Where an order stands. Terminal everywhere except PENDING and APPROVED.

tierstring
amountstring
reasonstring
payload_hashstring
initiator_emailstring

Who opened it, masked.

subject_emailstring

The recipient's own masked address, so they can confirm the mail reached the right mailbox before typing the code.

decision'CONSENT_DECISION_UNSPECIFIED' | 'CONSENT_DECISION_PENDING' | 'CONSENT_DECISION_APPROVE' | 'CONSENT_DECISION_REJECT'

What the emailed investor answered.

attempts_remaininginteger

Code attempts left before the token burns.

Changes

Changes to this operation have not been checked yet.