Generate subsequent payment link

Action type: Do
Resource type: subsequentPaymentLink

Generates an subsequent payment link for the marketplace via the API. The current customer must be the same customer that is linked to the provider of the transaction for the call to work.

See technical marketplace documentation for general information.
See subsequent payment link for more information on this topic.

Parameter:

  • transactionid
    STRING. Transaction ID.
  • priceNet
    STRING. Net price in the format 1100.50.
  • description
    STRING. Description.
  • sendMailToCustomer
    BOOLEAN. Sends email to customer if true.

Example:

...
    {
        "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:do",
        "resourceid": null,
        "resourcetype": "subsequentPaymentLink",
        "identifier": "",
        "parameters": {
            "transactionid": "1100009189",
            "priceNet": "1000.00",
            "description": "Nachzahlung 3D-Rundgang",
            "sendMailToCustomer": true
        }
    }
...

Response parameter:

  • subsequentPaymentUrl
    STRING. URL link for the subsequent payment.
  • mailToCustomerSent
    BOOLEAN. Sends email to customer if true.

Response:

{
    "status": {
        "code": 200,
        "errorcode": 0,
        "message": "OK"
    },
    "response": {
        "results": [
            {
                "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:do",
                "resourceid": "",
                "resourcetype": "subsequentPaymentLink",
                "cacheable": false,
                "identifier": "",
                "data": {
                    "meta": {
                        "cntabsolute": null
                    },
                    "records": [
                        {
                            "id": 0,
                            "type": "",
                            "elements": {
                                "result": {
                                    "subsequentPaymentUrl": "https:\/\/beta.smart.onoffice.de\/smart\/short.php?c=1c138688f89e2d24d363ed7efec5a62797f5415671ddb358bd847486126ee4da",
                                    "mailToCustomerSent": true
                                }
                            }
                        }
                    ]
                },
                "status": {
                    "errorcode": 0,
                    "message": "OK"
                }
            }
        ]
    }
}