---
swagger: "2.0"
info:
title: SERV-PYI-V-AccountTransferDetail
description: The purpose of this microservice is to have the account transfer details.
This service will be utilized for both mobile and online platform applications
to call the internal microservice for transfers.
version: 1.1.1
x-ibm-name: serv-pyi-v-accounttransferdetail
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
/v1/servicing/transfers/own-account/detail:
post:
tags:
- transfer-own-account
operationId: transfer-own-account
summary: To execute and get the account transfer details for transfer to the
own account of the customer.
description: This API is used to execute and get the account transfer details
for transfer to the own account of the customer.
consumes:
- application/json
produces:
- application/json
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: sid
in: header
required: true
type: string
description: SessionId sent by Consumer
- name: accountTransferRequest
in: body
schema:
$ref: '#/definitions/TransferOwnAccountRequest'
responses:
200:
description: Successful operation.
schema:
$ref: '#/definitions/TransferOwnAccountResponse'
400:
description:
Type | Code | Details |
error | invalidRequest | Missing
or invalid Parameters |
schema:
$ref: '#/definitions/ErrorResponse'
401:
description: Type | Code | Details |
error | unAuthorized | Authorization
credentials are missing or invalid |
schema:
$ref: '#/definitions/ErrorResponse'
403:
description: Type | Code | Details | More
Info |
error | accessNotConfigured | The request
operation is not configured to access this resource | Channel/Country/Business
provided in the request is not supported currently |
schema:
$ref: '#/definitions/ErrorResponse'
404:
description: Type | Code | Details | More
Info |
error | resourceNotFound | The requested
resource was not found | Empty resource/resource not found |
schema:
$ref: '#/definitions/ErrorResponse'
500:
description: Type | Code | Details |
fatal | serverUnavailable | The
request failed due to an internal error/server unavailability |
schema:
$ref: '#/definitions/ErrorResponse'
/v1/servicing/transfers/intra-banking/detail:
post:
tags:
- transfer-third-party-account
operationId: transfer-third-party-account
summary: To execute and get the account transfer details for transfer to the
third party accounts.
description: This API is used to execute and get the account transfer details
for transfer to the third party accounts.
consumes:
- application/json
produces:
- application/json
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: sid
in: header
required: true
type: string
description: SessionId sent by Consumer
- name: accountTransferRequest
in: body
schema:
$ref: '#/definitions/TransferThirdPartyRequest'
responses:
200:
description: Successful operation.
schema:
$ref: '#/definitions/TransferThirdPartyResponse'
400:
description: Type | Code | Details |
error | invalidRequest | Missing
or invalid Parameters |
schema:
$ref: '#/definitions/ErrorResponse'
401:
description: Type | Code | Details |
error | unAuthorized | Authorization
credentials are missing or invalid |
schema:
$ref: '#/definitions/ErrorResponse'
403:
description: Type | Code | Details | More
Info |
error | accessNotConfigured | The request
operation is not configured to access this resource | Channel/Country/Business
provided in the request is not supported currently |
schema:
$ref: '#/definitions/ErrorResponse'
404:
description: Type | Code | Details | More
Info |
error | resourceNotFound | The requested
resource was not found | Empty resource/resource not found |
schema:
$ref: '#/definitions/ErrorResponse'
500:
description: Type | Code | Details |
fatal | serverUnavailable | The
request failed due to an internal error/server unavailability |
schema:
$ref: '#/definitions/ErrorResponse'
/v1/servicing/transfers/inter-banking/detail:
post:
tags:
- transfer-inter-banking-account
operationId: transfer-inter-banking-account
summary: To execute and get the account transfer details for transfer to the
inter-banking accounts.
description: This API is used to execute and get the account transfer details
for transfer to the inter-banking accounts.
consumes:
- application/json
produces:
- application/json
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: sid
in: header
required: true
type: string
description: SessionId sent by Consumer
- name: accountTransferRequest
in: body
schema:
$ref: '#/definitions/TransferInterBankingRequest'
responses:
200:
description: Successful operation.
schema:
$ref: '#/definitions/TransferInterBankingResponse'
400:
description: Type | Code | Details |
error | invalidRequest | Missing
or invalid Parameters |
schema:
$ref: '#/definitions/ErrorResponse'
401:
description: Type | Code | Details |
error | unAuthorized | Authorization
credentials are missing or invalid |
schema:
$ref: '#/definitions/ErrorResponse'
403:
description: Type | Code | Details | More
Info |
error | accessNotConfigured | The request
operation is not configured to access this resource | Channel/Country/Business
provided in the request is not supported currently |
schema:
$ref: '#/definitions/ErrorResponse'
404:
description: Type | Code | Details | More
Info |
error | resourceNotFound | The requested
resource was not found | Empty resource/resource not found |
schema:
$ref: '#/definitions/ErrorResponse'
500:
description: Type | Code | Details |
fatal | serverUnavailable | The
request failed due to an internal error/server unavailability |
schema:
$ref: '#/definitions/ErrorResponse'
definitions:
TransferOwnAccountRequest:
type: object
properties:
transfer:
$ref: '#/definitions/Transfer'
security:
$ref: '#/definitions/Security'
TransferOwnAccountResponse:
type: object
properties:
transaction:
$ref: '#/definitions/Transaction'
TransferThirdPartyRequest:
type: object
properties:
transfer:
$ref: '#/definitions/Transfer'
security:
$ref: '#/definitions/SecurityInformation'
TransferThirdPartyResponse:
type: object
properties:
transaction:
$ref: '#/definitions/Transaction'
TransferInterBankingRequest:
type: object
properties:
transfer:
$ref: '#/definitions/Transfer'
security:
$ref: '#/definitions/SecurityInfo'
TransferInterBankingResponse:
type: object
properties:
transaction:
$ref: '#/definitions/Transaction'
Transfer:
type: object
properties:
sourceAccountId:
description: Unique account id of the source account
type: string
example: "1239402"
destinationAccountId:
description: Unique account id of the target account
type: string
example: "1239402"
transferAmount:
description: Amount of the operation
type: number
format: double
example: 120.550000
sameDayTransferFlag:
description: Flag to indicate if the transfer is going to be today or tomorrow
type: boolean
example: false
transactionScheduleDate:
description: Date and time used when the operation is scheduled for future
day
type: string
format: date
example: "2018-08-18T10:10:10"
concentratorAccountFlag:
description: Flag used to indicated if the target account is a concentrator
account
type: boolean
example: false
transferReference:
$ref: '#/definitions/TransferReference'
required:
- sourceAccountId
- destinationAccountId
- transferAmount
TransferReference:
type: object
properties:
transferShortDescription:
description: Concept for indicate reason of the transference
type: string
example: Pago prestamo
transferReferenceNumber:
description: Numeric reference for the transference
type: string
example: "9999999"
transferReferenceId:
description: AlphaNumeric reference for the transference
type: string
example: aaaabb3332bbb
transferDescription:
description: Description of the transfer operation
type: string
example: test1
Security:
type: object
properties:
accessToken:
description: Response of the challenge (password generated from token)
type: string
example: "1223121"
rsaVersion:
description: Version of the RSA that generates the data in the client (Browsers
or Mobile Apps)
type: string
example: 3.4.1.1
browser:
$ref: '#/definitions/BrowserDetails'
mobile:
$ref: '#/definitions/MobileDetails'
required:
- rsaVersion
BrowserDetails:
type: object
properties:
sessionBrowserUserAgent:
description: Web browser identifier
type: string
example: mozilla/5.0+(macintosh;+intel+mac+os+x+10_14_3)
screenResolution:
description: Resolution of the client's screen where the browser is running
type: string
example: 24|1440|900|830
browserTimezone:
description: Time zone configured in the browser
type: integer
format: int32
example: 6
javaVersion:
description: Java version loaded in the browser
type: integer
format: int32
example: 1
browserLanguage:
description: Browser language
type: string
example: lang=es-XL|syslang=|userlang=
cookieEnabledIndicator:
description: It indicates if cookies are enabled 0-disabled, 1-enabled
type: integer
format: int32
example: 1
applicationName:
description: Name of the application or in its absence the simple name of
the browser
type: string
example: Netscape
applicationCode:
description: Application code or browser agent code
type: string
example: Mozilla
internetEnabledFlag:
description: Flag that indicates if the browser has internet, true-enabled,
false-disabled
type: boolean
example: true
screenSize:
description: Width of the client's screen
type: integer
format: int32
example: 1440
screenPixels:
description: Deep of pixels on the client's screen
type: integer
format: int32
example: 24
osName:
description: Name of the operating system where the browser is running
type: string
example: Mac
browserVersion:
description: Browser version
type: integer
format: int32
example: 12
browserName:
description: Browser name
type: string
example: Safari
MobileDetails:
type: object
properties:
queryTime:
description: Time at which the request is launched, this data comes from the
time of the smartPhone
type: string
format: date
example: "2019-03-09T13:00:00Z"
deviceId:
description: Device identifier, if the SDK can not recover it, it returns
-1
type: string
example: "-1"
simId:
description: Identifier of the SIM card of the device, if the SDK can not
recover it, it returns -1
type: string
example: "-1"
phoneNumber:
description: Phone number of the device, if the SDK can not recover it, it
returns -1
type: string
example: "-1"
rsaApplicationKey:
description: Key that identifies the RSA SDK
type: string
example: 10F29219081905EC2BEBFF5AD779EE48
mobileCompromisedIndicator:
description: It indicates if the smartphone is altered (Root or Jailbreak),0-
disabled,1- enabled
type: integer
format: int32
example: 0
mobileEmulatorIndicator:
description: It indicates if the RSA SDK is running in simulator or in a physical
device,0- disabled,1- enabled
type: integer
format: int32
example: 1
SecurityInformation:
type: object
properties:
accessToken:
description: Response of the challenge (password generated from token)
type: string
example: "1223121"
rsaVersion:
description: Version of the RSA that generates the data in the client (Browsers
or Mobile Apps)
type: string
example: 3.4.1.1
browser:
$ref: '#/definitions/BrowserInformation'
mobile:
$ref: '#/definitions/MobileInformation'
required:
- rsaVersion
BrowserInformation:
type: object
properties:
sessionBrowserUserAgent:
description: Web browser identifier
type: string
example: mozilla/5.0+(macintosh;+intel+mac+os+x+10_14_3)
screenResolution:
description: Resolution of the client's screen where the browser is running
type: string
example: 24|1440|900|830
browserTimezone:
description: Time zone configured in the browser
type: integer
format: int32
example: 6
javaVersion:
description: Java version loaded in the browser
type: integer
format: int32
example: 1
browserLanguage:
description: Browser language
type: string
example: lang=es-XL|syslang=|userlang=
cookieEnabledIndicator:
description: It indicates if cookies are enabled 0-disabled, 1-enabled
type: integer
format: int32
example: 1
applicationName:
description: Name of the application or in its absence the simple name of
the browser
type: string
example: Netscape
applicationCode:
description: Application code or browser agent code
type: string
example: Mozilla
internetEnabledFlag:
description: Flag that indicates if the browser has internet, true-enabled,
false-disabled
type: boolean
example: true
screenSize:
description: Width of the client's screen
type: integer
format: int32
example: 1440
screenPixels:
description: Deep of pixels on the client's screen
type: integer
format: int32
example: 24
osName:
description: Name of the operating system where the browser is running
type: string
example: Mac
browserVersion:
description: Browser version
type: integer
format: int32
example: 12
browserName:
description: Browser name
type: string
example: Safari
MobileInformation:
type: object
properties:
queryTime:
description: Time at which the request is launched, this data comes from the
time of the smartPhone
type: string
format: date
example: "2019-03-09T13:00:00Z"
deviceId:
description: Device identifier, if the SDK can not recover it, it returns
-1
type: string
example: "-1"
simId:
description: Identifier of the SIM card of the device, if the SDK can not
recover it, it returns -1
type: string
example: "-1"
phoneNumber:
description: Phone number of the device, if the SDK can not recover it, it
returns -1
type: string
example: "-1"
rsaApplicationKey:
description: Key that identifies the RSA SDK
type: string
example: 10F29219081905EC2BEBFF5AD779EE48
mobileCompromisedIndicator:
description: It indicates if the smartphone is altered (Root or Jailbreak),0-
disabled,1- enabled
type: integer
format: int32
example: 0
mobileEmulatorIndicator:
description: It indicates if the RSA SDK is running in simulator or in a physical
device,0- disabled,1- enabled
type: integer
format: int32
example: 1
SecurityInfo:
type: object
properties:
accessToken:
description: Response of the challenge (password generated from token)
type: string
example: "1223121"
rsaVersion:
description: Version of the RSA that generates the data in the client (Browsers
or Mobile Apps)
type: string
example: 3.4.1.1
browser:
$ref: '#/definitions/BrowserInfo'
mobile:
$ref: '#/definitions/MobileInfo'
required:
- rsaVersion
BrowserInfo:
type: object
properties:
sessionBrowserUserAgent:
description: Web browser identifier
type: string
example: mozilla/5.0+(macintosh;+intel+mac+os+x+10_14_3)
screenResolution:
description: Resolution of the client's screen where the browser is running
type: string
example: 24|1440|900|830
browserTimezone:
description: Time zone configured in the browser
type: integer
format: int32
example: 6
javaVersion:
description: Java version loaded in the browser
type: integer
format: int32
example: 1
browserLanguage:
description: Browser language
type: string
example: lang=es-XL|syslang=|userlang=
cookieEnabledIndicator:
description: It indicates if cookies are enabled 0-disabled, 1-enabled
type: integer
format: int32
example: 1
applicationName:
description: Name of the application or in its absence the simple name of
the browser
type: string
example: Netscape
applicationCode:
description: Application code or browser agent code
type: string
example: Mozilla
internetEnabledFlag:
description: Flag that indicates if the browser has internet, true-enabled,
false-disabled
type: boolean
example: true
screenSize:
description: Width of the client's screen
type: integer
format: int32
example: 1440
screenPixels:
description: Deep of pixels on the client's screen
type: integer
format: int32
example: 24
osName:
description: Name of the operating system where the browser is running
type: string
example: Mac
browserVersion:
description: Browser version
type: integer
format: int32
example: 12
browserName:
description: Browser name
type: string
example: Safari
MobileInfo:
type: object
properties:
queryTime:
description: Time at which the request is launched, this data comes from the
time of the smartPhone
type: string
format: date
example: "2019-03-09T13:00:00Z"
deviceId:
description: Device identifier, if the SDK can not recover it, it returns
-1
type: string
example: "-1"
simId:
description: Identifier of the SIM card of the device, if the SDK can not
recover it, it returns -1
type: string
example: "-1"
phoneNumber:
description: Phone number of the device, if the SDK can not recover it, it
returns -1
type: string
example: "-1"
rsaApplicationKey:
description: Key that identifies the RSA SDK
type: string
example: 10F29219081905EC2BEBFF5AD779EE48
mobileCompromisedIndicator:
description: It indicates if the smartphone is altered (Root or Jailbreak),0-
disabled,1- enabled
type: integer
format: int32
example: 0
mobileEmulatorIndicator:
description: It indicates if the RSA SDK is running in simulator or in a physical
device,0- disabled,1- enabled
type: integer
format: int32
example: 1
Transaction:
type: object
properties:
transactionStatusCode:
description: Code of the transaction status
type: integer
format: int32
example: 0
transactionStatus:
description: Description of the transaction status
type: string
example: Success
transactionAmount:
description: Amount of the transaction/ operation
type: number
format: double
example: 120.550000
sameDayTransferFlag:
description: Flag to indicate if the transfer is going to be today or tomorrow
type: boolean
example: false
transactionScheduleDate:
description: Date and time used when the operation is scheduled for future
day
type: string
format: date
example: "2018-08-18T10:10:10"
concentratorAccountFlag:
description: Flag used to indicated if the target account is a concentrator
account
type: boolean
example: false
transactionDate:
description: Date Time when the operation was made
type: string
format: date
example: 10/02/2019/15:30
authorizationCode:
description: Authorization number given by bank for the operation
type: string
example: "40923892340243"
banxicoTrackingNumber:
description: Number provided by Banxico to track the operation in an interbank
transference
type: string
example: "40923892340565"
accountInformation:
type: array
items:
$ref: '#/definitions/AccountInformation'
transactionReference:
$ref: '#/definitions/TransactionReference'
required:
- transactionStatusCode
- transactionStatus
- transactionAmount
- transactionDate
- authorizationCode
AccountInformation:
type: object
properties:
validResponseFlag:
description: flag to represent if the response from backend has valid data
type: boolean
example: true
invalidResponseMessage:
description: error response from backend
type: string
example: No existe Informacion para el producto instrumento
accountId:
description: Unique ID used by front end to indentify the account
type: string
example: "123456"
branchId:
description: The branch id where the account was created
type: string
example: "1234"
accountNumber:
description: The account associated to the customer
type: string
example: "1234567890123456"
accountType:
description: Type of account
type: integer
format: int32
example: 1
accountTypeDescription:
description: Name of the type of the account
type: string
example: Cuenta maestra
accountAlias:
description: CLABE of the account
type: string
example: "123456789123"
accountNickName:
description: Nickname of the account
type: string
example: Mi cuenta favorita
productCode:
description: Product code that identify the type of account
type: integer
format: int32
example: 66
productInstrument:
description: The product instrument code
type: integer
format: int32
example: 12
productName:
description: The product name
type: string
example: Checking Account
currencyCode:
description: The currency code identifier of the account
type: string
example: "1"
currencyCodeDescription:
description: Currency Code of the account
type: string
example: MXN
displayAccountNumber:
description: Tha last digits of the account or card
type: string
example: "1234"
logoUrl:
description: link to the resource of the image of the logo
type: string
example: http://abc.jpg
accountBalanceInformation:
$ref: '#/definitions/AccountBalanceInformation'
required:
- validResponseFlag
- accountId
- accountNumber
- accountType
- accountTypeDescription
- productName
- currencyCodeDescription
- currencyCode
- displayAccountNumber
AccountBalanceInformation:
type: object
properties:
availableBalanceAmount:
description: available balance amount in the account
type: number
format: double
example: 1234.560000
currentBalanceAmount:
description: The current balance amount
type: number
format: double
example: 15000.230000
TransactionReference:
type: object
properties:
transferShortDescription:
description: Concept for indicate reason of the transference
type: string
example: Pago prestamo
transferReferenceNumber:
description: Numeric reference for the transference
type: string
example: "9999999"
transferReferenceId:
description: AlphaNumeric reference for the transference
type: string
example: aaaabb3332bbb
transferDescription:
description: Description of the transfer operation
type: string
example: test1
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: URI to human readable documentation or detailed description of
the error
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
ClientID:
type: apiKey
description: ""
in: header
name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
- /api/v1
ClientID: []
x-ibm-endpoints:
- endpointUrl: https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2
type:
- production
- development
...