Confirm shipment

Confirm shipping your goods to the customer.

About confirming shipment

Shipment is available for Unzer Invoice Secured and Unzer Instalment. Once you have sent the goods to the customer, you must confirm the shipment to start the insurance. The customer has 40 days after this date to make the payment.

To confirm a shipment, you need to call the /shipments endpoint.

Confirm shipment

To confirm a shipment, make a POST call to payments/{id}/shipments, with the following parameters in the request body:

Parameter Required Type Default Description Example
amount Yes Float / The shipment amount. 100.00
currency Yes String / The shipment currency, in the ISO 4217 alpha-3 format. EUR
customerId No String / The ID of the customers resource to be used. s-cst-3a0daffe47cb
typeId Yes String / The ID of the payment type resource to be used. s-crd-fm7tifzkqewy
POST https://api.unzer.com/v1/payments/s-pay-762/shipments
{
  "amount" : "100.00",
  "currency" : "EUR",
  "resources" : {
    "customerId" : "s-cst-138b70861e6c",
    "typeId" : "s-ivg-lghxo7dplglq"
  }
}
{
    "id": "s-shp-1",
    "isSuccess": true,
    "isPending": false,
    "isError": false,
    "message": {
        "code": "COR.000.100.112",
        "customer": "Request successfully processed in 'Merchant in Connector Test Mode'"
    },
    "amount": "100.0000",
    "currency": "EUR",
    "date": "2018-09-24 21:28:57",
    "resources": {
        "customerId": "s-cst-138b70861e6c",
        "paymentId": "s-pay-6985",
        "basketId": "",
        "metadataId": "",
        "typeId": "s-ivg-lghxo7dplglq"
    },
    "processing": {
        "uniqueId": "31HA07BC81AB33BC5F442A07D32F2DE4",
        "shortId": "4017.5093.7276"
    }
}
Property Type Description
id String The shipment’s unique ID.
isSuccess Boolean Set to true if the transaction was successful.
isPending Boolean Set to true if the transaction is pending
(e.g. if a redirect to an external system is required).
isError Boolean Set to true if an error occurs.
message String An error message describing the error in more detail.
code String A unique ID of the message.

For details, go to Error code structure.
customer String Message displayed to the customer.
amount Number The shipment amount.
currency String The shipment currency, in the ISO 4217 alpha-3 format.
date String Date and time of the shipment.
customerId String The ID of the customers resource.
paymentId String The ID of the related payment resource.
basketId String The ID of the related baskets resource.
metadataId String The ID of the related metadata resource.
typeId String The ID of the related payment type resource.
uniqueId String The ID of the transaction process.
shortId String The short ID of the transaction process.