Cashflows Gateway API

Processing mail and phone payments

After we receive the payment request with the card details, we check whether it’s a Mail Order, Telephone Order (MOTO) payment. If it is, we process it without any checks. By definition, a MOTO payment is made by email or telephone and therefore it’s not possible to carry out 3-D Secure checks.

After we have processed the payment, we notify you about the change of status for the payment (for example from Pending to Paid).

How to process a MOTO payment

For a MOTO payment, include the IsMoto option in the payment request.

Example request

{"type": "Payment", "paymentMethodsToUse": ["creditcard"],"parameters": {"cardNumber":"4000000000000002", "cardCvc": "123", "cardExpiryMonth": "05", "cardExpiryYear": "23" }, "order": {"orderNumber": "Payment ref M1"}, "options": [ "IsMoto" ], "currency": "GBP", "amountToCollect": "5.00"}

Example response

{

    "data": {

        "reference": "210221000033558552",

        "createDateTimeUtc": "2021-02-18T10:58:51.1499764Z",

        "type": "Payment",

        "traceReference": "210220104588703824",

        "configurationId": "200426117314086912",

        "domain": "cashflows.com",

        "locale": "en_GB",

        "timeZone": "Europe/London",

        "order": {

            "orderNumber": "Payment ref M1",

            "createDateTimeUtc": "2021-02-18T10:58:51.1499784Z",

            "orderLines": []

        },

        "orderHistory": [],

        "paymentMethodsToUse": [

            "Card"

        ],

        "currency": "GBP",

        "amountToCollect": "5.00",

        "amountCollected": "5.00",

        "paidAmount": "5.00",

        "paidDateTimeUtc": "2021-02-18T10:58:52.0469417Z",

        "expirationDateTimeUtc": "2021-08-18T10:58:51.1499752Z",

        "lastUpdateTimeUtc": "2021-02-18T10:58:52.071243Z",

        "lastProcessedTimeUtc": "2021-02-18T10:58:51.1499771Z",

        "flags": {

            "moto": true,

            "direct": true

},

        "attributes": {},

        "paymentStatus": "Paid",

        "payments": [

            {

                "reference": "210221100167776284",

                "createDateTimeUtc": "2021-02-18T10:58:51.3404954Z",

                "paymentMethods": [

                    "Card"

                ],

                "status": "Paid",

                "amountToCollect": "5.00",

                "surchargeAmount": "0",

                "paidAmount": "5.00",

                "steps": [

                    {

                        "reference": "210221221659516928",

                        "createDateTimeUtc": "2021-02-18T10:58:52.0467157Z",

                        "action": "Start",

                        "paymentMethods": [

                            "Card"

                        ],

                        "status": "Paid",

                        "amountToCollect": "5.00"

                    }

                ],

                "flags": {},

                "attributes": {

                    "returnUrlSuccess": "https://www.mywebshop.com/?paymentjobref=210221000033558552&paymentref=210221100167776284&ordernumber=Payment+ref+M1",

                    "returnUrlFailed": "https://www.mywebshop.com/?paymentjobref=210221000033558552&paymentref=210221100167776284&ordernumber=Payment+ref+M1",

                    "returnUrlCancelled": "https://www.mywebshop.com?paymentjobref=210221000033558552&paymentref=210221100167776284&ordernumber=Payment+ref+M1&status=cancelled",

                    "cashFlowsAcquiringDetails": "{\"AuthCode\":\"AUTHOK\",\"Arn\":\"74501871049010015672137\",\"Message\":\"Authorised\",\"Status\":\"Successful\",\"IssuerResponseCode\":\"00\",\"CvvAvsResult\":\"200\",\"AcquirerResponseCode\":\"A\",\"TruncatedCardNumber\":\"400000******0002\"}",

                    "paymentMethodTransactionId": "01S00DAA658"

                },

                "refunds": [],

                "captures": []

            }

        ]

    },

    "links": {

        "data": {

            "url": "https://gateway-int.cashflows.com/api/gateway/payment-jobs/210221000033558552",

            "type": "application/json"

        },

        "action": {

            "url": "https://www.mywebshop.com/?paymentjobref=210221000033558552&paymentref=210221100167776284&ordernumber=Payment+ref+M1",

            "type": "text/html"

        },

        "documentation": {

            "url": "https://gateway-int.cashflows.com/payment-gateway-api/documentation/index.html",

            "type": "text/html"

        }

    }

}

Important: To comply with financial regulations, a payment request from a financial institution needs to include some extra information about the person who is receiving the funds. This includes payment requests for MOTO, parent and recurring transactions. You need to include the extra details in the recipientDetails object. For information, see Additional details required for financial institutions.

Back to top