Skip to content

Payin Query ​

API Info ​

  • Endpoint: POST /api/mx/payin-query
  • Method: POST
  • Content-Type: application/json

Request Headers ​

Same as API Signature: Content-Type, MerchantId, Timestamp, Nonce, Signature.

Request Parameters (at least one) ​

ParameterTypeRequiredDescription
orderIdstringconditionalPlatform order ID
merchantOrderIdstringconditionalMerchant order ID

Request Example ​

json
{ "orderId": "2100000000000000001" }

Response Parameters (data) ​

ParameterTypeDescription
orderIdstringPlatform order ID
merchantOrderIdstringMerchant order ID
payinMethodstringPayment method (CLABE)
amountBigDecimalOrder amount
feeBigDecimalFee (on success)
currencystringMXN
orderStatusstringPENDING / SUCCESS / FAILED
completeDatetimestringCompletion time
resultCodestringError code (on failure)
resultDescstringError description (on failure)

Released under the MIT License.