Admin Endpoints

openapi: 3.0.0 info: version: 1.0.0 title: Rapid Transfers servers: - url: 'https://{API_ENVIRONMENT}' variables: API_ENVIRONMENT: default: platform.banno-development.com enum: - banno.com - platform.banno-staging.com - platform.banno-development.com paths: /a/api/rapid-transfers/v1/institutions/{institutionId}/onboarding-invite: parameters: - $ref: '#/components/parameters/institutionId' post: summary: Create an invite link tags: - Invite Link responses: '200': description: Invite Link created content: application/json: schema: type: object properties: link: type: string '403': description: Missing needed abilities '500': description: Internal server error (something went wrong in the server side) get: summary: Get the status of an invite link request tags: - Invite Link responses: '200': description: Status of link request content: application/json: schema: type: object properties: link: type: string status: type: string '403': description: Missing needed abilities '500': description: Internal server error (something went wrong in the server side) /a/api/rapid-transfers/v1/institutions/{institutionId}/FIConfiguration: post: tags: - AddFIConfiguration description: Add or Update the FIConfiguration operationId: FIConfiguration parameters: - $ref: '#/components/parameters/institutionId' requestBody: content: application/json: schema: $ref: '#/components/schemas/FIConfiguration' responses: '204': description: No Content '403': description: Missing needed abilities '500': description: Internal server error (something went wrong in the server side) get: summary: Get the FIConfiguration tags: - FIConfiguration responses: '200': description: The FIConfiguration content: application/json: schema: $ref: '#/components/schemas/FIConfiguration' '403': description: Missing needed abilities '500': description: Internal server error (something went wrong in the server side) /a/api/rapid-transfers/v1/institutions/{institutionId}/transactionSettings: post: tags: - Transaction Settings description: Add or Update the Transaction Settings operationId: transactionSettings parameters: - $ref: '#/components/parameters/institutionId' requestBody: content: application/json: schema: $ref: '#/components/schemas/TransactionSettings' responses: '204': description: No Content '403': description: Missing needed abilities '500': description: Internal server error (something went wrong in the server side) get: summary: Get the Transaction Settings tags: - Transaction Settings responses: '200': description: The Transaction Settings content: application/json: schema: $ref: '#/components/schemas/TransactionSettings' '403': description: Missing needed abilities '500': description: Internal server error (something went wrong in the server side) delete: tags: - Transaction Settings summary: Delete the Transaction Settings parameters: - $ref: '#/components/parameters/institutionId' responses: '204': description: OK '404': description: NotFound '500': description: Internal server error. /a/api/rapid-transfers/v1/institutions/{institutionId}/sweeps: get: summary: Get list of sweeps tags: - Sweeps parameters: - $ref: '#/components/parameters/institutionId' responses: '200': description: The list of sweeps content: application/json: schema: $ref: '#/components/schemas/SweepsResponse' '403': description: Missing needed abilities '500': description: Internal server error (something went wrong in the server side) /a/api/rapid-transfers/v1/institutions/{institutionId}/sweeps/{sweepId}: get: summary: Sweep by Sweep Id tags: - Sweeps parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/sweepId' responses: '200': description: Transfers by Sweep Id content: application/json: schema: $ref: '#/components/schemas/Sweep' '403': description: Missing needed abilities '500': description: Internal server error (something went wrong in the server side) /a/api/rapid-transfers/v1/institutions/{institutionId}/sweeps/{sweepId}/transfers: get: summary: Transfers by Sweep Id tags: - Sweeps parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/sweepId' responses: '200': description: Transfers by Sweep Id content: application/json: schema: $ref: '#/components/schemas/TransfersBySweepIdResponse' '403': description: Missing needed abilities '500': description: Internal server error (something went wrong in the server side) /a/api/rapid-transfers/v1/institutions/{institutionId}/transfers/{transferId}/transactions/{transactionId}: get: summary: Transfer by TransferId tags: - Transfers parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/transactionId' responses: '200': description: Transfer by TransferId content: application/json: schema: $ref: '#/components/schemas/Transfer' '403': description: Missing needed abilities '500': description: Internal server error (something went wrong in the server side) /a/api/rapid-transfers/v1/institutions/{institutionId}/bin: post: summary: Create a BIN tags: - BIN Management description: Create a Bank Identification Number (BIN) for an institution parameters: - $ref: '#/components/parameters/institutionId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InstitutionBin' responses: '201': description: BIN created successfully '400': description: Invalid request body '403': description: Missing needed abilities '500': description: Internal server error (something went wrong in the server side) get: summary: List all BINs tags: - BIN Management description: Get a list of all Bank Identification Numbers (BINs) for an institution parameters: - $ref: '#/components/parameters/institutionId' responses: '200': description: List of BINs content: application/json: schema: type: array items: $ref: '#/components/schemas/InstitutionBin' '403': description: Missing needed abilities '500': description: Internal server error (something went wrong in the server side) /a/api/rapid-transfers/v1/institutions/{institutionId}/bins: post: summary: Create a BIN tags: - BIN Management description: Bulk Create Bank Identification Numbers (BINs) for an institution parameters: - $ref: '#/components/parameters/institutionId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InstitutionBins' responses: '201': description: BIN created successfully '400': description: Invalid request body '403': description: Missing needed abilities '500': description: Internal server error (something went wrong in the server side) /a/api/rapid-transfers/v1/institutions/{institutionId}/bin/{binId}: get: summary: Get a specific BIN tags: - BIN Management description: Get details of a specific Bank Identification Number (BIN) for an institution parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/binId' responses: '200': description: BIN details content: application/json: schema: $ref: '#/components/schemas/InstitutionBin' '403': description: Missing needed abilities '404': description: BIN not found '500': description: Internal server error (something went wrong in the server side) delete: summary: Delete a BIN tags: - BIN Management description: Delete a Bank Identification Number (BIN) for an institution parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/binId' responses: '204': description: BIN deleted successfully '403': description: Missing needed abilities '404': description: BIN not found '500': description: Internal server error (something went wrong in the server side) components: parameters: institutionId: in: path name: institutionId description: Id of the institution required: true schema: type: string format: uuid sweepId: in: path name: sweepId description: Id of the sweep required: true schema: type: string format: uuid transactionId: in: path name: transactionId description: Id of the transaction required: true binId: in: path name: binId description: Bank Identification Number (BIN) identifier required: true schema: type: string schemas: InstitutionBin: type: object required: - institutionId - bin properties: institutionId: type: string description: The unique identifier of the institution bin: type: string description: Bank Identification Number (BIN) - typically the first 6 digits of a card number InstitutionBins: type: object required: - institutionId - bins properties: institutionId: type: string description: The unique identifier of the institution bins: type: array description: Array of Bank Identification Numbers (BINs) to create in bulk items: type: string description: Bank Identification Number (BIN) - typically the first 6 digits of a card number minItems: 1 FIConfiguration: required: - pushToCardVelocityCountLimit - pushToCardVelocityAmountLimit - pullFromCardVelocityCountLimit - pullFromVelocityAmountLimit type: object properties: moovAccountId: type: string format: uuid nullable: true walletId: type: string nullable: true paymentMethodId: type: string format: uuid nullable: true pushToCardVelocityCountLimit: description: The limit of transfers that can be made in a 24 hour time period. type: number format: int64 pushToCardVelocityAmountLimit: description: The total transfer amount that can be made in a 24 hour time period. type: number format: int64 pullFromCardVelocityCountLimit: description: The limit of transfers that can be made in a 24 hour time period. type: number format: int64 pullFromCardVelocityAmountLimit: description: The total transfer amount that can be made in a 24 hour time period. type: number format: int64 businessPushToCardVelocityCountLimit: description: The limit of transfers for a business user that can be made in a 24 hour time period. type: number format: int64 businessPushToCardVelocityAmountLimit: description: The total transfer amount that can be made for a business user in a 24 hour time period. type: number format: int64 businessPullFromCardVelocityCountLimit: description: The limit of transfers for a business user that can be made in a 24 hour time period. type: number format: int64 businessPullFromCardVelocityAmountLimit: description: The total transfer amount that can be made for a business user in a 24 hour time period. type: number format: int64 userPushToCardVelocityCountLimit: description: The number of push to card transfers allowed for the user in a 24-hour period. type: number format: int64 userPushToCardVelocityAmountLimit: description: The total amount of push to card transfers allowed for the user in a 24-hour period. type: number format: int64 userPullFromCardVelocityCountLimit: description: The number of pull from card transfers allowed for the user in a 24-hour period. type: number format: int64 userPullFromCardVelocityAmountLimit: description: The total transfer amount that can be made for the user in a 24 hour time period. type: number format: int64 velocityLimits: description: Indicates if the FI sets their RT velocity limits at the card level or user level. type: string enum: [Card, User] TransactionSettings: type: object oneOf: - $ref: '#/components/schemas/SilverLakeTransactionSettings' - $ref: '#/components/schemas/EpisysTransactionSettings' - $ref: '#/components/schemas/CoreDirectorTransactionSettings' SilverLakeTransactionSettings: type: object required: - SourceCode - PushtoCardTransactionCode - PullfromCardTransactionCode - GLInterfaceCodePushtoCard - GLInterfaceCodePullfromCard - ServiceFeeCode - AvlBalCalcCode properties: SourceCode: type: string description: The source code. PushtoCardTransactionCode: type: string description: The transaction code for pushing to card. PullfromCardTransactionCode: type: string description: The transaction code for pulling from card. GLInterfaceCodePushtoCard: type: string description: The GL interface code for pushing to card. GLInterfaceCodePullfromCard: type: string description: The GL interface code for pulling from card. ServiceFeeCode: type: string description: The service fee code. AvlBalCalcCode: type: string enum: [AvlBal, CurBal, ColBal] description: The available balance calculation code. CoreDirectorTransactionSettings: type: object required: - SourceCode - PushtoCardTransactionCode - PullfromCardTransactionCode - GLInterfaceCodePushtoCard - GLInterfaceCodePullfromCard - ServiceFeeCode - AvlBalCalcCode - PushtoCardTransactionCodeSavings - PullfromCardTransactionCodeSavings properties: SourceCode: type: string description: The source code. PushtoCardTransactionCode: type: string description: The transaction code for pushing to card checking account. PullfromCardTransactionCode: type: string description: The transaction code for pulling from card checking account. GLInterfaceCodePushtoCard: type: string description: The GL interface code for pushing to card. GLInterfaceCodePullfromCard: type: string description: The GL interface code for pulling from card. ServiceFeeCode: type: string description: The service fee code. AvlBalCalcCode: type: string enum: [AvlBal, CurBal, ColBal] description: The available balance calculation code. PushtoCardTransactionCodeSavings: type: string description: The transaction code for pushing to card savings account. PullfromCardTransactionCodeSavings: type: string description: The transaction code for pulling from card savings account. EpisysTransactionSettings: type: object required: - UserDefinedGLCode properties: UserDefinedGLCode: type: string description: The user defined GL code. SweepsResponse: type: object properties: sweeps: type: array items: $ref: '#/components/schemas/Sweep' Sweep: type: object properties: sweepId: type: string format: uuid description: The sweep ID. statementDescriptor: type: string description: Is sent with the ACH sweep transaction. The actual sweepId cannot be sent. sweepAmount: type: string description: ACH sweep debit or credit amount. A negative number is a credit to the FI. A positive number is a debit to the FI. sweepAmountType: type: string description: Indicates if the ACH sweep amount is a Debit or a Credit amount. status: type: string description: Overall status of the sweep. startDate: type: string format: date-time description: Start date/time for a sweep period. endDate: type: string format: date-time description: End date/time for a sweep period. subtotals: type: array items: $ref: '#/components/schemas/Subtotals' TransfersBySweepIdResponse: type: object properties: transfers: type: array items: $ref: '#/components/schemas/TransfersBySweepId' Paging: type: object properties: nextOffSet: type: string results: type: number TransfersBySweepId: type: object properties: transferId: type: string format: uuid description: Rapid transfer id. transactionId: type: string description: Rapid transfer transaction Id. transactionAmount: type: string description: The amount of the transaction. transferType: type: string description: The type of Moov transfer. status: type: string description: Overall status of the transfer. transferCreationDate: type: string format: date-time description: The date the transfer was initiated. transferCompletionDate: type: string format: date-time description: The date the transfer status completed. sweepId: type: string format: uuid description: The sweep ID. Transfer: type: object properties: userId: type: string format: uuid description: Banno userId. transferId: type: string format: uuid description: Rapid transfer id. status: type: string description: Overall status of the transfer. failureReason: type: string description: The reason for the transfer failure, if applicable. nullable: true transferAmount: type: string description: The amount of the transfer. customerFeeAmount: type: string description: Fees the FI charges the customer. Fees are only for push to card transfers. transferType: type: string description: The type of Moov transfer. transferCreationDate: type: string format: date-time description: The date the transfer was initiated. transferCompletionDate: type: string format: date-time description: The date the transfer status completed. statementDescriptor: type: string description: the statement descriptor included in the end of day ACH debit or credit sent by Moov. transferDetails: type: object properties: from: type: object properties: jhAccountId: type: string format: uuid description: The account ID of the sender. accountType: type: string description: The type of the sender's account. accountNumber: type: string description: The account number of the sender. to: type: object properties: paymentMethodId: type: string format: uuid description: The payment method ID of the recipient. brand: type: string description: The brand of the recipient's card. lastFour: type: string description: The last four digits of the recipient's card. coreTransaction: type: object properties: transactionId: type: string format: uuid description: The core transaction ID. feeTransactionId: type: string format: uuid description: The fee transaction ID. moovTransaction: type: object properties: moovTransferId: type: string format: uuid description: The Moov transfer ID. moovTransactionId: type: string format: uuid description: The Moov transaction ID. Subtotals: type: object properties: amount: type: string description: The total amount of transactions for this type made during this sweep. count: type: string description: The total amount of transactions for this type made during this sweep. type: type: string enum: [pushToCard, pullFromCard, fee, cardDeclined] description: The type of wallet transactions made during this sweep.

Please ignore this field