production
development
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2
Paths
/v1/servicing/payments/spid-accounts/retrieve
post /v1/servicing/payments/spid-accounts/retrieve
retrieve-spid-accounts
LOB: Traditional Payments; Functionality: retrieve; Feature: SPID accounts
Get SPID accounts information and payee information which were updated due to bank regulation.
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
ChannelId
Required in header
string
Channel where request originated
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
sid
Required in header
string
SessionId sent by Consumer
pageId
Required in query
integer / int32
Page number to request in the query
rowLimit
Required in query
integer / int32
Number of rows to display on the requested page.
retrieveSpidAccountsRequest
Required in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| 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 |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/payments/spid-accounts/retrieve
Definitions
{
"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"
]
}
{
"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"
]
}
{
"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"
}
}
}
{
"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"
}
}
}
}
{
"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.99
},
"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"
}
}
}
{
"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"
}
}
}
{
"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"
]
}