ACH payment origination and management API for the Customers Bank embedded-banking platform. OpenAPI 3.0.1, OAuth2 client-credentials.
{"openapi":"3.0.1","info":{"title":"ACH","version":"v1"},"servers":[{"url":"https://cubi-sandbox-api.customersbank.com/ach/v1"}],"paths":{"/programs/{id}":{"get":{"tags":["PartnerProgram"],"summary":"/programs/{id} - GET","description":"Gets a partner program","operationId":"get-programs-id","parameters":[{"name":"id","in":"path","description":"The ID of the partner program to get","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.PartnerProgramDto"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.PartnerProgramDto"},"example":{"id":"string","partnerId":"string","achCompanyId":"string","secCode":"PPD","batchHeader":"string","writeUnbalancedFiles":true,"writeBatchPerTransaction":true}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.PartnerProgramDto"},"example":{"id":"string","partnerId":"string","achCompanyId":"string","secCode":"PPD","batchHeader":"string","writeUnbalancedFiles":true,"writeBatchPerTransaction":true}}}},"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"}}}}}}},"/programs":{"get":{"tags":["PartnerProgram"],"summary":"/programs - GET","description":"Searches the available partner programs","operationId":"get-programs","parameters":[{"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.Ach.WebApi.Dto.PartnerProgramDto"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.Ach.WebApi.Dto.PartnerProgramDto"},"example":{"pageSize":0,"pageOffset":0,"totalPages":0,"totalItemCount":0,"items":[{"id":"string","partnerId":"string","achCompanyId":"string","secCode":"PPD","batchHeader":"string","writeUnbalancedFiles":true,"writeBatchPerTransaction":true}]}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.Ach.WebApi.Dto.PartnerProgramDto"},"example":{"pageSize":0,"pageOffset":0,"totalPages":0,"totalItemCount":0,"items":[{"id":"string","partnerId":"string","achCompanyId":"string","secCode":"PPD","batchHeader":"string","writeUnbalancedFiles":true,"writeBatchPerTransaction":true}]}}}},"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"}}}}}}},"/programs/download":{"get":{"tags":["PartnerProgram"],"summary":"/programs/download - GET","description":"Downloads all partner programs","operationId":"get-programs-download","parameters":[{"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":{"type":"array","items":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.PartnerProgramDto"}},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.PartnerProgramDto"}},"example":[{"id":"string","partnerId":"string","achCompanyId":"string","secCode":"PPD","batchHeader":"string","writeUnbalancedFiles":true,"writeBatchPerTransaction":true}]},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.PartnerProgramDto"}},"example":[{"id":"string","partnerId":"string","achCompanyId":"string","secCode":"PPD","batchHeader":"string","writeUnbalancedFiles":true,"writeBatchPerTransaction":true}]}}},"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/{id}":{"get":{"tags":["OutgoingAch"],"summary":"/outgoing/{id} - GET","description":"Gets a sent ACH transaction","operationId":"get-outgoing-id","parameters":[{"name":"id","in":"path","description":"The id of the ach transaction to GET","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.AchTransactionDto"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.AchTransactionDto"},"example":{"id":"string","referenceDescription":"string","status":"Initiated","creditName":"string","creditAccountNumber":"string","creditRoutingNumber":"string","debitAccountNumber":"string","debitRoutingNumber":"string","debitAccountType":"Checking","debitName":"string","amount":0,"creditAccountType":"Checking","createdAt":"string","completedAt":"string","processDate":"string","direction":"Credit","lineItemReferenceId":"string","debitTraceNumber":"string","creditTraceNumber":"string","reversalId":"string","reversedAt":"string","reversedReason":"DuplicateEntry","reversedDescription":"string","programId":"string","cancelledAt":"string","cancelledReasons":["string"],"returnId":"string","returnedAt":"string","returnCode":"string","batchDescription":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.AchTransactionDto"},"example":{"id":"string","referenceDescription":"string","status":"Initiated","creditName":"string","creditAccountNumber":"string","creditRoutingNumber":"string","debitAccountNumber":"string","debitRoutingNumber":"string","debitAccountType":"Checking","debitName":"string","amount":0,"creditAccountType":"Checking","createdAt":"string","completedAt":"string","processDate":"string","direction":"Credit","lineItemReferenceId":"string","debitTraceNumber":"string","creditTraceNumber":"string","reversalId":"string","reversedAt":"string","reversedReason":"DuplicateEntry","reversedDescription":"string","programId":"string","cancelledAt":"string","cancelledReasons":["string"],"returnId":"string","returnedAt":"string","returnCode":"string","batchDescription":"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":{"get":{"tags":["OutgoingAch"],"summary":"/outgoing - GET","description":"Searches all sent ACH transactions","operationId":"get-outgoing","parameters":[{"name":"FromDate","in":"query","description":"The date from which to search for originated payments","schema":{"type":"string","format":"date-time"}},{"name":"ToDate","in":"query","description":"The date to search until for originated payments","schema":{"type":"string","format":"date-time"}},{"name":"AccountId","in":"query","description":"The ID of the account for which the payments were originated","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.Ach.WebApi.Dto.AchTransactionDto"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.Ach.WebApi.Dto.AchTransactionDto"},"example":{"pageSize":0,"pageOffset":0,"totalPages":0,"totalItemCount":0,"items":[{"id":"string","referenceDescription":"string","status":"Initiated","creditName":"string","creditAccountNumber":"string","creditRoutingNumber":"string","debitAccountNumber":"string","debitRoutingNumber":"string","debitAccountType":"Checking","debitName":"string","amount":0,"creditAccountType":"Checking","createdAt":"string","completedAt":"string","processDate":"string","direction":"Credit","lineItemReferenceId":"string","debitTraceNumber":"string","creditTraceNumber":"string","reversalId":"string","reversedAt":"string","reversedReason":"DuplicateEntry","reversedDescription":"string","programId":"string","cancelledAt":"string","cancelledReasons":["string"],"returnId":"string","returnedAt":"string","returnCode":"string","batchDescription":"string"}]}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.Abstractions.Paginated_Cubi.Ach.WebApi.Dto.AchTransactionDto"},"example":{"pageSize":0,"pageOffset":0,"totalPages":0,"totalItemCount":0,"items":[{"id":"string","referenceDescription":"string","status":"Initiated","creditName":"string","creditAccountNumber":"string","creditRoutingNumber":"string","debitAccountNumber":"string","debitRoutingNumber":"string","debitAccountType":"Checking","debitName":"string","amount":0,"creditAccountType":"Checking","createdAt":"string","completedAt":"string","processDate":"string","direction":"Credit","lineItemReferenceId":"string","debitTraceNumber":"string","creditTraceNumber":"string","reversalId":"string","reversedAt":"string","reversedReason":"DuplicateEntry","reversedDescription":"string","programId":"string","cancelledAt":"string","cancelledReasons":["string"],"returnId":"string","returnedAt":"string","returnCode":"string","batchDescription":"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/download":{"get":{"tags":["OutgoingAch"],"summary":"/outgoing/download - GET","description":"Downloads all sent ACH transactions","operationId":"get-outgoing-download","parameters":[{"name":"FromDate","in":"query","description":"The date from which to search for originated payments","schema":{"type":"string","format":"date-time"}},{"name":"ToDate","in":"query","description":"The date to search until for originated payments","schema":{"type":"string","format":"date-time"}},{"name":"AccountId","in":"query","description":"The ID of the account for which the payments were originated","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":{"type":"array","items":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.AchTransactionDto"}},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.AchTransactionDto"}},"example":[{"id":"string","referenceDescription":"string","status":"Initiated","creditName":"string","creditAccountNumber":"string","creditRoutingNumber":"string","debitAccountNumber":"string","debitRoutingNumber":"string","debitAccountType":"Checking","debitName":"string","amount":0,"creditAccountType":"Checking","createdAt":"string","completedAt":"string","processDate":"string","direction":"Credit","lineItemReferenceId":"string","debitTraceNumber":"string","creditTraceNumber":"string","reversalId":"string","reversedAt":"string","reversedReason":"DuplicateEntry","reversedDescription":"string","programId":"string","cancelledAt":"string","cancelledReasons":["string"],"returnId":"string","returnedAt":"string","returnCode":"string","batchDescription":"string"}]},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.AchTransactionDto"}},"example":[{"id":"string","referenceDescription":"string","status":"Initiated","creditName":"string","creditAccountNumber":"string","creditRoutingNumber":"string","debitAccountNumber":"string","debitRoutingNumber":"string","debitAccountType":"Checking","debitName":"string","amount":0,"creditAccountType":"Checking","createdAt":"string","completedAt":"string","processDate":"string","direction":"Credit","lineItemReferenceId":"string","debitTraceNumber":"string","creditTraceNumber":"string","reversalId":"string","reversedAt":"string","reversedReason":"DuplicateEntry","reversedDescription":"string","programId":"string","cancelledAt":"string","cancelledReasons":["string"],"returnId":"string","returnedAt":"string","returnCode":"string","batchDescription":"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/credit":{"post":{"tags":["OutgoingAch"],"summary":"/outgoing/credit - POST","description":"Initiates an outgoing ACH credit transaction","operationId":"post-outgoing-credit","parameters":[{"name":"x-idempotency-key","in":"header","description":"Unique request idenitfier for idempotency.","required":true,"schema":{"type":"string","format":"uuid"},"example":"b6541a7e-4073-4870-bc13-05912c5416f4"}],"requestBody":{"description":"The outgoing ACH transaction to send","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.InitiateAchCreditDto"},"example":{"creditName":"string","creditAccountNumber":"string","creditRoutingNumber":"string","creditAccountType":"Checking","debitAccountNumber":"string","amount":0,"processDate":"string","programId":"string","description":"string","batchDescription":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.InitiateAchCreditDto"},"example":{"creditName":"string","creditAccountNumber":"string","creditRoutingNumber":"string","creditAccountType":"Checking","debitAccountNumber":"string","amount":0,"processDate":"string","programId":"string","description":"string","batchDescription":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.InitiateAchCreditDto"},"example":{"creditName":"string","creditAccountNumber":"string","creditRoutingNumber":"string","creditAccountType":"Checking","debitAccountNumber":"string","amount":0,"processDate":"string","programId":"string","description":"string","batchDescription":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Cubi.Common.WebApi.Mediatr.Validation.IdentifierContainer_System.Guid"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.WebApi.Mediatr.Validation.IdentifierContainer_System.Guid"},"example":{"id":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.WebApi.Mediatr.Validation.IdentifierContainer_System.Guid"},"example":{"id":"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"}}}},"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/debit":{"post":{"tags":["OutgoingAch"],"summary":"/outgoing/debit - POST","description":"Initiates an outgoing ACH debit transaction","operationId":"post-outgoing-debit","parameters":[{"name":"x-idempotency-key","in":"header","description":"Unique request idenitfier for idempotency.","required":true,"schema":{"type":"string","format":"uuid"},"example":"0d5052f5-1e9e-4f86-a8a9-f6cc31f05222"}],"requestBody":{"description":"The outgoing ACH transaction to send","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.InitiateAchDebitDto"},"example":{"debitName":"string","debitAccountNumber":"string","debitRoutingNumber":"string","debitAccountType":"Checking","creditAccountNumber":"string","amount":0,"processDate":"string","programId":"string","description":"string","batchDescription":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.InitiateAchDebitDto"},"example":{"debitName":"string","debitAccountNumber":"string","debitRoutingNumber":"string","debitAccountType":"Checking","creditAccountNumber":"string","amount":0,"processDate":"string","programId":"string","description":"string","batchDescription":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.InitiateAchDebitDto"},"example":{"debitName":"string","debitAccountNumber":"string","debitRoutingNumber":"string","debitAccountType":"Checking","creditAccountNumber":"string","amount":0,"processDate":"string","programId":"string","description":"string","batchDescription":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Cubi.Common.WebApi.Mediatr.Validation.IdentifierContainer_System.Guid"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.WebApi.Mediatr.Validation.IdentifierContainer_System.Guid"},"example":{"id":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.WebApi.Mediatr.Validation.IdentifierContainer_System.Guid"},"example":{"id":"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"}}}},"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/{id}/reverse":{"post":{"tags":["OutgoingAch"],"summary":"/outgoing/{id}/reverse - POST","description":"Attempts to reverse a previously sent ACH transaction (either debit or credit).\r\nMay only be used on transactions in a completed status","operationId":"post-outgoing-id-reverse","parameters":[{"name":"id","in":"path","description":"The ID of the ACH transaction for which to attempt reversal","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"x-idempotency-key","in":"header","description":"Unique request idenitfier for idempotency.","required":true,"schema":{"type":"string","format":"uuid"},"example":"b49e24e1-1ccd-4b8a-8f25-6c04feb491b0"}],"requestBody":{"description":"Reversal reason and details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.RequestAchReversalDto"},"example":{"reason":"string","description":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.RequestAchReversalDto"},"example":{"reason":"string","description":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Cubi.Ach.WebApi.Dto.RequestAchReversalDto"},"example":{"reason":"string","description":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Cubi.Common.WebApi.Mediatr.Validation.IdentifierContainer_System.Guid"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.WebApi.Mediatr.Validation.IdentifierContainer_System.Guid"},"example":{"id":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/Cubi.Common.WebApi.Mediatr.Validation.IdentifierContainer_System.Guid"},"example":{"id":"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"}}}},
# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/customers-bank/refs/heads/main/openapi/customers-bank-ach-openapi.json