--- swagger: "2.0" info: title: serv-pyi-d-spid-accounts-info description: Microservice that obtains accounts information to manage SPID (Interbank Payment System in Dollars) payee accounts. Modified by bank regulation increasing the number of characters. version: 1.0.0 x-ibm-name: serv-pyi-d-spid-accounts-info host: 127.0.0.1 schemes: - https basePath: /api produces: - application/json consumes: - application/json paths: /v1/servicing/payments/spid-accounts/retrieve: post: tags: - retrieve-spid-accounts operationId: retrieve-spid-accounts summary: 'LOB: Traditional Payments; Functionality: retrieve; Feature: SPID accounts' description: Get SPID accounts information and payee information which were updated due to bank regulation. parameters: - name: client_id in: header required: true type: string description: Client ID generated during application registration - name: Authorization in: header required: true type: string description: The Authorization Token received during login - name: Accept in: header required: true type: string description: Content-Types that are acceptable for the response - name: uuid in: header required: true type: string description: 128 bit UUID that you generate for every request - name: Accept-Language in: header required: false type: string description: List of acceptable human languages for response - name: Content-Type in: header required: true type: string description: Content-Types that are sent in the request - name: ChannelId in: header required: true type: string description: Channel where request originated - name: countryCode in: header required: true type: string description: Country code in 2 character ISO 3166 format - name: businessCode in: header required: true type: string description: Business code identified during application registration - name: sid in: header required: true type: string description: SessionId sent by Consumer - name: pageId type: integer in: query format: int32 description: Page number to request in the query required: true - name: rowLimit type: integer in: query format: int32 description: Number of rows to display on the requested page. required: true - in: body name: retrieveSpidAccountsRequest required: true schema: $ref: '#/definitions/RetrieveSpidAccountsRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/RetrieveSpidAccountsResponse' 400: description:
TypeCodeDetails
errorinvalidRequestMissing or invalid Parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
TypeCodeDetailsMore Info
erroraccessNotConfiguredThe request operation is not configured to access this resourceChannel/Country/Business provided in the request is not supported currently
schema: $ref: '#/definitions/ErrorResponse' 404: description:
TypeCodeDetailsMore Info
errorresourceNotFoundThe requested resource was not foundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 422: description:
TypeCodeDetails
errorbusinessValidationFailedBusiness validation error occured on one or more parameters
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability
schema: $ref: '#/definitions/ErrorResponse' definitions: RetrieveSpidAccountsRequest: type: object properties: customerId: description: CitiBanamex internal customer identifier. type: string example: "123456789012" startDate: type: string format: date-time description: Start date-time to query filter on creationDate field example: 2022-01-01T12:10:00.000z endDate: type: string format: date-time description: End date-time to query filter on creationDate field example: 2022-01-01T12:10:00.000z payeeAccount: $ref: '#/definitions/PayeeAccount' required: - customerId RetrieveSpidAccountsResponse: type: object properties: customerId: description: CitiBanamex internal customer identifier. type: string example: "123456789012" recordCount: type: integer format: int64 description: Number of records in the query example: 0 totalPagesCount: type: integer format: int32 description: Total count of number pages example: 0 payees: type: array items: $ref: '#/definitions/Payee' required: - customerId - recordCount - totalPagesCount - payees PayeeAccount: type: object properties: accountNumber: description: Payee account number type: string example: "1234" referenceIdentifierType: description: Payee reference identifier type (61 - Interbank CLABE, 63 - Interbank Debit Card) type: string example: "61" Payee: type: object required: - fullName - taxId - payeeTypeCode properties: emailAddress: description: EmailAddress of payee type: string example: algo@dominio.com payeeTypeCode: description: Code for the Type of payee (01 - Physical person / 02 - Moral person) type: string example: "02" taxId: description: Actual tax number of payee. This will be unique for each applicant. type: string example: RIVX890228RN0 fullName: description: Full Name of Payee type: string example: juan perez alvarez businessSectorCode: description: Payee business sector code (56 - Privado , 32 - Particulares) type: string example: "01" itemCode: description: An item code is a representation of a product or service provided and it uniquely identifes an item type: string example: "301" payeeAccount: $ref: '#/definitions/PayeeAccountDetail' phoneData: type: array items: $ref: '#/definitions/Phone' PayeeAccountDetail: type: object required: - accountNumber - currencyId - referenceIdentifierType - transactionLimitAmount - paymentFrequencyType - accountNickName properties: accountNumber: description: Payee account number type: string example: "1234" bankId: description: Bank number for transfer type: string example: "12347" maxLength: 5 currencyId: description: Currency code of the SPID account type: string example: "05" transactionLimitAmount: description: Maximum transfer limit by payee type: number format: double example: 999999.990000 paymentFrequencyType: description: Frecuency of the transaction (D - Daily, S - Weekly, Q - Fortnightly, M - Monthly, B - Bimonthly, T - Quarterly, E - Semestral, A - Annual) type: string example: D referenceIdentifierType: description: Payee reference identifier type (61 - Interbank CLABE, 63 - Interbank Debit Card) type: string example: "61" accountNickName: description: Origin account's alias of the payee type: string example: Mi Cuenta maxLength: 55 sourceSystem: description: Source system used for account addition type: string example: "16" accountSubtypeCode: description: Subtype of the account of the payee (01 - Terceros/Otros bancos, 02 - Nomina, 03 - Tesoreria, 04 - Todas) type: string example: "02" routingNumber: description: Bank routing number is a nine-digit code that's based on the Bank location where your payee account was opened/belongs to. type: string example: 1234567890l branchId: description: Unique identifier of the agent's office or branch. Where was the payee account opened type: string example: "0123" swiftCode: description: BIC Code ISO 9362 defines a standard format of Bank Identifier Codes (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) approved by the International Organization for Standardization (ISO). type: string example: "01" naicsCode: description: North American Industry Classification System Code type: string example: "21000322" payeeReferenceNumber: description: Unique identifier assigned to each operation of adding payee account. type: string example: "000012314" creationDate: type: string format: date-time description: Payee account creation date-time example: 2022-01-01T12:10:00.000z cancellationDate: type: string format: date-time description: Payee account cancellation date-time example: 2022-01-01T12:10:00.000z lastSearchDate: type: string format: date-time description: Payee account last search date-time example: 2022-01-01T12:10:00.000z lastUpdatedDate: type: string format: date-time description: Payee account last update date-time example: 2022-01-01T12:10:00.000z Phone: type: object properties: phoneNumber: description: Phone number of the Payee type: string example: "3323479817" maxLength: 10 phoneTypeCode: description: Phone type of the Payee ( 0001 - Casa, 0002 - Oficina o Empresa, 0008 - Oficina Celular) type: string example: "0001" ErrorResponse: properties: type: type: string description: Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again enum: - error - warn - invalid - fatal code: description: Error code which qualifies the error type: string details: description: Human readable explanation specific to the occurrence of the problem type: string location: description: The name of the field that resulted in the error type: string moreInfo: description: More Info can be used to pass any additional details type: string uuid: description: 128 bit UUID that you generate for every request type: string timestamp: description: Timestamp of the error type: string required: - type - code x-ibm-configuration: enforced: true testable: true phase: realized securityDefinitions: OAuth2 Application Flow: type: oauth2 description: "" flow: application scopes: /api/v1: "" tokenUrl: https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/oauth/token Client ID: type: apiKey description: "" in: header name: X-IBM-Client-Id security: - OAuth2 Application Flow: - /api/v1 Client ID: [] x-ibm-endpoints: - endpointUrl: https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2 type: - production - development ...