Shipments

Confirm shipping goods to the customer.

Shipping is only required for secured payments. The insurance begins after the transport call has been made.

Why Shipment
The customer has 40 days starting from the delivery to pay for the order. The shipping date indicates the beginning of the 40-day period.

Benefit for you
You receive the money regardless of whether the customer pays or not.

Shipment supporting payment methods
Only the payment types invoice-secured supports the shipment call.

Payment method	Support shipments
/types/invoice-secured	yes
/types/invoice-secured	yes

Request / Response

curl https://api.unzer.com/v1/payments/s-pay-762/shipments -X POST \
  -u s-priv-xxxxxxxxxx:

{
    "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"
    }
}

The parameters isSuccess, isPending, isError indicate the result of the payment. Only one of these three can be true.

Status parameter	Description
isSuccess	The shipment call was executed successfully.
isPending	Never happens.
isError	Something went wrong. You’ll also find a news section that describes in more detail what the trouble was.

Name	Format	Description
id	string	ID of this shipment transaction
isSuccess	string	If the transaction was successful the value is set to true.
isPending	string	Never happens for shipment transaction.
isError	string	If an error occurs, this value is set to true.
message	object
message.code	string	Every error returns a unique id.
message.customer	string	Error message for the customer. Translated into the language specified in the Accept language header.
message.merchant	string	Error message for the merchant. This message always appears in English.
amount	string	The amount to be shipped on the specified account. The amount is in decimal form, e.g. EUR 1.22.
currency	string(3)	ISO currency code: For a list of possible codes, see: Amounts and Currencies
returnUrl	string	Always empty, due to shipment is not required to be redirected or confirmed payment.
date	date	Timestamp of this transaction.
resources	object
resources.customerId	string	Customer ID used for this transaction.
resource.basketId	string	Basket ID used for this transaction.
resource.metadataId	string	Meta data ID used for this transaction.
resources.paymentId	string	ID of the payment object.
resources.typeId	string	ID of the types resource which was used for this transaction.
processing	object
processing.uniqueId	string	Reference id of the shipment transaction.
processing.shortId	string	User-friendly reference ID of the shipment transaction.
processing.iban	string	Iban of the merchant in case of prepayment or invoice. In case of direct debit this value contains the customer IBAN.
processing.bic	string	Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer BIC.
processing.identification	string	This value returns the descriptor for invoice and prepayment.
processing.creatorId	string	This value returns your creditor id.