Book Transfers

openapi: 3.0.1 info: title: Victor REST API version: 2.0.0 servers: - url: https://api.stage.victorfi.com description: Victor Staging Environment - url: https://api.victorfi.com description: Victor Production Environment tags: - name: Book Transfers description: Transfers Controller paths: /v2/transfers/book: post: description: Creates a new book transfer. operationId: createBookTransfer parameters: - in: header name: Idempotency-Key schema: type: string example: 1145f601-b8b0-4de7-9210-4ccb74a68ef5 description: A client provided unique value used by the server to identify subsequent retries of the same request. maxLength: 128 required: false requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBookTransferRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TransactionReceipt' description: Request succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/ValidationErrors' description: Invalid transfer request. summary: Create Book Transfer tags: - Book Transfers /v2/transfers/book/external: post: description: Creates a new book external transfer. operationId: createBookExternalTransfer parameters: - in: header name: Idempotency-Key schema: type: string example: 1145f601-b8b0-4de7-9210-4ccb74a68ef5 description: A client provided unique value used by the server to identify subsequent retries of the same request. maxLength: 128 required: false requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBookExternalTransferRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TransactionReceiptBookExternal' description: Request succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/ValidationErrors' description: Invalid transfer request. summary: Create Book External Transfer tags: - Book Transfers components: schemas: ConfigurationProperty: properties: name: $ref: '#/components/schemas/ConfigurationPropertyName' origin: $ref: '#/components/schemas/Origin' value: type: object type: object ConfigurationPropertyName: properties: empty: type: boolean lastElementIndexed: type: boolean numberOfElements: format: int32 type: integer parent: $ref: '#/components/schemas/ConfigurationPropertyName' type: object CreateBookExternalTransferRequest: description: New book external transfer request. properties: amount: minLength: 0 pattern: \d+(\.\d{1,2})? type: string client_reference_id: maxLength: 128 minLength: 0 type: string description: maxLength: 100 minLength: 0 type: string counterparty_reference: maxLength: 16 minLength: 0 type: string direction: enum: - credit - debit type: string originating_account_number: maxLength: 20 minLength: 3 pattern: '[0-9]+' type: string required: - amount - counterparty_reference - direction - originating_account_number type: object CreateBookTransferRequest: description: New book transfer request. properties: amount: minLength: 0 pattern: \d+(\.\d{1,2})? type: string client_reference_id: maxLength: 128 minLength: 0 type: string description: maxLength: 100 minLength: 0 type: string destination_account_number: maxLength: 20 minLength: 3 pattern: '[0-9]+' type: string originating_account_number: maxLength: 20 minLength: 3 pattern: '[0-9]+' type: string type: enum: - internal - external type: string required: - amount - destination_account_number - originating_account_number - type type: object ObjectError: properties: arguments: items: type: object type: array code: type: string codes: items: type: string type: array defaultMessage: type: string objectName: type: string type: object Origin: properties: parent: $ref: '#/components/schemas/Origin' type: object TransactionReceipt: properties: amount: type: string client_reference_id: type: string created_at: format: int64 type: integer status: enum: - CANCELLED - DECLINED - FAILED - ONHOLD - PENDING - PENDING_APPROVAL - PROCESSING - SENT - SUCCESS type: string type: enum: - BOOK_INTERNAL - BOOK_EXTERNAL - ACH_TRANSFER - WIRE_TRANSFER - IAT_ACH_TRANSFER - RTP_SEND - RTP_REFUND - RTP_INBOUND type: string updated_at: format: int64 type: integer victor_transaction_id: type: string type: object TransactionReceiptBookExternal: properties: amount: type: string client_reference_id: type: string created_at: format: int64 type: integer status: enum: - CANCELLED - DECLINED - FAILED - ONHOLD - PENDING - PENDING_APPROVAL - PROCESSING - SENT - SUCCESS type: string type: enum: - BOOK_EXTERNAL type: string updated_at: format: int64 type: integer victor_transaction_id: type: string type: object ValidationErrors: properties: allErrors: items: $ref: '#/components/schemas/ObjectError' type: array boundProperties: items: $ref: '#/components/schemas/ConfigurationProperty' type: array uniqueItems: true name: $ref: '#/components/schemas/ConfigurationPropertyName' type: object

Please ignore this field