Initiate one or more payments (User Initiated)

POST {{koxa_payments_api_url}}/payments

Initiate payments. Authentication prompt is likely (see 401 example).

Request Body

{"user"=>{"user_id"=>"{{user_id_rufus}}", "company_id"=>"{{company_id}}", "app_context"=>{"app_id"=>"app_example000701kw7p422q4m", "app_name"=>"Workday", "app_user"=>"rufus-rr@koxa.io"}}, "account"=>{"account_id"=>"{{account_id}}", "account_name"=>"RR Business Checking 1603"}, "payments"=>[{"date"=>"{{payment_date}}", "type"=>"pay_ach", "payee"=>{"payee_name"=>"Winter Drafts", "account_number"=>"841465469866", "routing_number"=>"021000021", "address"=>{"address_line"=>["153 Franklin Street"], "city"=>"New York", "state"=>"NY", "postal_code"=>"10013", "country"=>"US"}, "bank_address"=>{"address_line"=>["420 Montgomery Street"], "city"=>"San Francisco", "state"=>"CA", "postal_code"=>"94163", "country"=>"US"}}, "payer"=>{"payer_name"=>"Radar Robotics", "address"=>{"address_line"=>["32 6th Avenue"], "city"=>"New York", "state"=>"NY", "postal_code"=>"10013", "country"=>"US"}, "bank_address"=>{"address_line"=>["300 5th Avenue"], "city"=>"Pittsburgh", "state"=>"PA", "postal_code"=>"15222", "country"=>"US"}}, "amount"=>2439.45, "currency"=>"USD", "credit_debit"=>"credit", "payment_memo"=>{"memo"=>"AcT - 1/2"}, "addenda_reference"=>{"app_payment_id"=>"postman doc site collection - 1", "other_reference"=>"327620", "invoice_addenda"=>[{"invoice_id"=>"34239", "date"=>"{{payment_date}}", "amount"=>2439.45, "credit_debit"=>"credit"}]}}, {"date"=>"{{payment_date}}", "type"=>"pay_ach", "payee"=>{"payee_name"=>"Table Brews", "account_number"=>"031383900465", "routing_number"=>"021000021", "address"=>{"address_line"=>["153 Franklin Street"], "city"=>"New York", "state"=>"NY", "postal_code"=>"10013", "country"=>"US"}, "bank_address"=>{"address_line"=>["420 Montgomery Street"], "city"=>"San Francisco", "state"=>"CA", "postal_code"=>"94163", "country"=>"US"}}, "payer"=>{"payer_name"=>"Radar Robotics", "address"=>{"address_line"=>["32 6th Avenue"], "city"=>"New York", "state"=>"NY", "postal_code"=>"10013", "country"=>"US"}, "bank_address"=>{"address_line"=>["300 5th Avenue"], "city"=>"Pittsburgh", "state"=>"PA", "postal_code"=>"15222", "country"=>"US"}}, "amount"=>629.93, "currency"=>"USD", "credit_debit"=>"credit", "payment_memo"=>{"memo"=>"AcT - 2/2"}, "addenda_reference"=>{"app_payment_id"=>"postman doc site collection - 2", "other_reference"=>"327621", "invoice_addenda"=>[{"invoice_id"=>"34239", "date"=>"{{payment_date}}", "amount"=>629.93, "credit_debit"=>"credit"}]}}]}

HEADERS

Key	Datatype	Required	Description
`Request-Id`	string
`Content-Type`	string

RESPONSES

status: OK

{&quot;request_id&quot;:&quot;64f87151-b7a5-495a-ab99-ea186d9057dd&quot;,&quot;payments&quot;:[{&quot;account_id&quot;:&quot;acc_cl7jb54yw000j01o42la21oe7&quot;,&quot;payment_id&quot;:&quot;pay_cl7kwupln007e01nz245d3f86&quot;,&quot;pay_friendly&quot;:&quot;PAYGZYM673I1S8O&quot;,&quot;status&quot;:&quot;pay_approved&quot;,&quot;message&quot;:&quot;Payment approved, processing pending.&quot;,&quot;details&quot;:{&quot;date&quot;:&quot;2022-09-03T00:00:00.000Z&quot;,&quot;type&quot;:&quot;pay_ach&quot;,&quot;payee&quot;:{&quot;payee_name&quot;:&quot;Winter Drafts&quot;,&quot;account_number&quot;:&quot;841465469866&quot;,&quot;routing_number&quot;:&quot;021000021&quot;},&quot;payer&quot;:{&quot;payer_name&quot;:&quot;Radar Robotics&quot;},&quot;amount&quot;:2439.45,&quot;currency&quot;:&quot;USD&quot;,&quot;credit_debit&quot;:&quot;credit&quot;,&quot;payment_memo&quot;:{&quot;memo&quot;:&quot;AcT - 1/2&quot;},&quot;app_reference&quot;:{&quot;app_payment_id&quot;:&quot;postman doc site collection - 1&quot;,&quot;other_reference&quot;:&quot;327620&quot;}},&quot;_links&quot;:{&quot;self&quot;:{&quot;href&quot;:&quot;/payments/pay_cl7kwupln007e01nz245d3f86&quot;},&quot;approvals&quot;:{&quot;href&quot;:&quot;/payments/pay_cl7kwupln007e01nz245d3f86/approvals&quot;}}},{&quot;account_id&quot;:&quot;acc_cl7jb54yw000j01o42la21oe7&quot;,&quot;payment_id&quot;:&quot;pay_cl7kwupln007f01nz8uch95cw&quot;,&quot;pay_friendly&quot;:&quot;PAYV4NZH91SFVKN&quot;,&quot;status&quot;:&quot;pay_approved&quot;,&quot;message&quot;:&quot;Payment approved, processing pending.&quot;,&quot;details&quot;:{&quot;date&quot;:&quot;2022-09-03T00:00:00.000Z&quot;,&quot;type&quot;:&quot;pay_ach&quot;,&quot;payee&quot;:{&quot;payee_name&quot;:&quot;Table Brews&quot;,&quot;account_number&quot;:&quot;031383900465&quot;,&quot;routing_number&quot;:&quot;021000021&quot;},&quot;payer&quot;:{&quot;payer_name&quot;:&quot;Radar Robotics&quot;},&quot;amount&quot;:629.93,&quot;currency&quot;:&quot;USD&quot;,&quot;credit_debit&quot;:&quot;credit&quot;,&quot;payment_memo&quot;:{&quot;memo&quot;:&quot;AcT - 2/2&quot;},&quot;app_reference&quot;:{&quot;app_payment_id&quot;:&quot;postman doc site collection - 2&quot;,&quot;other_reference&quot;:&quot;327621&quot;}},&quot;_links&quot;:{&quot;self&quot;:{&quot;href&quot;:&quot;/payments/pay_cl7kwupln007f01nz8uch95cw&quot;},&quot;approvals&quot;:{&quot;href&quot;:&quot;/payments/pay_cl7kwupln007f01nz8uch95cw/approvals&quot;}}}]}