Api reference
Create and pay for a transfer
Consumes a pending quote, creates the delivery, and charges the merchant balance.
When the quote starts from a custom pickupLocation, send pickupContact too: who the courier meets there, in the same shape as recipientInfo (firstName, lastName, phone). It is required for a custom pickup (400 PICKUP_CONTACT_REQUIRED without it) and rejected for a warehouse pickup (400 PICKUP_CONTACT_NOT_ALLOWED), because a warehouse supplies its own contact details. In both cases the quote stays usable, so you can correct the request and send it again.
Authorization
bearerAuth AuthorizationBearer <token>
Access token returned by POST /auth/token.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/transfer" \ -H "Content-Type: application/json" \ -d '{ "matchmakingId": "22222222-2222-4222-8222-222222222222", "productKey": "YOUR_PRODUCT_KEY", "description": "One small package", "recipientInfo": { "firstName": "Nino", "lastName": "Beridze", "phone": "+995555123456" } }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "state": "inProgress", "transferCode": "string", "trackingCode": "string", "parcelSize": "string", "description": "string", "warehouseId": "42912a8b-9d3f-4436-9cfe-fb2306e3310f", "destinationWarehouseId": "a241636d-3181-4de2-9ed0-bf209c98e956", "pickupLocation": { "type": "Point", "coordinates": [ 0, 0 ] }, "pickupAddress": "string", "destinationLocation": { "type": "Point", "coordinates": [ 0, 0 ] }, "destinationAddress": "string", "destinationAddressMetadata": {}, "pickupAddressMetaData": {}, "deliveryOptionName": "string", "paymentTtlMinutes": 0, "paymentExpiresAt": "2019-08-24T14:15:22Z", "steps": [ { "step": "created", "order": 0, "status": "completed", "occuredAt": "2019-08-24T14:15:22Z" } ], "recipientInfo": { "firstName": "string", "lastName": "string", "phone": "string" }, "source": "API", "recipientFullName": "string", "totalPrice": 0, "isFragile": true, "isPerishable": true, "senderInfo": {}, "pickupContact": { "firstName": "string", "lastName": "string", "phone": "string" }}