Create a delivery
/sales/deliveriesCreates a delivery for a payment gateway from the gateway catalog. The selected gateway determines whether a secret is required.
The secret is write-only: responses indicate only whether a secret is configured.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Header Parameters
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/sales/deliveries" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "gateway": "string", "name": "string" }'{ "data": { "created_at": "2019-08-24T14:15:22Z", "enrollments_count": 0, "external_ids": [ "string" ], "gateway": "string", "hidden": true, "id": "string", "kind": "one_time", "name": "string", "object": "delivery", "postback_url": "string", "products_count": 0, "revision": "string", "secret": { "configured": true }, "status": "active", "tags_count": 0, "updated_at": "2019-08-24T14:15:22Z" }}List deliveries GET
Credentials restricted to specific products only see deliveries whose products are all within the scope of the current credentials.
Retrieve a delivery GET
Archived deliveries can still be retrieved, which allows them to be restored through the update operation. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when modifying the delivery to avoid overwriting a newer version.