Instant Payments API for real-time payment origination and management on the Customers Bank platform. OpenAPI 3.0.1, OAuth2 client-credentials.
{"openapi":"3.0.1","info":{"title":"InstantPayments","version":"v1"},"servers":[{"url":"https://cubi-sandbox-api.customersbank.com/InstantPayments/v1"}],"paths":{"/incoming/{id}":{"get":{"tags":["IncomingPayments"],"summary":"/incoming/{id} - GET","description":"Retrieves an existing incoming instant payment","operationId":"get-incoming-id","parameters":[{"name":"id","in":"path","description":"The ID of the FEDNOW payment to get","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingPaymentDto"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingPaymentDto"},"example":{"id":"string","amount":0,"accountNumber":"string","description":"string","referenceId":"string","isMemoPosted":true,"createdAt":"string","status":"Initiated","paymentDate":"string","deliveryDate":"string","notes":"string","senderName":"string","senderAccountNumber":"string","senderRoutingNumber":"string","senderAddress1":"string","senderAddress2":"string","senderCity":"string","senderState":"string","senderZip":"string","senderCountry":"string","senderBankName":"string","senderBankAddress1":"string","senderBankAddress2":"string","senderBankCity":"string","senderBankState":"string","senderBankZip":"string","confirmationNumber":"string","rail":"FedNow"}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingPaymentDto"},"example":{"id":"string","amount":0,"accountNumber":"string","description":"string","referenceId":"string","isMemoPosted":true,"createdAt":"string","status":"Initiated","paymentDate":"string","deliveryDate":"string","notes":"string","senderName":"string","senderAccountNumber":"string","senderRoutingNumber":"string","senderAddress1":"string","senderAddress2":"string","senderCity":"string","senderState":"string","senderZip":"string","senderCountry":"string","senderBankName":"string","senderBankAddress1":"string","senderBankAddress2":"string","senderBankCity":"string","senderBankState":"string","senderBankZip":"string","confirmationNumber":"string","rail":"FedNow"}}}},"400":{"description":"BadRequest","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.1","title":"One or more validation errors occurred.","status":400,"traceId":"string"}}}},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.2","title":"Unauthorized","status":401,"traceId":"string"}}}},"403":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.4","title":"Forbidden","status":403,"traceId":"string"}}}},"404":{"description":"NotFound","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.5","title":"Not Found","status":404,"traceId":"string"}}}},"422":{"description":"UnprocessableEntity","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc4918#section-11.2","title":"Unprocessable Entity","status":422,"traceId":"string"}}}},"500":{"description":"InternalServerError","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.6.1","title":"An error occurred while processing your request.","status":500,"traceId":"string"}}}}}}},"/incoming/fednow/{id}":{"get":{"tags":["IncomingPayments"],"summary":"/incoming/fednow/{id} - GET","description":"Retrieves an existing incoming FEDNOW payment","operationId":"get-incoming-fednow-id","parameters":[{"name":"id","in":"path","description":"The ID of the FEDNOW payment to get","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingFedNowDto"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingFedNowDto"},"example":{"id":"string","amount":0,"accountNumber":"string","description":"string","referenceId":"string","isMemoPosted":true,"createdAt":"string","status":"Initiated","paymentDate":"string","deliveryDate":"string","notes":"string","senderName":"string","senderAccountNumber":"string","senderRoutingNumber":"string","senderAddress1":"string","senderAddress2":"string","senderCity":"string","senderState":"string","senderZip":"string","senderCountry":"string","senderBankName":"string","senderBankAddress1":"string","senderBankAddress2":"string","senderBankCity":"string","senderBankState":"string","senderBankZip":"string","confirmationNumber":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingFedNowDto"},"example":{"id":"string","amount":0,"accountNumber":"string","description":"string","referenceId":"string","isMemoPosted":true,"createdAt":"string","status":"Initiated","paymentDate":"string","deliveryDate":"string","notes":"string","senderName":"string","senderAccountNumber":"string","senderRoutingNumber":"string","senderAddress1":"string","senderAddress2":"string","senderCity":"string","senderState":"string","senderZip":"string","senderCountry":"string","senderBankName":"string","senderBankAddress1":"string","senderBankAddress2":"string","senderBankCity":"string","senderBankState":"string","senderBankZip":"string","confirmationNumber":"string"}}}},"400":{"description":"BadRequest","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.1","title":"One or more validation errors occurred.","status":400,"traceId":"string"}}}},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.2","title":"Unauthorized","status":401,"traceId":"string"}}}},"403":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.4","title":"Forbidden","status":403,"traceId":"string"}}}},"404":{"description":"NotFound","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.5","title":"Not Found","status":404,"traceId":"string"}}}},"422":{"description":"UnprocessableEntity","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc4918#section-11.2","title":"Unprocessable Entity","status":422,"traceId":"string"}}}},"500":{"description":"InternalServerError","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.6.1","title":"An error occurred while processing your request.","status":500,"traceId":"string"}}}}}}},"/incoming/rtp/{id}":{"get":{"tags":["IncomingPayments"],"summary":"/incoming/rtp/{id} - GET","description":"Retrieves an existing incoming RTP","operationId":"get-incoming-rtp-id","parameters":[{"name":"id","in":"path","description":"The ID of the RTP to get","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingRtpDto"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingRtpDto"},"example":{"id":"string","amount":0,"accountNumber":"string","description":"string","referenceId":"string","isMemoPosted":true,"createdAt":"string","status":"Initiated","paymentDate":"string","deliveryDate":"string","notes":"string","senderName":"string","senderAccountNumber":"string","senderRoutingNumber":"string","senderAddress1":"string","senderAddress2":"string","senderCity":"string","senderState":"string","senderZip":"string","senderCountry":"string","senderBankName":"string","senderBankAddress1":"string","senderBankAddress2":"string","senderBankCity":"string","senderBankState":"string","senderBankZip":"string","confirmationNumber":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingRtpDto"},"example":{"id":"string","amount":0,"accountNumber":"string","description":"string","referenceId":"string","isMemoPosted":true,"createdAt":"string","status":"Initiated","paymentDate":"string","deliveryDate":"string","notes":"string","senderName":"string","senderAccountNumber":"string","senderRoutingNumber":"string","senderAddress1":"string","senderAddress2":"string","senderCity":"string","senderState":"string","senderZip":"string","senderCountry":"string","senderBankName":"string","senderBankAddress1":"string","senderBankAddress2":"string","senderBankCity":"string","senderBankState":"string","senderBankZip":"string","confirmationNumber":"string"}}}},"400":{"description":"BadRequest","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.1","title":"One or more validation errors occurred.","status":400,"traceId":"string"}}}},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.2","title":"Unauthorized","status":401,"traceId":"string"}}}},"403":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.4","title":"Forbidden","status":403,"traceId":"string"}}}},"404":{"description":"NotFound","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.5","title":"Not Found","status":404,"traceId":"string"}}}},"422":{"description":"UnprocessableEntity","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc4918#section-11.2","title":"Unprocessable Entity","status":422,"traceId":"string"}}}},"500":{"description":"InternalServerError","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.6.1","title":"An error occurred while processing your request.","status":500,"traceId":"string"}}}}}}},"/incoming":{"get":{"tags":["IncomingPayments"],"summary":"/incoming - GET","description":"Searches for incoming instant payments","operationId":"get-incoming","parameters":[{"name":"fromDate","in":"query","description":"The start date from which to search","schema":{"type":"string","format":"date-time"}},{"name":"toDate","in":"query","description":"The end date for which to search","schema":{"type":"string","format":"date-time"}},{"name":"accountId","in":"query","description":"The account ID for which to search","schema":{"type":"string","format":"uuid"}},{"name":"paginateResults","in":"query","schema":{"type":"boolean"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"perPage","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortOn","in":"query","schema":{"type":"string"}},{"name":"sortAscending","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingPaymentDto"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingPaymentDto"},"example":{"pageSize":0,"pageOffset":0,"totalPages":0,"totalItemCount":0,"items":[{"id":"string","amount":0,"accountNumber":"string","description":"string","referenceId":"string","isMemoPosted":true,"createdAt":"string","status":"Initiated","paymentDate":"string","deliveryDate":"string","notes":"string","senderName":"string","senderAccountNumber":"string","senderRoutingNumber":"string","senderAddress1":"string","senderAddress2":"string","senderCity":"string","senderState":"string","senderZip":"string","senderCountry":"string","senderBankName":"string","senderBankAddress1":"string","senderBankAddress2":"string","senderBankCity":"string","senderBankState":"string","senderBankZip":"string","confirmationNumber":"string","rail":"FedNow"}]}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingPaymentDto"},"example":{"pageSize":0,"pageOffset":0,"totalPages":0,"totalItemCount":0,"items":[{"id":"string","amount":0,"accountNumber":"string","description":"string","referenceId":"string","isMemoPosted":true,"createdAt":"string","status":"Initiated","paymentDate":"string","deliveryDate":"string","notes":"string","senderName":"string","senderAccountNumber":"string","senderRoutingNumber":"string","senderAddress1":"string","senderAddress2":"string","senderCity":"string","senderState":"string","senderZip":"string","senderCountry":"string","senderBankName":"string","senderBankAddress1":"string","senderBankAddress2":"string","senderBankCity":"string","senderBankState":"string","senderBankZip":"string","confirmationNumber":"string","rail":"FedNow"}]}}}},"400":{"description":"BadRequest","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.1","title":"One or more validation errors occurred.","status":400,"traceId":"string"}}}},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.2","title":"Unauthorized","status":401,"traceId":"string"}}}},"403":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.4","title":"Forbidden","status":403,"traceId":"string"}}}},"404":{"description":"NotFound","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.5","title":"Not Found","status":404,"traceId":"string"}}}},"422":{"description":"UnprocessableEntity","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc4918#section-11.2","title":"Unprocessable Entity","status":422,"traceId":"string"}}}},"500":{"description":"InternalServerError","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.6.1","title":"An error occurred while processing your request.","status":500,"traceId":"string"}}}}}}},"/incoming/rtp":{"get":{"tags":["IncomingPayments"],"summary":"/incoming/rtp - GET","description":"Searches for incoming RTPs","operationId":"get-incoming-rtp","parameters":[{"name":"fromDate","in":"query","description":"The start date from which to search","schema":{"type":"string","format":"date-time"}},{"name":"toDate","in":"query","description":"The end date for which to search","schema":{"type":"string","format":"date-time"}},{"name":"accountId","in":"query","description":"The account ID for which to search","schema":{"type":"string","format":"uuid"}},{"name":"paginateResults","in":"query","schema":{"type":"boolean"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"perPage","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortOn","in":"query","schema":{"type":"string"}},{"name":"sortAscending","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingRtpDto"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingRtpDto"},"example":{"pageSize":0,"pageOffset":0,"totalPages":0,"totalItemCount":0,"items":[{"id":"string","amount":0,"accountNumber":"string","description":"string","referenceId":"string","isMemoPosted":true,"createdAt":"string","status":"Initiated","paymentDate":"string","deliveryDate":"string","notes":"string","senderName":"string","senderAccountNumber":"string","senderRoutingNumber":"string","senderAddress1":"string","senderAddress2":"string","senderCity":"string","senderState":"string","senderZip":"string","senderCountry":"string","senderBankName":"string","senderBankAddress1":"string","senderBankAddress2":"string","senderBankCity":"string","senderBankState":"string","senderBankZip":"string","confirmationNumber":"string"}]}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingRtpDto"},"example":{"pageSize":0,"pageOffset":0,"totalPages":0,"totalItemCount":0,"items":[{"id":"string","amount":0,"accountNumber":"string","description":"string","referenceId":"string","isMemoPosted":true,"createdAt":"string","status":"Initiated","paymentDate":"string","deliveryDate":"string","notes":"string","senderName":"string","senderAccountNumber":"string","senderRoutingNumber":"string","senderAddress1":"string","senderAddress2":"string","senderCity":"string","senderState":"string","senderZip":"string","senderCountry":"string","senderBankName":"string","senderBankAddress1":"string","senderBankAddress2":"string","senderBankCity":"string","senderBankState":"string","senderBankZip":"string","confirmationNumber":"string"}]}}}},"400":{"description":"BadRequest","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.1","title":"One or more validation errors occurred.","status":400,"traceId":"string"}}}},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.2","title":"Unauthorized","status":401,"traceId":"string"}}}},"403":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.4","title":"Forbidden","status":403,"traceId":"string"}}}},"404":{"description":"NotFound","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.5","title":"Not Found","status":404,"traceId":"string"}}}},"422":{"description":"UnprocessableEntity","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc4918#section-11.2","title":"Unprocessable Entity","status":422,"traceId":"string"}}}},"500":{"description":"InternalServerError","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.6.1","title":"An error occurred while processing your request.","status":500,"traceId":"string"}}}}}}},"/incoming/fednow":{"get":{"tags":["IncomingPayments"],"summary":"/incoming/fednow - GET","description":"Searches for incoming FedNow payments","operationId":"get-incoming-fednow","parameters":[{"name":"fromDate","in":"query","description":"The start date from which to search","schema":{"type":"string","format":"date-time"}},{"name":"toDate","in":"query","description":"The end date for which to search","schema":{"type":"string","format":"date-time"}},{"name":"accountId","in":"query","description":"The account ID for which to search","schema":{"type":"string","format":"uuid"}},{"name":"paginateResults","in":"query","schema":{"type":"boolean"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"perPage","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortOn","in":"query","schema":{"type":"string"}},{"name":"sortAscending","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingFedNowDto"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingFedNowDto"},"example":{"pageSize":0,"pageOffset":0,"totalPages":0,"totalItemCount":0,"items":[{"id":"string","amount":0,"accountNumber":"string","description":"string","referenceId":"string","isMemoPosted":true,"createdAt":"string","status":"Initiated","paymentDate":"string","deliveryDate":"string","notes":"string","senderName":"string","senderAccountNumber":"string","senderRoutingNumber":"string","senderAddress1":"string","senderAddress2":"string","senderCity":"string","senderState":"string","senderZip":"string","senderCountry":"string","senderBankName":"string","senderBankAddress1":"string","senderBankAddress2":"string","senderBankCity":"string","senderBankState":"string","senderBankZip":"string","confirmationNumber":"string"}]}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.InstantPayments.WebApi.Dto.Incoming.IncomingFedNowDto"},"example":{"pageSize":0,"pageOffset":0,"totalPages":0,"totalItemCount":0,"items":[{"id":"string","amount":0,"accountNumber":"string","description":"string","referenceId":"string","isMemoPosted":true,"createdAt":"string","status":"Initiated","paymentDate":"string","deliveryDate":"string","notes":"string","senderName":"string","senderAccountNumber":"string","senderRoutingNumber":"string","senderAddress1":"string","senderAddress2":"string","senderCity":"string","senderState":"string","senderZip":"string","senderCountry":"string","senderBankName":"string","senderBankAddress1":"string","senderBankAddress2":"string","senderBankCity":"string","senderBankState":"string","senderBankZip":"string","confirmationNumber":"string"}]}}}},"400":{"description":"BadRequest","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.1","title":"One or more validation errors occurred.","status":400,"traceId":"string"}}}},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.2","title":"Unauthorized","status":401,"traceId":"string"}}}},"403":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.4","title":"Forbidden","status":403,"traceId":"string"}}}},"404":{"description":"NotFound","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.5","title":"Not Found","status":404,"traceId":"string"}}}},"422":{"description":"UnprocessableEntity","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc4918#section-11.2","title":"Unprocessable Entity","status":422,"traceId":"string"}}}},"500":{"description":"InternalServerError","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.6.1","title":"An error occurred while processing your request.","status":500,"traceId":"string"}}}}}}},"/outgoing":{"post":{"tags":["OutgoingPayments"],"summary":"/outgoing - POST","description":"Initiates a new instant payment that will be delivered on either the FedNow or RTP rails. The rail will be determined \r\nbased on the receiver bank's rail eligibilty among other factors.","operationId":"post-outgoing","parameters":[{"name":"x-idempotency-key","in":"header","description":"Unique request idenitfier for idempotency.","required":true,"schema":{"type":"string","format":"uuid"},"example":"05c6f225-d90e-4449-a280-b3ae9924fdec"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Outgoing.Initiate.InitiatePaymentDto"},"example":{"amount":0,"processDate":"2025-04-02T05:00:00+00:00","senderAccountNumber":"string","receiverRoutingNumber":"string","receiverAccountNumber":"string","receiverName":"string","receiverAddress1":"string","receiverAddress2":"string","receiverCity":"string","receiverState":"string","receiverZip":"string","receiverCountry":"US","description":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Outgoing.Initiate.InitiatePaymentDto"},"example":{"amount":0,"processDate":"2025-04-02T05:00:00+00:00","senderAccountNumber":"string","receiverRoutingNumber":"string","receiverAccountNumber":"string","receiverName":"string","receiverAddress1":"string","receiverAddress2":"string","receiverCity":"string","receiverState":"string","receiverZip":"string","receiverCountry":"US","description":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Outgoing.Initiate.InitiatePaymentDto"},"example":{"amount":0,"processDate":"2025-04-02T05:00:00+00:00","senderAccountNumber":"string","receiverRoutingNumber":"string","receiverAccountNumber":"string","receiverName":"string","receiverAddress1":"string","receiverAddress2":"string","receiverCity":"string","receiverState":"string","receiverZip":"string","receiverCountry":"US","description":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Outgoing.Initiate.PaymentInitiatedDto"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Outgoing.Initiate.PaymentInitiatedDto"},"example":{"id":"string","rail":"FedNow"}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Outgoing.Initiate.PaymentInitiatedDto"},"example":{"id":"string","rail":"FedNow"}}}},"400":{"description":"BadRequest","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.1","title":"One or more validation errors occurred.","status":400,"traceId":"string"}}}},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.2","title":"Unauthorized","status":401,"traceId":"string"}}}},"403":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.4","title":"Forbidden","status":403,"traceId":"string"}}}},"404":{"description":"NotFound","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.5","title":"Not Found","status":404,"traceId":"string"}}}},"500":{"description":"InternalServerError","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"},"example":{"type":"https://tools.ietf.org/html/rfc9110#section-15.6.1","title":"An error occurred while processing your request.","status":500,"traceId":"string"}}}}}},"get":{"tags":["OutgoingPayments"],"summary":"/outgoing - GET","description":"Searches for outgoing Instant Payments","operationId":"get-outgoing","parameters":[{"name":"fromDate","in":"query","description":"The start date from which to search","schema":{"type":"string","format":"date-time"}},{"name":"toDate","in":"query","description":"The end date for which to search","schema":{"type":"string","format":"date-time"}},{"name":"status","in":"query","description":"The status to search","schema":{"$ref":"#/components/schemas/Cubi.InstantPayments.WebApi.Dto.Outgoing.OutgoingTransactionStatusDto"}},{"name":"accountId","in":"query","description":"The account ID for which to search","schema":{"type":"string","format":"uuid"}},{"name":"paginateResults","in":"query","schema":{"type":"boolean"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"perPage","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortOn","in":"query","schema":{"type":"string"}},{"name":"sortAscending","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.InstantPayments.WebApi.Dto.Outgoing.OutgoingPaymentDto"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.InstantPayments.WebApi.Dto.Outgoing.OutgoingPaymentDto"},"example":{"pageSize":0,"pageOffset":0,"totalPages":0,"totalItemCount":0,"items":[{"id":"string","amount":0,"processDate":"string","senderAccountNumber":"string","paymentDate":"string","deliveryDate":"string","receiverRoutingNumber":"string","receiverAccountNumber":"string","receiverName":"string","receiverAddress1":"string","receiverAddress2":"string","receiverCity":"string","receiverState":"string","receiverZip":"string","receiverCountry":"string","receiverBankName":"string","receiverBankAddress1":"string","receiverBankAddress2":"string","receiverBankCity":"string","receiverBankState":"string","receiverBankZip":"string","description":"string","status":"Initiated","submittedAt":"string","cancelledAt":"string","cancelledReason":"string","completedAt":"string","confirmationNumber":"string","rail":"FedNow"}]}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.InstantPayments.WebApi.Dto.Outgoing.OutgoingPaymentDto"},"example":{"pageSize":0,"pageOffset":0,"totalPages":0,"totalItemCount":0,"items":[{"id":"string","amount":0,"processDate":"string","senderAccountNumber":"string","paymentDa
# --- truncated at 32 KB (151 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/customers-bank/refs/heads/main/openapi/customers-bank-instantpayments-openapi.json