4. Endpoints
4.1. Create Order [POST /api/1.0/orders/]
This endpoint is provided to send transfer orders to other banks connected to SPEI.
4.1.1. Create Order Request ()
Example of request
URL: /api/1.0/orders/
{
"concept": "Payment",
"beneficiaryAccount": "684180017001000024",
"beneficiaryBank": "40159",
"beneficiaryName": "JUAN PEREZ",
"beneficiaryUid": "",
"numericalReference": 123,
"beneficiaryAccountType": 9,
"payerAccount": "684180017999000012",
"payerName": "ACME SA de CV",
"payerAccountType": 40,
"amount": 9999999999.99,
"paymentDay": 1716114930765,
"paymentType": 1,
"sign": "CEE100EEF6B5CD8DF297845530 231F54B8F7E7AD87B9EE41761F16707FE559EF"
}
4.1.2. Create Order Response ():
4.1.3. order-response object ():
Example of successful response (HTTP Code 200)
{
"code": 200,
"data": {
"beneficiaryBank": "40159",
"payerUid": "ABCJ950200LU6",
"beneficiaryAccountType": 9,
"concept": "Payment",
"sign": "sign",
"type": 0,
"scattered": "false,
"numericalReference": 0,
"createdAt": 1618338314384,
"queuedAt": null,
"payerAccountType": 40,
"paymentDay": 1716114930765,
"trackingKey": "2024051990684AWSPJ15019930556B",
"beneficiaryName": "JUAN PEREZ",
"payerName": "ACME SA de CV",
"errorDetail": null,
"id": "c1fd3739-7a1c-4f36-91ea-625929eb54f1",
"updatedAt": null,
"payerBank": "90684",
"amount": 9999999999.99,
"productId": "1791a508-0eff-4f87-af4a-f687f1de757e",
"sentAt": null,
"settlementDate": null,
"sent": false,
"beneficiaryUid": null,
"payerAccount": "684180017999000012",
"canceled": false,
"canceledAt": null,
"webhookNotify": false,
"beneficiaryAccount": "684180017001000024",
"subProductId": null,
"returned": false,
"accountBalance": null
}
}
4.1.2. Create Order Response ():
Example of response with error (HTTP Code 400)
{
"code": 400,
"errors": [
"payerAccount can not be null"
]
{
Download documentation
If you wish to download the PDF version of the API Transfer integration documentation, press the following button