{"items":[{"type":"link","label":"Dime Partner API v2 — Orders","link":"/apis/v2/orders","routeSlug":"/apis/v2/orders","content":{"contentType":"overview","meta":{"name":"Dime Partner API v2 — Orders"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"orders.json","url":"/_bundle/apis/v2/orders.json?download"},{"kind":"download","label":"orders.yaml","url":"/_bundle/apis/v2/orders.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/v2/orders","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Dime Partner API v2 — Orders (2.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders represent a payment a merchant is collecting. Creating one returns"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the customer pays at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://pay.dimepay.app/e-order/{token}"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://pay.sandbox.dimepay.app/e-order/{token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"sectionId":"/"}],"sectionId":"/"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every request carries your client key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Unlike"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"v1, request bodies are plain JSON — there is no JWT signing and no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"envelope."},"children":[]}]}]}]}],"sectionId":"/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources are returned at the top level, with no wrapper. Errors return a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object using one of four types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/section/responses"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events for orders are delivered to the endpoints you register with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /webhook-endpoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the introduction of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"combined reference."},"children":[]}]}]}]}],"sectionId":"/section/webhooks"}]}]}},{"type":"link","label":"Authentication","link":"/apis/v2/orders/section/authentication","routeSlug":"/apis/v2/orders/section/authentication","content":null},{"type":"link","label":"Responses","link":"/apis/v2/orders/section/responses","routeSlug":"/apis/v2/orders/section/responses","content":null},{"type":"link","label":"Webhooks","link":"/apis/v2/orders/section/webhooks","routeSlug":"/apis/v2/orders/section/webhooks","content":null},{"type":"group","label":"Orders","link":"/apis/v2/orders/orders","routeSlug":"/apis/v2/orders/orders","items":[{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/orders/orders/listorders","routeSlug":"/apis/v2/orders/orders/listorders","metadata":{"seo":{"title":"List orders","description":"Returns your orders, newest first. Cursor-paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrders","name":"List orders","isWebhook":false,"pointer":"/paths/~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns your orders, newest first. Cursor-paginated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"origin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with no match returns an empty page, not a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"origin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not unique: nothing stops two orders from sharing one,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"so a filter can return more than one order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientKey","scopes":[],"type":"apiKey","in":"header","paramName":"client_key","description":"Your partner API key. Use a sandbox key when testing."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How many records to return, 1–100."},"children":[]}]}]}]},{"name":"starting_after","in":"query","schemaId":"schema_1","description":"Return records after this id. Use the last id of the previous page to\nwalk forward.\n"},{"name":"ending_before","in":"query","schemaId":"schema_1","description":"Return records before this id, to walk backward."},{"name":"origin_id","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you sent when creating the order. If you reused an id,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every matching order is returned."},"children":[]}]}]}],"example":"3f8a1e02-9c4d-4b71-a5e3-6d2f0b8c7a19"},{"name":"currency","in":"query","schemaId":"schema_2"},{"name":"customer_name","in":"query","schemaId":"schema_1","description":"Matches against the customer's full name or either half of it,\ncase-insensitively, as a substring.\n","example":"Jane"}],"pointer":"/paths/~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders","servers":[{"url":"/_mock/apis/v2/orders","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"ending_before","in":"query","required":false,"schemaId":"schema_1"},{"name":"origin_id","in":"query","example":"3f8a1e02-9c4d-4b71-a5e3-6d2f0b8c7a19","schemaId":"schema_1"},{"name":"currency","in":"query","example":"JMD","schemaId":"components/schemas/Currency"},{"name":"customer_name","in":"query","example":"Jane","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientKey","type":"apiKey","name":"client_key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/orders","href":"orders/listorders","openApiOperationId":"listOrders","summary":"List orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/v2/orders","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A page of orders.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1orders/get/responses/200/content/application~1json/examples/page"]}},"schemaId":"schema_3","exampleIds":["paths/~1orders/get/responses/200/content/application~1json/examples/page"]},{"code":"400","description":"The request was rejected.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/400/content/application~1json/examples/missing"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/400/content/application~1json/examples/missing"]},{"code":"401","description":"The client key was missing or not recognized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/401/content/application~1json/examples/unauthorized"]}],"pointer":"/paths/~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","exampleIds":["paths/~1orders/get/responses/200/content/application~1json/examples/page"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1orders/get/responses/200/content/application~1json/examples/page"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/400/content/application~1json/examples/missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/400/content/application~1json/examples/missing"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/401/content/application~1json/examples/unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listorders"}],"panels":[]}]},"httpPath":"/orders"},{"label":"Create an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/orders/orders/createorder","routeSlug":"/apis/v2/orders/orders/createorder","metadata":{"seo":{"title":"Create an order","description":"Creates an order. To take payment, send the buyer tohttps://pay.dimepay.app/e-order/{token} (sandbox:https://pay.sandbox.dimepay.app/e-order/{token}) using the tokenin the response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrder","name":"Create an order","isWebhook":false,"pointer":"/paths/~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an order. To take payment, send the buyer to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://pay.dimepay.app/e-order/{token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sandbox:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://pay.sandbox.dimepay.app/e-order/{token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must meet the currency minimum: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200 JMD"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 USD"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other currencies have no configured minimum."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This request is not idempotent: a retry creates a second order. See"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrying requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under Guides."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientKey","scopes":[],"type":"apiKey","in":"header","paramName":"client_key","description":"Your partner API key. Use a sandbox key when testing."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrderRequest","exampleIds":["paths/~1orders/post/requestBody/content/application~1json/examples/simple","paths/~1orders/post/requestBody/content/application~1json/examples/subscription","paths/~1orders/post/requestBody/content/application~1json/examples/bridge"]}},"schemaId":"components/schemas/CreateOrderRequest","exampleIds":["paths/~1orders/post/requestBody/content/application~1json/examples/simple","paths/~1orders/post/requestBody/content/application~1json/examples/subscription","paths/~1orders/post/requestBody/content/application~1json/examples/bridge"],"pointer":"/paths/~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders","servers":[{"url":"/_mock/apis/v2/orders","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientKey","type":"apiKey","name":"client_key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateOrderRequest","exampleIds":["paths/~1orders/post/requestBody/content/application~1json/examples/simple","paths/~1orders/post/requestBody/content/application~1json/examples/subscription","paths/~1orders/post/requestBody/content/application~1json/examples/bridge"]}},"responseCodes":["201","400","401"],"pointer":"/orders","href":"orders/createorder","openApiOperationId":"createOrder","summary":"Create an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/v2/orders","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"schemaId":"components/schemas/CreateOrderRequest","exampleIds":["paths/~1orders/post/requestBody/content/application~1json/examples/simple","paths/~1orders/post/requestBody/content/application~1json/examples/subscription","paths/~1orders/post/requestBody/content/application~1json/examples/bridge"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrderRequest","exampleIds":["paths/~1orders/post/requestBody/content/application~1json/examples/simple","paths/~1orders/post/requestBody/content/application~1json/examples/subscription","paths/~1orders/post/requestBody/content/application~1json/examples/bridge"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The order was created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order","exampleIds":["paths/~1orders/post/responses/201/content/application~1json/examples/created"]}},"schemaId":"components/schemas/Order","exampleIds":["paths/~1orders/post/responses/201/content/application~1json/examples/created"]},{"code":"400","description":"The request was rejected.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error-2","exampleIds":["paths/~1orders/post/responses/400/content/application~1json/examples/missing","paths/~1orders/post/responses/400/content/application~1json/examples/belowMinimum","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeNotEnabled","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeUntaggedItem","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeUnknownMerchant"]}},"schemaId":"components/schemas/Error-2","exampleIds":["paths/~1orders/post/responses/400/content/application~1json/examples/missing","paths/~1orders/post/responses/400/content/application~1json/examples/belowMinimum","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeNotEnabled","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeUntaggedItem","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeUnknownMerchant"]},{"code":"401","description":"The client key was missing or not recognized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/401/content/application~1json/examples/unauthorized"]}],"pointer":"/paths/~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Order","exampleIds":["paths/~1orders/post/responses/201/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order","exampleIds":["paths/~1orders/post/responses/201/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/Error-2","exampleIds":["paths/~1orders/post/responses/400/content/application~1json/examples/missing","paths/~1orders/post/responses/400/content/application~1json/examples/belowMinimum","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeNotEnabled","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeUntaggedItem","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeUnknownMerchant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error-2","exampleIds":["paths/~1orders/post/responses/400/content/application~1json/examples/missing","paths/~1orders/post/responses/400/content/application~1json/examples/belowMinimum","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeNotEnabled","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeUntaggedItem","paths/~1orders/post/responses/400/content/application~1json/examples/bridgeUnknownMerchant"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/post/responses/401/content/application~1json/examples/unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/createorder"}],"panels":[]}]},"httpPath":"/orders"},{"label":"Retrieve an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/orders/orders/retrieveorder","routeSlug":"/apis/v2/orders/orders/retrieveorder","metadata":{"seo":{"title":"Retrieve an order","description":"Takes the order's token, which is in the order object returned whenyou create or list orders. A token that matches no order returns404."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveOrder","name":"Retrieve an order","isWebhook":false,"pointer":"/paths/~1orders~1{token}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Takes the order's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is in the order object returned when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you create or list orders. A token that matches no order returns"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientKey","scopes":[],"type":"apiKey","in":"header","paramName":"client_key","description":"Your partner API key. Use a sandbox key when testing."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token","in":"path","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"ob9gWGGx5ACvn6KU"}],"pointer":"/paths/~1orders~1{token}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{token}","servers":[{"url":"/_mock/apis/v2/orders","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"parameters":{"path":[{"name":"token","in":"path","required":true,"example":"ob9gWGGx5ACvn6KU","schemaId":"schema_1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientKey","type":"apiKey","name":"client_key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/orders/{token}","href":"orders/retrieveorder","openApiOperationId":"retrieveOrder","summary":"Retrieve an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/v2/orders","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order","exampleIds":["paths/~1orders~1{token}/get/responses/200/content/application~1json/examples/order"]}},"schemaId":"components/schemas/Order","exampleIds":["paths/~1orders~1{token}/get/responses/200/content/application~1json/examples/order"]},{"code":"401","description":"The client key was missing or not recognized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{token}/get/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{token}/get/responses/401/content/application~1json/examples/unauthorized"]},{"code":"404","description":"No such resource for this merchant.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{token}/get/responses/404/content/application~1json/examples/missing"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{token}/get/responses/404/content/application~1json/examples/missing"]}],"pointer":"/paths/~1orders~1{token}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Order","exampleIds":["paths/~1orders~1{token}/get/responses/200/content/application~1json/examples/order"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order","exampleIds":["paths/~1orders~1{token}/get/responses/200/content/application~1json/examples/order"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{token}/get/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{token}/get/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{token}/get/responses/404/content/application~1json/examples/missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{token}/get/responses/404/content/application~1json/examples/missing"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/retrieveorder"}],"panels":[]}]},"httpPath":"/orders/{token}"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":"Create and retrieve orders."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orders","summary":"List orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listorders","deprecated":false},{"title":"/orders","summary":"Create an order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/createorder","deprecated":false},{"title":"/orders/{token}","summary":"Retrieve an order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/retrieveorder","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CreateOrderRequest":{"id":"components/schemas/CreateOrderRequest","kind":"json-schema","title":"CreateOrderRequest","data":{"type":"object","required":["id","currency","subtotal","total","email","referenceTransactionId"],"properties":{"id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your id for the order. Must be a UUID. Returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and matched by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"origin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Dime does not reject a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"repeated id, so send a new one for every order."},"children":[]}]}]}],"example":"3f8a1e02-9c4d-4b71-a5e3-6d2f0b8c7a19"},"currency":{"$ref":"#/components/schemas/Currency"},"subtotal":{"type":"number","minimum":0,"description":"Amount before tax and shipping.","example":1000},"total":{"type":"number","minimum":0,"description":"Amount to charge. Must meet the currency minimum.","example":1100},"tax":{"type":"number","minimum":0,"example":100},"shipping":{"type":"number","minimum":0,"example":0},"discount":{"type":"number","minimum":0,"example":0},"email":{"type":"string","format":"email","description":"The buyer's email address.","example":"buyer@example.com"},"referenceTransactionId":{"type":"string","description":"Your reconciliation reference. Stored with the order, but not\nreturned in the order object and not filterable.\n","example":"order-1024"},"description":{"type":"string","example":"A short description."},"items":{"type":"array","description":"Line items shown on the checkout page.","items":{"$ref":"#/components/schemas/LineItemInput"}},"billingPerson":{"$ref":"#/components/schemas/OrderPerson"},"shippingPerson":{"$ref":"#/components/schemas/OrderPerson"},"orderComments":{"type":"string","maxLength":1000,"description":"Stored as the order's notes. Defaults to your order id.","example":"Please deliver by Friday."},"is_subscription":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set true to bill this order on a recurring schedule. Requires"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPerson"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingPerson"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so there is a customer to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bill on future cycles."},"children":[]}]}]}],"example":false},"tokenize":{"type":"boolean","default":false,"description":"Store the card for future charges. Required for subscriptions.","example":false},"subscription_instructions":{"$ref":"#/components/schemas/SubscriptionInstructions"},"split":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dime Bridge. Splits this payment across the child merchants listed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here, one row per merchant. Requires Bridge to be enabled on your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on every line item. See "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dime Bridge"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"under Orders."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/BridgeSplitRow"}},"redirectUrl":{"type":"string","format":"uri","description":"Where to send the buyer after payment.","example":"https://example.com"},"checkoutUrl":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your cart URL. Stored and echoed as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkout_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://example.com/cart"},"metadata":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own key-value data, stored on the order and returned as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on every order response. Use it to tie the order to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"your records, such as a cart or customer id. Dime does not read"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is accepted as an alias for v1 parity."},"children":[]}]}]}],"example":{"cart_id":"cart_8812","channel":"web"}},"details":{"type":"object","additionalProperties":true,"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"v1's name for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Used only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is absent."},"children":[]}]}]}]}}}},"components/schemas/OrderPerson":{"id":"components/schemas/OrderPerson","kind":"json-schema","title":"OrderPerson","data":{"type":"object","description":"A billing or shipping contact.","properties":{"name":{"type":"string","example":"Michael Scott"},"phone":{"type":"string","example":"+18765551234"},"email":{"type":"string","format":"email","example":"mscott@example.com"},"street":{"type":"string","example":"555 Lackawanna Ave"},"city":{"type":"string","example":"Scranton"},"stateOrProvinceName":{"type":"string","example":"Pennsylvania"},"postalCode":{"type":"string","example":"18508"},"countryName":{"type":"string","example":"United States"},"countryCode":{"type":"string","example":"US"}}}},"components/schemas/LineItemInput":{"id":"components/schemas/LineItemInput","kind":"json-schema","title":"LineItemInput","data":{"type":"object","required":["name","price","quantity"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own identifier for the item, returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"SKU-BOOK-1"},"name":{"type":"string","example":"Sample Item"},"price":{"type":"number","minimum":0,"example":1100},"quantity":{"type":"integer","minimum":1,"example":1},"sku":{"type":"string","example":"SAMPLE"},"shortDescription":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the order's line items."},"children":[]}]}]}],"example":"A short description."},"imageUrl":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the order's line items."},"children":[]}]}]}],"example":"https://example.com"},"merchant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dime Bridge only. The child merchant this line is sold by, as a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"merchant token. Required on every item when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"split"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is sent."},"children":[]}]}]}],"example":"m4D8mQ1wMrdTUIg"}}}},"components/schemas/SubscriptionInstructions":{"id":"components/schemas/SubscriptionInstructions","kind":"json-schema","title":"SubscriptionInstructions","data":{"type":"object","required":["recurring_frequency"],"properties":{"recurring_frequency":{"type":"string","enum":["WEEKLY","MONTHLY","YEARLY"],"description":"How often to bill. Daily billing is not supported.","example":"WEEKLY"},"billing_cycles":{"type":"integer","minimum":1,"description":"Total number of charges, including this order. Omit to bill until\ncancelled.\n","example":12},"recurring_end_date":{"type":"string","format":"date-time","description":"When rebilling stops. Omit for no fixed end date.","example":"2027-08-26T00:00:00.000Z"}}}},"components/schemas/ListEnvelope":{"id":"components/schemas/ListEnvelope","kind":"json-schema","title":"ListEnvelope","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists are cursor-paginated. There is no total count: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_more"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reports whether another page exists."},"children":[]}]}]}],"required":["object","data","has_more"],"properties":{"object":{"type":"string","const":"list","example":"list"},"data":{"type":"array","items":{}},"has_more":{"type":"boolean","example":true}}}},"components/schemas/Order":{"id":"components/schemas/Order","kind":"json-schema","title":"Order","data":{"type":"object","properties":{"id":{"type":"string","description":"Prefixed identifier.","example":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209"},"object":{"type":"string","const":"order","example":"order"},"token":{"type":"string","description":"Public token, used in the checkout URL.","example":"ob9gWGGx5ACvn6KU"},"status":{"type":"string","enum":["PENDING","COMPLETE","FAILED","CANCELLED"],"example":"PENDING"},"currency":{"$ref":"#/components/schemas/Currency"},"subtotal":{"type":"number","example":1000},"total":{"type":"number","example":1100},"tax":{"type":["number","null"],"example":100},"shipping":{"type":["number","null"],"example":0},"tip":{"type":["number","null"],"example":0},"email":{"type":["string","null"],"example":"buyer@example.com"},"customer":{"type":["string","null"],"description":"Prefixed customer id, when one is attached.","example":"example"},"notes":{"type":["string","null"],"example":"example"},"fulfilled":{"type":"boolean","example":true},"recurring":{"type":"boolean","example":true},"subscription":{"oneOf":[{"$ref":"#/components/schemas/OrderSubscription"},{"type":"null"}]},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"reference":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you sent when creating the order."},"children":[]}]}]}],"example":"3f8a1e02-9c4d-4b71-a5e3-6d2f0b8c7a19"},"checkout_url":{"type":["string","null"],"format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your cart URL, echoed from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkoutUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you sent. If you did"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not send one, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns the Dime payment page here,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders/{token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not use this field to send the buyer to pay. The payment page"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://pay.dimepay.app/e-order/{token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sandbox:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://pay.sandbox.dimepay.app/e-order/{token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"https://pay.sandbox.dimepay.app/e-order/ob9gWGGx5ACvn6KU"},"metadata":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key-value data you sent as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") when the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order was created. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you sent none."},"children":[]}]}]}],"example":{"cart_id":"cart_8812","channel":"web"}},"created_at":{"type":"string","format":"date-time","example":"2026-08-26T00:48:52.252Z"},"updated_at":{"type":"string","format":"date-time","example":"2026-08-26T00:48:52.252Z"}}}},"components/schemas/OrderSubscription":{"id":"components/schemas/OrderSubscription","kind":"json-schema","title":"OrderSubscription","data":{"type":"object","properties":{"frequency":{"type":"string","enum":["WEEKLY","MONTHLY","YEARLY"],"example":"WEEKLY"},"billing_cycles":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charges remaining after this order. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it runs until cancelled."},"children":[]}]}]}],"example":11},"end_type":{"type":"string","enum":["CANCEL","CYCLE"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" runs until cancelled; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CYCLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" stops after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_cycles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"CANCEL"}}}},"components/schemas/LineItem":{"id":"components/schemas/LineItem","kind":"json-schema","title":"LineItem","data":{"type":"object","properties":{"name":{"type":"string","example":"Sample Item"},"external_id":{"type":["string","null"],"example":"3f8a1e02-9c4d-4b71-a5e3-6d2f0b8c7a19"},"sku":{"type":["string","null"],"example":"SAMPLE"},"quantity":{"type":"integer","example":1},"unit_amount":{"type":"number","example":1100},"description":{"type":["string","null"],"example":"A short description."},"image_url":{"type":["string","null"],"example":"https://example.com/item.png"}}}},"components/schemas/Currency":{"id":"components/schemas/Currency","kind":"json-schema","title":"Currency","data":{"type":"string","enum":["USD","JMD","GBP","EUR","TTD","BBD","XCD","GYD","SRD"],"example":"JMD"}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","enum":["invalid_request_error","card_error","idempotency_error","api_error"],"example":"invalid_request_error"},"code":{"type":"string","example":"parameter_missing"},"message":{"type":"string","example":"Order ID is required."},"param":{"type":"string","description":"The field that caused the failure, when applicable.","example":"id"}}}}}},"components/schemas/BridgeSplitRow":{"id":"components/schemas/BridgeSplitRow","kind":"json-schema","title":"BridgeSplitRow","data":{"type":"object","required":["merchant_id","fee"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One child merchant in a Dime Bridge split. Dime derives the payout"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the line items tagged with this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; only the platform"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fee is supplied."},"children":[]}]}]}],"properties":{"merchant_id":{"type":"string","description":"The child merchant's token. Must not be your own.","example":"m4D8mQ1wMrdTUIg"},"fee":{"type":"number","minimum":0,"description":"Platform fee you keep from this merchant's payout, in major units.\nDeducted after processing fees.\n","example":10}}}},"components/schemas/Error-2":{"id":"components/schemas/Error-2","kind":"json-schema","title":"Error-2","data":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which kind of failure occurred. Always one of four values, so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a client can branch on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before reading "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["invalid_request_error","card_error","idempotency_error","api_error"],"example":"invalid_request_error"},"code":{"type":"string","example":"parameter_missing"},"message":{"type":"string","example":"Order ID is required."},"param":{"type":"string","description":"The field that caused the failure, when applicable.","example":"id"}}}}}},"schema_0":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":10},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Currency"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListEnvelope"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Order"}}}}]},"id":"schema_3"}},"exampleStore":{"paths/~1orders/get/responses/200/content/application~1json/examples/page":{"value":{"object":"list","data":[{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","object":"order","token":"ob9gWGGx5ACvn6KU","status":"PENDING","currency":"JMD","subtotal":1000,"total":1100,"tax":100,"shipping":null,"tip":null,"email":"dev@example.com","customer":null,"notes":null,"fulfilled":false,"recurring":false,"subscription":null,"line_items":[{"name":"Sample Item","external_id":null,"sku":"SAMPLE","quantity":1,"unit_amount":1100,"description":null,"image_url":null}],"reference":"ac58293d-a2c5-4979-8ef7-f3d4a9354b63","checkout_url":"https://pay.sandbox.dimepay.app/e-order/ob9gWGGx5ACvn6KU","metadata":{},"created_at":"2026-10-27T15:04:05.000Z","updated_at":"2026-10-27T15:04:05.000Z"}],"has_more":false},"key":"page","summary":"A page of orders","id":"paths/~1orders/get/responses/200/content/application~1json/examples/page"},"paths/~1orders/get/responses/400/content/application~1json/examples/missing":{"value":{"error":{"type":"invalid_request_error","code":"parameter_missing","message":"Order ID is required.","param":"id"}},"key":"missing","summary":"A required field was absent","id":"paths/~1orders/get/responses/400/content/application~1json/examples/missing"},"paths/~1orders/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"error":{"type":"invalid_request_error","code":"unauthorized","message":"No API key provided."}},"key":"unauthorized","summary":"unauthorized","id":"paths/~1orders/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1orders/post/requestBody/content/application~1json/examples/simple":{"value":{"id":"ac58293d-a2c5-4979-8ef7-f3d4a9354b63","currency":"JMD","subtotal":1000,"total":1100,"tax":100,"email":"dev@example.com","referenceTransactionId":"order-1024","items":[{"name":"Sample Item","price":1100,"quantity":1,"sku":"SAMPLE"}]},"key":"simple","summary":"A one-item order","id":"paths/~1orders/post/requestBody/content/application~1json/examples/simple"},"paths/~1orders/post/requestBody/content/application~1json/examples/subscription":{"value":{"id":"7c1f6e42-6b3d-4a58-9d21-2f6b8c4e1a90","currency":"JMD","subtotal":1000,"total":1100,"tax":100,"email":"dev@example.com","referenceTransactionId":"sub-2048","is_subscription":true,"tokenize":true,"billingPerson":{"name":"Jane Chen","phone":"+18765550199"},"subscription_instructions":{"recurring_frequency":"MONTHLY","billing_cycles":12},"items":[{"name":"Monthly Plan","price":1100,"quantity":1,"sku":"PLAN"}]},"key":"subscription","summary":"A recurring order","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_cycles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the total number of charges. The order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"itself is the first, so the stored subscription holds one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fewer. Omit it to run until cancelled. A subscription order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"needs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPerson"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingPerson"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so there is a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer to bill."},"children":[]}]}]}],"id":"paths/~1orders/post/requestBody/content/application~1json/examples/subscription"},"paths/~1orders/post/requestBody/content/application~1json/examples/bridge":{"value":{"id":"9d2b7c54-1e8f-4a36-b7c1-5f0e2d8a4c13","currency":"USD","subtotal":2000,"total":2000,"email":"buyer@example.com","referenceTransactionId":"order-10001","items":[{"id":"SKU-BOOK-1","name":"Hardcover Book","price":500,"quantity":1,"merchant_id":"m4D8mQ1wMrdTUIg"},{"id":"SKU-COURSE-1","name":"Online Course Access","price":1500,"quantity":1,"merchant_id":"m7UarSiV9zWxN6v"}],"split":[{"merchant_id":"m4D8mQ1wMrdTUIg","fee":10},{"merchant_id":"m7UarSiV9zWxN6v","fee":30}]},"key":"bridge","summary":"A Dime Bridge order split across two merchants","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each line item names the merchant that sells it. The item"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"totals (500 + 1500) must equal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you keep from each merchant's payout."},"children":[]}]}]}],"id":"paths/~1orders/post/requestBody/content/application~1json/examples/bridge"},"paths/~1orders/post/responses/201/content/application~1json/examples/created":{"value":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","object":"order","token":"ob9gWGGx5ACvn6KU","status":"PENDING","currency":"JMD","subtotal":1000,"total":1100,"tax":100,"shipping":null,"tip":null,"email":null,"customer":null,"notes":"Order ac58293d-a2c5-4979-8ef7-f3d4a9354b63","fulfilled":false,"recurring":false,"subscription":null,"line_items":[{"name":"Sample Item","external_id":null,"sku":"SAMPLE","quantity":1,"unit_amount":1100,"description":null,"image_url":null}],"reference":"ac58293d-a2c5-4979-8ef7-f3d4a9354b63","checkout_url":"https://pay.sandbox.dimepay.app/e-order/ob9gWGGx5ACvn6KU","metadata":{},"created_at":"2026-08-26T00:48:52.252Z","updated_at":"2026-08-26T00:48:52.252Z"},"key":"created","summary":"Captured from a live sandbox response","id":"paths/~1orders/post/responses/201/content/application~1json/examples/created"},"paths/~1orders/post/responses/400/content/application~1json/examples/missing":{"value":{"error":{"type":"invalid_request_error","code":"parameter_missing","message":"Currency is required.","param":"currency"}},"key":"missing","summary":"A required field was absent","id":"paths/~1orders/post/responses/400/content/application~1json/examples/missing"},"paths/~1orders/post/responses/400/content/application~1json/examples/belowMinimum":{"value":{"error":{"type":"invalid_request_error","code":"parameter_invalid","message":"Order needs to be greater than 200 JMD","param":"total"}},"key":"belowMinimum","summary":"The total is under the currency minimum","id":"paths/~1orders/post/responses/400/content/application~1json/examples/belowMinimum"},"paths/~1orders/post/responses/400/content/application~1json/examples/bridgeNotEnabled":{"value":{"error":{"type":"invalid_request_error","code":"parameter_invalid","message":"Bridge split settlements are not enabled for this merchant. Ask Dime support to enable bridge.","param":"split"}},"key":"bridgeNotEnabled","summary":"A split was sent but Bridge is not enabled","id":"paths/~1orders/post/responses/400/content/application~1json/examples/bridgeNotEnabled"},"paths/~1orders/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch":{"value":{"error":{"type":"invalid_request_error","code":"parameter_invalid","message":"Order line totals must equal the transaction charge. Computed item total is 1500.00 USD, but charge total is 2000.00 USD.","param":"split"}},"key":"bridgeTotalsMismatch","summary":"The line items do not add up to the total","id":"paths/~1orders/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch"},"paths/~1orders/post/responses/400/content/application~1json/examples/bridgeUntaggedItem":{"value":{"error":{"type":"invalid_request_error","code":"parameter_invalid","message":"Bridge split orders require item-level merchant_id so payouts can be calculated from product totals. Item at index 1 is missing merchant_id.","param":"split"}},"key":"bridgeUntaggedItem","summary":"A line item has no merchant_id","id":"paths/~1orders/post/responses/400/content/application~1json/examples/bridgeUntaggedItem"},"paths/~1orders/post/responses/400/content/application~1json/examples/bridgeUnknownMerchant":{"value":{"error":{"type":"invalid_request_error","code":"parameter_invalid","message":"split contains an invalid Dime merchant token \"m7UarSiV9zWxN6v\".","param":"split"}},"key":"bridgeUnknownMerchant","summary":"A split row names a merchant that does not exist","id":"paths/~1orders/post/responses/400/content/application~1json/examples/bridgeUnknownMerchant"},"paths/~1orders/post/responses/401/content/application~1json/examples/unauthorized":{"value":{"error":{"type":"invalid_request_error","code":"unauthorized","message":"No API key provided."}},"key":"unauthorized","summary":"unauthorized","id":"paths/~1orders/post/responses/401/content/application~1json/examples/unauthorized"},"paths/~1orders~1{token}/get/responses/200/content/application~1json/examples/order":{"value":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","object":"order","token":"ob9gWGGx5ACvn6KU","status":"PENDING","currency":"JMD","subtotal":1000,"total":1100,"tax":100,"shipping":null,"tip":null,"email":"dev@example.com","customer":null,"notes":null,"fulfilled":false,"recurring":false,"subscription":null,"line_items":[{"name":"Sample Item","external_id":null,"sku":"SAMPLE","quantity":1,"unit_amount":1100,"description":null,"image_url":null}],"reference":"ac58293d-a2c5-4979-8ef7-f3d4a9354b63","checkout_url":"https://pay.sandbox.dimepay.app/e-order/ob9gWGGx5ACvn6KU","metadata":{},"created_at":"2026-10-27T15:04:05.000Z","updated_at":"2026-10-27T15:04:05.000Z"},"key":"order","summary":"An unpaid order","id":"paths/~1orders~1{token}/get/responses/200/content/application~1json/examples/order"},"paths/~1orders~1{token}/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"error":{"type":"invalid_request_error","code":"unauthorized","message":"No API key provided."}},"key":"unauthorized","summary":"unauthorized","id":"paths/~1orders~1{token}/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1orders~1{token}/get/responses/404/content/application~1json/examples/missing":{"value":{"error":{"type":"invalid_request_error","code":"resource_missing","message":"No such order: zzzzzzzzzzzzzzzz","param":"token"}},"key":"missing","summary":"missing","id":"paths/~1orders~1{token}/get/responses/404/content/application~1json/examples/missing"}},"securitySchemeStore":{"ClientKey":{"id":"ClientKey","type":"apiKey","description":"Your partner API key. Use a sandbox key when testing.","in":"header","paramName":"client_key"}},"specVersion":"3.1.0","servers":[{"url":"/_mock/apis/v2/orders","isMockServer":true,"description":"Mock server"},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/apis/v2/orders","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/v2/orders.json?download"},{"url":"/_bundle/apis/v2/orders.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Dime Partner API v2 — Orders","description":"Orders represent a payment a merchant is collecting. Creating one returns\na `token`; the customer pays at `https://pay.dimepay.app/e-order/{token}`\n(sandbox: `https://pay.sandbox.dimepay.app/e-order/{token}`).\n\n## Authentication\n\nEvery request carries your client key in the `client_key` header. Unlike\nv1, request bodies are plain JSON — there is no JWT signing and no `data`\nenvelope.\n\n## Responses\n\nResources are returned at the top level, with no wrapper. Errors return a\nsingle `error` object using one of four types: `invalid_request_error`,\n`card_error`, `idempotency_error`, `api_error`.\n\n## Webhooks\n\nEvents for orders are delivered to the endpoints you register with\n`POST /webhook-endpoints`. See **Webhooks** in the introduction of the\ncombined reference.\n"}},"baseSlug":"/apis/v2/orders","routesMapping":{}}