post https://sandbox.link.kiban.com/api/v2/cep/validate_status
Service to obtain the status of a transfer
Intro
This API is meant to obtain the status CEP (Comprobante Electrónico de Pago) to validate only the status of a transfer
Important points
Required parameters
Definition of the parameters in the example of the body request:
| field | type | required | Description |
|---|---|---|---|
| tipoCriterio | String | True | This field to indicate the type of the request, the possible values are: - T, for tracking key (Clave de rastreo). - R, for reference number (Referencia numérica). |
| fecha | String | True | Indicate the date on which the transaction was made in format ISO 8601 yyyy-MM-dd. |
| criterio | String | True | In this field you must report the value for the "Tracking key" or the "Reference number": - Reference number: It is an identification number of up to seven positions that the user selects when instructing his payment. - Tracking key: It is an identifier of up to 30 alphanumeric positions that the institution provides to the user at the time the payment is instructed. |
| emisor | Catalog | True | Indicate the bank of issue, it must coincide with the following catalog of banks |
| receptor | Catalog | True | Indicate the receiving bank, it must coincide with the following catalog of banks |
| receptorParticipante | String | False | Boolean field to validate if it is a payment to a bank - true, yes it's a payment for a bank, indicate the "Cuenta Ordenante" for the bank in the field cuenta. - false, no it's not a payment for a bank, indicate the "Cuenta Beneficiaria" of the receptor in the field cuenta. |
Successful response
Inside the response object you will only get the next fields.
| field Name | Description |
|---|---|
| claveRastreo | Indicates the tracking key |
| emisor | indicates the description of the issuing bank |
| estatusBanxico | indicates the status registered in Banxico. -En proceso: The SPEI or SPID has received the payment instruction from the ordering bank, but has not settled it or completed the deposit or transfer. -Liquidado: The payment was successfully completed by the SPEI or SPID and the latter has sent the corresponding notification to the beneficiary's bank. -Cancelado: The payment was received by the SPEI or SPID, however it was cancelled by the bank that received the payment instruction from its client, prior to it being settled. -Rechazado. The payment was rejected by the SPEI or SPID due to errors in the information it received from the issuing institution to process the payment or due to a serious security problem. -En proceso de devolución. The payment was settled and subsequently returned by the beneficiary's bank. The return is pending settlement. -Devuelto: The payment was returned by the beneficiary's bank; said return was settled by the SPEI or SPID and reported to the bank that originally sent the payment order. The latter is now able to deposit it into the account of the client who instructed the payment. -No liquidado: The payment was received by the SPEI or SPID but could not be settled during the respective operating day and was deleted when the system closed. The bank of the payer must refund the amount of the payment to the client who instructed it. -No encontrado: The SPEI or SPID has not received a payment order that meets the specified search criteria. |
| fechaProcesamiento | Indicates the date on which the registration was processed in Banxico in format ISO 8601 yyyy-mm-ddTHH:MM:SS.000Z. |
| fechaRecepcion | Indicates the date on which the transfer was made in Banxico in format ISO 8601 yyyy-mm-ddTHH:MM:SS.000Z. |
| numeroReferencia | Indicates the reference number. |
| receptor | indicates the description of the receiving bank. |
Test the service (test cases)
We have included a query parameter in Sandbox to enable you to query the test cases that we created for running tests. To get a response, fill the testCaseId parameter with any of the following cases:
| Num | Id | Name | Description |
|---|---|---|---|
| 1 | 66e4c3dcc614191476d2ffa5 | Demasiados resultados | Indicates many elements in the answer |
| 2 | 66ea01771042b8ae6deee07a | Fecha inválida | indicates an error in the date format |
| 3 | 66ce6628f4ab2f849969f6b2 | No encontrado | Indicates a not found example |
| 4 | 66ea01cf4d3f40f49908d0dc | Número de referencia inválido | Indicates an invalid reference number |
| 5 | 66ce66108ee608383e52d22d | Respuesta exitosa por rastreo | Indicates a success response for tracking key |
| 6 | 66ce661f69f1ea31b8782c35 | Respuesta exitosa por referencia | Indicates a success response for reference |
Test your own test case
In case you want to test your own test case created in link, you can send in the testCaseId parameter the identifier of the test case you want to use.
For more information visit our knowledge center to know more about test cases
