MB Way ID Purchase (Sandbox) 2.0.0

0
No votes yet
forum Discuss this API in the forum
production
development
https://site1.sibsapimarket.com:8445/sibs-qly/apimarket-sb
production
development
https://site2.sibsapimarket.com:8445/sibs-qly/apimarket-sb

Paths

/payment

post /payment
input
Required in body
object
InPayment
apim-oauth-token
Optional in header
string
Content-Type
Optional in header
string
application/json
text/plain
Accept
Optional in header
string
application/json
text/plain
200

200 OK

OutPayment
Example Request
Example Response
POST https://site1.sibsapimarket.com:8445/sibs-qly/apimarket-sb/spgbusiness/v1/mbway/payment
Try this operation
https://site1.sibsapimarket.com:8445/sibs-qly/apimarket-sb/spgbusiness/v1/mbway/payment
content-type
accept
apim-oauth-token

Definitions

Key value tuple.

{
    "type": "object",
    "properties": {
        "key": {
            "type": "string"
        },
        "value": {
            "type": "string"
        }
    }
}

Object that defines the transaction additional information

{
    "properties": {
        "extendedInfo": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/ExtendedInfo"
            },
            "description": "Key Value tuple array."
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "requestPayment": {
            "$ref": "#/definitions/RequestPayment",
            "description": "Object that defines the QR Code payment request parameters. Check the RequestPayment definition."
        }
    },
    "additionalProperties": false
}

Object that defines a Merchant.

{
    "properties": {
        "terminalId": {
            "type": "integer",
            "example": "21451",
            "description": "Number of the merchant pos Id.",
            "format": "int32"
        },
        "channel": {
            "type": "string",
            "description": "Type of channel used by the merchant.",
            "example": "web"
        },
        "merchantTransactionId": {
            "type": "string",
            "description": "Unique id used by the merchant.",
            "example": "863b730df285443f9a60ca404e0085fd1234"
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "responsePayment": {
            "description": "Object that defines the QR Code payment response parameters. Check the ResponsePayment definition.",
            "$ref": "#/definitions/ResponsePayment"
        }
    },
    "additionalProperties": false
}

Object that defines the payment operation request fields

{
    "properties": {
        "transactionToken": {
            "type": "string",
            "description": "Unique id identify of the transaction.",
            "example": "42f59038f3f14e618d091da8bf3b717e9999"
        },
        "customerPhone": {
            "type": "string",
            "description": "Customer's phone number.",
            "example": "351#912345678"
        },
        "info": {
            "$ref": "#/definitions/Info",
            "description": "Object that defines the aditional info provided by the merchant. Check the Info definition."
        }
    },
    "additionalProperties": false
}

Object that defines the payment operation return fields

{
    "properties": {
        "returnStatus": {
            "description": "Object that defines the Status of the transaction. Check the ReturnStatus definition.",
            "$ref": "#/definitions/ReturnStatus"
        },
        "transactionToken": {
            "type": "string",
            "description": "Unique id identify of the transaction.",
            "example": "42f59038f3f14e618d091da8bf3b717e9999"
        },
        "transactionID": {
            "type": "string",
            "description": "Unique identify of the transaction.",
            "example": "42f59038f3f14e618d091da8bf3b717e9999"
        },
        "merchant": {
            "description": "Object that defines the Merchant. Check the Merchant definition.",
            "$ref": "#/definitions/Merchant"
        },
        "paymentType": {
            "type": "string",
            "description": "Payment type used"
        }
    },
    "additionalProperties": false
}

Object that defines the status of the processed transaction.

{
    "properties": {
        "statusCode": {
            "type": "string",
            "description": "Identifier code of the processed transaction status.",
            "example": "000"
        },
        "statusMsg": {
            "type": "string",
            "description": "Message of the processed transaction status.",
            "example": "Success"
        },
        "statusDescription": {
            "type": "string",
            "description": "Description of the processed transaction status."
        }
    },
    "additionalProperties": false
}