Add Shipping Note on Partial Delivery

This guide is for the deprecated Flex.API. If you are starting with a new integration, please refer to the Guide for the secuconnect API: Link

When you offer invoice payment to your customers, you need to inform us for every delivery of such a transaction. We need this information in the communication with you, the merchant, and with your customer.

If you inform us about an intermediate delivery, you need to call POST /payment/adddata.

Request

POST /payment/adddata HTTP/1.1
Host: api-testing.secupay-ag.de
Content-Type: application/json; charset=utf-8;
Accept: application/json
Accept-Charset: utf-8
 
{
  "data": {
    "apikey": "6801fxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx7ace",
    "hash": "oxaijkeaucbl2041",
    "tracking": {
      "provider": "DHL",
      "number": "TC123456789"
    },
    "invoice_number": "90001234555",
    "shipping_date": "2018-11-12 08:50:40"
  }
}

Note: You still need to call /capture for the final delivery. Otherwise we do not expect the full payment nor can we manage the payout.

All fields except hash and apikey are optional. Here the meanings:

Attribute	Type	Meaning
`tracking.provider`	`string`	Optional. The shipping provider like `"DHL"`, `"DPD"`, etc.
`tracking.number`	`string`	Optional. The tracking code received from the shipping provider.
`invoice_number`	`string`	Optional. Your invoice number.
`shipping_date`	`string`	Optional. The actual shipping date formatted like `"2018-01-31 08:50:40"`, up to three days in the past. Defaults to to the current time.