Corgi BankDocumentation
OpenAPI

The Payment Request object

PaymentRequest is a request for payment sent (outbound) or received (inbound).

Attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired
cancellation_reason_codestringRequired
cancellation_statusstringRequired

Requested, cancelled, refused, failed

counterpartyobjectRequired
4 child attributes
account_numberstringRequired
account_typestringRequired
namestringRequired
routing_numberstringRequired
created_atstring · date-timeRequired
directionstringRequired
document_numberstringRequired
expires_atstring · date-time or nullOptional
idstringRequired
msg_idstringRequired
payment_idstringRequired

Example lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm

railstringRequired
reasonstringRequired
reason_codestringRequired
remittancestringRequired
requested_execution_datestring · dateRequired

A business date, YYYY-MM-DD

statusstringRequired

Sent, acknowledged, received, presented, accepted, paid, rejected, expired, cancelled, failed

uetrstringRequired
updated_atstring · date-timeRequired

to move to open esc to close