Charge Flow

Create a unique launch URL to complete a Securely application flow from a 3rd party system.

A charge flow will generate a url that can be used to direct a customer to make a payment. The payload will be used to construct the proper url to send the customer to the correct payment experience.

JSON

"payload": {
    "amount": 54.00, // base amount of the transaction to pay
    "message": "Thank you for your business", // personalized message for the customer
    "internalNotes": null, // notes visible only to merchant associated with payment
    "invoiceNumber": "invc-098789874422", // unique value referenced by customer
    "externalIdentifier": "pmt-launch-test.2", // A unique identifier for the payment
    "paymentDeliveryTypes": ["TERMINAL"],// available methods to pay by, more info below
    "isAsynchronous": false, // Used with "ONETIME" payment, launch will return immediately if true
    "customer": { // The customer for the payment, external id is only thing required
        "firstName": null,
        "lastName": null,
        "email": null,
        "phone": null,
        "autoRegister": false,
        "externalIdentifier": "rn-19876-os76" // external unique identifier to ID the customer
    }
}

📘

Payment Delivery Types

Payment delivery types tell Securely what to present as options on the ways to accept payment. You can control which of these payment deliveries are displayed and if only one is provided, the flow will go directly into that experience bypassing the step to choose one.

Value	Definition
ONETIME	A method for sending a payment request to a customer via email or text that they can pay at a later date.
QUICKPAY	A method for allowing customers to provide payment information typically over the phone or card on file for traditional "Card Not Present" payments.
TERMINAL	Using Securely to communicate with a terminal, take "Card Present" payments for typically over the counter payments.

Below is an example of providing all the payment delivery types. This will present three buttons for the Payment Delivery section, allowing the user to choose the appropriate method.

API reference: Create a charge flow