{"items":[{"type":"link","label":"Dime Partner API v2 — Payments","link":"/apis/v2/payments","routeSlug":"/apis/v2/payments","content":{"contentType":"overview","meta":{"name":"Dime Partner API v2 — Payments"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"payments.json","url":"/_bundle/apis/v2/payments.json?download"},{"kind":"download","label":"payments.yaml","url":"/_bundle/apis/v2/payments.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/payments","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 — Payments (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":"Charge a stored card, then capture, void, or refund the resulting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction."},"children":[]}]}]}]}],"sectionId":"/"}],"sectionId":"/"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/choosing-an-operation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Choosing an operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizes and captures in one step."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorize"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the funds; follow with capture to take them, or void"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to release them."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns money after a transaction has settled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card tokens come from a verified tokenization request."},"children":[]}]}]}]}],"sectionId":"/section/choosing-an-operation"}]}]}},{"type":"link","label":"Choosing an operation","link":"/apis/v2/payments/section/choosing-an-operation","routeSlug":"/apis/v2/payments/section/choosing-an-operation","content":null},{"type":"group","label":"Payments","link":"/apis/v2/payments/payments","routeSlug":"/apis/v2/payments/payments","items":[{"label":"Create a hosted payment page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/payments/payments/createhostedpage","routeSlug":"/apis/v2/payments/payments/createhostedpage","metadata":{"seo":{"title":"Create a hosted payment page","description":"Creates an order and returns what you need to send the buyer to pay.It takes the same body as POST /orders and applies the samevalidation; only the response is shorter: id, token, currency,checkout_url and created_at."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createHostedPage","name":"Create a hosted payment page","isWebhook":false,"pointer":"/paths/~1payments~1hosted-page/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a hosted payment page","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 and returns what you need to send the buyer to pay."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It takes the same body as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and applies the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"validation; only the response is shorter: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"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":"checkout_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"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":"To take payment, redirect the buyer to the Dime payment page:"},"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":"). If you sent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkoutUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkout_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is your own cart URL,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not the payment page."},"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/~1payments~1hosted-page/post/requestBody/content/application~1json/examples/simple"]}},"schemaId":"components/schemas/CreateOrderRequest","exampleIds":["paths/~1payments~1hosted-page/post/requestBody/content/application~1json/examples/simple"],"pointer":"/paths/~1payments~1hosted-page/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/hosted-page","servers":[{"url":"/_mock/apis/v2/payments","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/~1payments~1hosted-page/post/requestBody/content/application~1json/examples/simple"]}},"responseCodes":["201","400","401"],"pointer":"/payments/hosted-page","href":"payments/createhostedpage","openApiOperationId":"createHostedPage","summary":"Create a hosted payment page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/v2/payments","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"schemaId":"components/schemas/CreateOrderRequest","exampleIds":["paths/~1payments~1hosted-page/post/requestBody/content/application~1json/examples/simple"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrderRequest","exampleIds":["paths/~1payments~1hosted-page/post/requestBody/content/application~1json/examples/simple"]}},"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/HostedPageResult","exampleIds":["paths/~1payments~1hosted-page/post/responses/201/content/application~1json/examples/created"]}},"schemaId":"components/schemas/HostedPageResult","exampleIds":["paths/~1payments~1hosted-page/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","exampleIds":["paths/~1payments~1hosted-page/post/responses/400/content/application~1json/examples/missing"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1hosted-page/post/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/~1payments~1hosted-page/post/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1hosted-page/post/responses/401/content/application~1json/examples/unauthorized"]}],"pointer":"/paths/~1payments~1hosted-page/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/HostedPageResult","exampleIds":["paths/~1payments~1hosted-page/post/responses/201/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HostedPageResult","exampleIds":["paths/~1payments~1hosted-page/post/responses/201/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1hosted-page/post/responses/400/content/application~1json/examples/missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1hosted-page/post/responses/400/content/application~1json/examples/missing"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1hosted-page/post/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1hosted-page/post/responses/401/content/application~1json/examples/unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/createhostedpage"}],"panels":[]}]},"httpPath":"/payments/hosted-page"},{"label":"Charge a card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/payments/payments/salepayment","routeSlug":"/apis/v2/payments/payments/salepayment","metadata":{"seo":{"title":"Charge a card","description":"Charges the card in one step: authorizes and captures. A successfulcharge returns 200 with status: COMPLETE."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"salePayment","name":"Charge a card","isWebhook":false,"pointer":"/paths/~1payments~1sale/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Charge a card","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":"Charges the card in one step: authorizes and captures. A successful"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: COMPLETE"},"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":"A declined card returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: card_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code: card_declined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is safe to show the buyer. A"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: api_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the processor did not answer, so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the charge may or may not have gone through. Check before retrying"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(see "},"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":")."},"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/ChargeRequest","exampleIds":["paths/~1payments~1sale/post/requestBody/content/application~1json/examples/sale","paths/~1payments~1sale/post/requestBody/content/application~1json/examples/bridge"]}},"schemaId":"components/schemas/ChargeRequest","exampleIds":["paths/~1payments~1sale/post/requestBody/content/application~1json/examples/sale","paths/~1payments~1sale/post/requestBody/content/application~1json/examples/bridge"],"pointer":"/paths/~1payments~1sale/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/sale","servers":[{"url":"/_mock/apis/v2/payments","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/ChargeRequest","exampleIds":["paths/~1payments~1sale/post/requestBody/content/application~1json/examples/sale","paths/~1payments~1sale/post/requestBody/content/application~1json/examples/bridge"]}},"responseCodes":["200","400","401","402","500"],"pointer":"/payments/sale","href":"payments/salepayment","openApiOperationId":"salePayment","summary":"Charge a card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/v2/payments","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"schemaId":"components/schemas/ChargeRequest","exampleIds":["paths/~1payments~1sale/post/requestBody/content/application~1json/examples/sale","paths/~1payments~1sale/post/requestBody/content/application~1json/examples/bridge"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargeRequest","exampleIds":["paths/~1payments~1sale/post/requestBody/content/application~1json/examples/sale","paths/~1payments~1sale/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":"200","description":"The resulting transaction.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1sale/post/responses/200/content/application~1json/examples/sale","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/auth","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/capture","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/void","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/refund"]}},"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1sale/post/responses/200/content/application~1json/examples/sale","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/auth","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/capture","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/void","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/refund"]},{"code":"400","description":"The charge was rejected.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/400/content/application~1json/examples/unknownCard","paths/~1payments~1sale/post/responses/400/content/application~1json/examples/bridgeNotEnabled","paths/~1payments~1sale/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/400/content/application~1json/examples/unknownCard","paths/~1payments~1sale/post/responses/400/content/application~1json/examples/bridgeNotEnabled","paths/~1payments~1sale/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch"]},{"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/~1payments~1sale/post/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/401/content/application~1json/examples/unauthorized"]},{"code":"402","description":"The card was declined.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/402/content/application~1json/examples/declined"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/402/content/application~1json/examples/declined"]},{"code":"500","description":"The processor did not respond. The outcome is unknown; check before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/500/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/500/content/application~1json/examples/unavailable"]}],"pointer":"/paths/~1payments~1sale/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1sale/post/responses/200/content/application~1json/examples/sale","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/auth","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/capture","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/void","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/refund"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1sale/post/responses/200/content/application~1json/examples/sale","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/auth","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/capture","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/void","paths/~1payments~1sale/post/responses/200/content/application~1json/examples/refund"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/400/content/application~1json/examples/unknownCard","paths/~1payments~1sale/post/responses/400/content/application~1json/examples/bridgeNotEnabled","paths/~1payments~1sale/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/400/content/application~1json/examples/unknownCard","paths/~1payments~1sale/post/responses/400/content/application~1json/examples/bridgeNotEnabled","paths/~1payments~1sale/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"402","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/402/content/application~1json/examples/declined"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/402/content/application~1json/examples/declined"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/500/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1sale/post/responses/500/content/application~1json/examples/unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/salepayment"}],"panels":[]}]},"httpPath":"/payments/sale"},{"label":"Authorize a card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/payments/payments/authorizepayment","routeSlug":"/apis/v2/payments/payments/authorizepayment","metadata":{"seo":{"title":"Authorize a card","description":"Holds the funds without taking them. A successful hold returns 200with status: AUTHORISED. Capture it with PUT /payments/capture orrelease it with PUT /payments/void. Declines and processor failuresreturn the same errors as POST /payments/sale."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authorizePayment","name":"Authorize a card","isWebhook":false,"pointer":"/paths/~1payments~1auth/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorize a card","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":"Holds the funds without taking them. A successful hold returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: AUTHORISED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Capture it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /payments/capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"release it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /payments/void"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Declines and processor failures"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return the same errors as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /payments/sale"},"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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargeRequest"}},"schemaId":"components/schemas/ChargeRequest","pointer":"/paths/~1payments~1auth/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/auth","servers":[{"url":"/_mock/apis/v2/payments","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/ChargeRequest"}},"responseCodes":["200","400","401","402","500"],"pointer":"/payments/auth","href":"payments/authorizepayment","openApiOperationId":"authorizePayment","summary":"Authorize a card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/v2/payments","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"schemaId":"components/schemas/ChargeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The resulting transaction.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1auth/post/responses/200/content/application~1json/examples/sale","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/auth","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/capture","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/void","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/refund"]}},"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1auth/post/responses/200/content/application~1json/examples/sale","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/auth","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/capture","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/void","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/refund"]},{"code":"400","description":"The charge was rejected.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/400/content/application~1json/examples/unknownCard","paths/~1payments~1auth/post/responses/400/content/application~1json/examples/bridgeNotEnabled","paths/~1payments~1auth/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/400/content/application~1json/examples/unknownCard","paths/~1payments~1auth/post/responses/400/content/application~1json/examples/bridgeNotEnabled","paths/~1payments~1auth/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch"]},{"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/~1payments~1auth/post/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/401/content/application~1json/examples/unauthorized"]},{"code":"402","description":"The card was declined.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/402/content/application~1json/examples/declined"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/402/content/application~1json/examples/declined"]},{"code":"500","description":"The processor did not respond. The outcome is unknown; check before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/500/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/500/content/application~1json/examples/unavailable"]}],"pointer":"/paths/~1payments~1auth/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1auth/post/responses/200/content/application~1json/examples/sale","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/auth","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/capture","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/void","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/refund"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1auth/post/responses/200/content/application~1json/examples/sale","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/auth","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/capture","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/void","paths/~1payments~1auth/post/responses/200/content/application~1json/examples/refund"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/400/content/application~1json/examples/unknownCard","paths/~1payments~1auth/post/responses/400/content/application~1json/examples/bridgeNotEnabled","paths/~1payments~1auth/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/400/content/application~1json/examples/unknownCard","paths/~1payments~1auth/post/responses/400/content/application~1json/examples/bridgeNotEnabled","paths/~1payments~1auth/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"402","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/402/content/application~1json/examples/declined"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/402/content/application~1json/examples/declined"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/500/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1auth/post/responses/500/content/application~1json/examples/unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/authorizepayment"}],"panels":[]}]},"httpPath":"/payments/auth"},{"label":"Capture an authorization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/payments/payments/capturepayment","routeSlug":"/apis/v2/payments/payments/capturepayment","metadata":{"seo":{"title":"Capture an authorization","description":"Captures an authorization in full. Only a transaction withstatus: AUTHORISED can be captured, and only once; it then hasstatus: COMPLETE. Partial capture is not supported. Any otherstatus returns 404."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"capturePayment","name":"Capture an authorization","isWebhook":false,"pointer":"/paths/~1payments~1capture/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Capture an authorization","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":"Captures an authorization in full. Only a transaction with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: AUTHORISED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be captured, and only once; it then has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: COMPLETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Partial capture is not supported. Any other"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status returns "},"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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionAction"}},"schemaId":"components/schemas/TransactionAction","pointer":"/paths/~1payments~1capture/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/payments/capture","servers":[{"url":"/_mock/apis/v2/payments","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/TransactionAction"}},"responseCodes":["200","400","401","404"],"pointer":"/payments/capture","href":"payments/capturepayment","openApiOperationId":"capturePayment","summary":"Capture an authorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/v2/payments","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"schemaId":"components/schemas/TransactionAction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionAction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The resulting transaction.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1capture/put/responses/200/content/application~1json/examples/sale","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/auth","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/capture","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/void","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/refund"]}},"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1capture/put/responses/200/content/application~1json/examples/sale","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/auth","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/capture","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/void","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/refund"]},{"code":"400","description":"The request was rejected.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1capture/put/responses/400/content/application~1json/examples/missing"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1capture/put/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/~1payments~1capture/put/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1capture/put/responses/401/content/application~1json/examples/unauthorized"]},{"code":"404","description":"No such transaction for this merchant.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1capture/put/responses/404/content/application~1json/examples/missing"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1capture/put/responses/404/content/application~1json/examples/missing"]}],"pointer":"/paths/~1payments~1capture/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1capture/put/responses/200/content/application~1json/examples/sale","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/auth","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/capture","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/void","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/refund"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1capture/put/responses/200/content/application~1json/examples/sale","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/auth","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/capture","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/void","paths/~1payments~1capture/put/responses/200/content/application~1json/examples/refund"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1capture/put/responses/400/content/application~1json/examples/missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1capture/put/responses/400/content/application~1json/examples/missing"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1capture/put/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1capture/put/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1capture/put/responses/404/content/application~1json/examples/missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1capture/put/responses/404/content/application~1json/examples/missing"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/capturepayment"}],"panels":[]}]},"httpPath":"/payments/capture"},{"label":"Void a transaction","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/payments/payments/voidpayment","routeSlug":"/apis/v2/payments/payments/voidpayment","metadata":{"seo":{"title":"Void a transaction","description":"Releases an authorization so no money moves. Only a transaction withstatus: AUTHORISED can be voided, and the whole hold is released. Asale or a captured authorization cannot be voided; refund it instead.Any other status returns 404."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"voidPayment","name":"Void a transaction","isWebhook":false,"pointer":"/paths/~1payments~1void/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Void a transaction","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":"Releases an authorization so no money moves. Only a transaction with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: AUTHORISED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be voided, and the whole hold is released. A"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sale or a captured authorization cannot be voided; refund it instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any other status returns "},"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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionAction"}},"schemaId":"components/schemas/TransactionAction","pointer":"/paths/~1payments~1void/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/payments/void","servers":[{"url":"/_mock/apis/v2/payments","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/TransactionAction"}},"responseCodes":["200","400","401","404"],"pointer":"/payments/void","href":"payments/voidpayment","openApiOperationId":"voidPayment","summary":"Void a transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/v2/payments","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"schemaId":"components/schemas/TransactionAction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionAction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The resulting transaction.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1void/put/responses/200/content/application~1json/examples/sale","paths/~1payments~1void/put/responses/200/content/application~1json/examples/auth","paths/~1payments~1void/put/responses/200/content/application~1json/examples/capture","paths/~1payments~1void/put/responses/200/content/application~1json/examples/void","paths/~1payments~1void/put/responses/200/content/application~1json/examples/refund"]}},"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1void/put/responses/200/content/application~1json/examples/sale","paths/~1payments~1void/put/responses/200/content/application~1json/examples/auth","paths/~1payments~1void/put/responses/200/content/application~1json/examples/capture","paths/~1payments~1void/put/responses/200/content/application~1json/examples/void","paths/~1payments~1void/put/responses/200/content/application~1json/examples/refund"]},{"code":"400","description":"The request was rejected.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1void/put/responses/400/content/application~1json/examples/missing"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1void/put/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/~1payments~1void/put/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1void/put/responses/401/content/application~1json/examples/unauthorized"]},{"code":"404","description":"No such transaction for this merchant.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1void/put/responses/404/content/application~1json/examples/missing"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1void/put/responses/404/content/application~1json/examples/missing"]}],"pointer":"/paths/~1payments~1void/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1void/put/responses/200/content/application~1json/examples/sale","paths/~1payments~1void/put/responses/200/content/application~1json/examples/auth","paths/~1payments~1void/put/responses/200/content/application~1json/examples/capture","paths/~1payments~1void/put/responses/200/content/application~1json/examples/void","paths/~1payments~1void/put/responses/200/content/application~1json/examples/refund"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1void/put/responses/200/content/application~1json/examples/sale","paths/~1payments~1void/put/responses/200/content/application~1json/examples/auth","paths/~1payments~1void/put/responses/200/content/application~1json/examples/capture","paths/~1payments~1void/put/responses/200/content/application~1json/examples/void","paths/~1payments~1void/put/responses/200/content/application~1json/examples/refund"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1void/put/responses/400/content/application~1json/examples/missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1void/put/responses/400/content/application~1json/examples/missing"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1void/put/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1void/put/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1void/put/responses/404/content/application~1json/examples/missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1void/put/responses/404/content/application~1json/examples/missing"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/voidpayment"}],"panels":[]}]},"httpPath":"/payments/void"},{"label":"Refund a transaction","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/payments/payments/refundpayment","routeSlug":"/apis/v2/payments/payments/refundpayment","metadata":{"seo":{"title":"Refund a transaction","description":"Refunds a completed transaction. Omit amount for a full refund, orsend amount for a partial refund. You can make several partialrefunds until the full amount is refunded."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"refundPayment","name":"Refund a transaction","isWebhook":false,"pointer":"/paths/~1payments~1refund/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund a transaction","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":"Refunds a completed transaction. Omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a full refund, or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a partial refund. You can make several partial"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refunds until the full amount is refunded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each refund creates a new transaction, and that new transaction is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"what this endpoint returns: its own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the refunded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTIAL_REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_transaction_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pointing at the original. The original keeps"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: COMPLETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refunded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once it is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fully refunded. Refunding more than remains returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402"},"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":"code","inline":true,"attributes":{"content":"refund_fees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provides a breakdown of the costs associated with a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund, including the amount deducted from the merchant's wallet, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"original processing fees returned, and the platform's refund fee."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This breakdown is recorded shortly after the refund is processed, so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund_fees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may initially be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response. To retrieve the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"breakdown, make a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /transactions/{token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request. It is usually"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available within 15 to 30 seconds of the refund."},"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/RefundRequest","exampleIds":["paths/~1payments~1refund/put/requestBody/content/application~1json/examples/partial"]}},"schemaId":"components/schemas/RefundRequest","exampleIds":["paths/~1payments~1refund/put/requestBody/content/application~1json/examples/partial"],"pointer":"/paths/~1payments~1refund/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/payments/refund","servers":[{"url":"/_mock/apis/v2/payments","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/RefundRequest","exampleIds":["paths/~1payments~1refund/put/requestBody/content/application~1json/examples/partial"]}},"responseCodes":["200","400","401","402","404"],"pointer":"/payments/refund","href":"payments/refundpayment","openApiOperationId":"refundPayment","summary":"Refund a transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/v2/payments","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"schemaId":"components/schemas/RefundRequest","exampleIds":["paths/~1payments~1refund/put/requestBody/content/application~1json/examples/partial"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundRequest","exampleIds":["paths/~1payments~1refund/put/requestBody/content/application~1json/examples/partial"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The resulting transaction.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1refund/put/responses/200/content/application~1json/examples/sale","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/auth","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/capture","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/void","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/refund"]}},"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1refund/put/responses/200/content/application~1json/examples/sale","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/auth","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/capture","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/void","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/refund"]},{"code":"400","description":"The request was rejected.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/responses/400/content/application~1json/examples/missing"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/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/~1payments~1refund/put/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/responses/401/content/application~1json/examples/unauthorized"]},{"code":"402","description":"The refund was rejected, for example because more than the remaining amount was requested.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/responses/402/content/application~1json/examples/overRefund"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/responses/402/content/application~1json/examples/overRefund"]},{"code":"404","description":"No such transaction for this merchant.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/responses/404/content/application~1json/examples/missing"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/responses/404/content/application~1json/examples/missing"]}],"pointer":"/paths/~1payments~1refund/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1refund/put/responses/200/content/application~1json/examples/sale","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/auth","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/capture","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/void","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/refund"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResult","exampleIds":["paths/~1payments~1refund/put/responses/200/content/application~1json/examples/sale","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/auth","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/capture","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/void","paths/~1payments~1refund/put/responses/200/content/application~1json/examples/refund"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/responses/400/content/application~1json/examples/missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/responses/400/content/application~1json/examples/missing"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"402","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/responses/402/content/application~1json/examples/overRefund"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/responses/402/content/application~1json/examples/overRefund"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/responses/404/content/application~1json/examples/missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payments~1refund/put/responses/404/content/application~1json/examples/missing"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/refundpayment"}],"panels":[]}]},"httpPath":"/payments/refund"}],"content":{"contentType":"group","meta":{"name":"Payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payments","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payments/hosted-page","summary":"Create a hosted payment page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/createhostedpage","deprecated":false},{"title":"/payments/sale","summary":"Charge a card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/salepayment","deprecated":false},{"title":"/payments/auth","summary":"Authorize a card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/authorizepayment","deprecated":false},{"title":"/payments/capture","summary":"Capture an authorization","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payments/capturepayment","deprecated":false},{"title":"/payments/void","summary":"Void a transaction","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payments/voidpayment","deprecated":false},{"title":"/payments/refund","summary":"Refund a transaction","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payments/refundpayment","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/HostedPageResult":{"id":"components/schemas/HostedPageResult","kind":"json-schema","title":"HostedPageResult","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A trimmed view of the created order. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full order object; this endpoint returns only what a redirect flow"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"needs. The payment page is "},"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":"."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"Prefixed order identifier. Correlate this against your own records.","example":"ord_b77e80d5-db7d-4865-b946-a0ba19fbb3c4"},"object":{"type":"string","const":"order","example":"order"},"token":{"type":"string","description":"Public token. Appears in the Dime-hosted checkout URL.","example":"o9gUHb9p1xbv-KuB"},"currency":{"$ref":"#/components/schemas/Currency"},"checkout_url":{"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, 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, this is the Dime payment page,"},"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":")."},"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 when you sent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkoutUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; use the payment page URL built from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://example.com/cart"},"created_at":{"type":"string","format":"date-time","example":"2026-09-10T18:59:55.676Z"}}}},"components/schemas/ChargeRequest":{"id":"components/schemas/ChargeRequest","kind":"json-schema","title":"ChargeRequest","data":{"type":"object","required":["token","id","currency","subtotal","total","tax","email","ipAddress","referenceTransactionId"],"properties":{"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card token: the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /cards/{card_request_token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Starts with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"card_Xk3m9QpL2vR7tYw"},"id":{"type":"string","maxLength":100,"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 this charge creates, up to 100 characters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matched by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders?origin_id="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so you can check whether a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge went through before retrying."},"children":[]}]}]}],"example":"3f8a1e02-9c4d-4b71-a5e3-6d2f0b8c7a19"},"currency":{"$ref":"#/components/schemas/Currency"},"subtotal":{"type":"number","minimum":0,"example":1000},"total":{"type":"number","minimum":0,"example":1100},"tax":{"type":"number","minimum":0,"example":100},"discount":{"type":"number","minimum":0,"example":0},"email":{"type":"string","format":"email","example":"buyer@example.com"},"ipAddress":{"type":"string","description":"The buyer's IP, required by the processor for risk scoring.","example":"198.51.100.10"},"referenceTransactionId":{"type":"string","example":"order-1024"},"orderComments":{"type":"string","maxLength":1000,"example":"Leave at the door."},"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 this charge creates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders/{token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Dime does not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read 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"}},"items":{"type":"array","description":"Line items recorded on the order. Required for a Dime Bridge split.","items":{"$ref":"#/components/schemas/LineItemInput"}},"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 charge 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"}}}}},"components/schemas/TransactionAction":{"id":"components/schemas/TransactionAction","kind":"json-schema","title":"TransactionAction","data":{"type":"object","description":"Body for capture and void. The whole amount is always used.","required":["transaction_id"],"properties":{"transaction_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":"The transaction to act on: its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"txn_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", send"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6689a2b2-8e3a-4701-a0c4-48e7da854e1b"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A prefixed value returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"6689a2b2-8e3a-4701-a0c4-48e7da854e1b"}}}},"components/schemas/RefundRequest":{"id":"components/schemas/RefundRequest","kind":"json-schema","title":"RefundRequest","data":{"type":"object","required":["transaction_id"],"properties":{"transaction_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":"The transaction to refund: its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"txn_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix."},"children":[]}]}]}],"example":"6689a2b2-8e3a-4701-a0c4-48e7da854e1b"},"amount":{"type":"number","exclusiveMinimum":0,"description":"Amount to refund. Omit for a full refund.","example":500}}}},"components/schemas/PaymentResult":{"id":"components/schemas/PaymentResult","kind":"json-schema","title":"PaymentResult","data":{"type":"object","properties":{"id":{"type":"string","example":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b"},"object":{"type":"string","const":"transaction","example":"transaction"},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public token. Use it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /transactions/{token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"tR7kQ2mXz9LpW4vB"},"status":{"$ref":"#/components/schemas/TransactionStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after a sale or capture; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTHORISED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after an auth."},"children":[]}]}]}]},"authorized":{"type":"boolean","example":true},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","example":1100},"fees":{"type":["number","null"],"example":0},"error_code":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response. A decline returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"example":null},"error_message":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]}]}]}],"example":null},"reference_transaction_id":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set when this transaction derives from another, most commonly a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund: the original transaction's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"txn_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a sale or auth. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referenceTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you send"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when charging is not returned here."},"children":[]}]}]}],"example":null},"last_four_digits":{"type":["string","null"],"example":"4242"},"card_scheme":{"type":["string","null"],"example":"VISA"},"order":{"type":["object","null"],"additionalProperties":true},"refund_fees":{"$ref":"#/components/schemas/RefundFees"},"created_at":{"type":"string","format":"date-time","example":"2026-08-26T00:48:52.252Z"}}}},"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/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/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/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/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/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/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","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"}}}}}},"components/schemas/TransactionStatus":{"id":"components/schemas/TransactionStatus","kind":"json-schema","title":"TransactionStatus","data":{"type":"string","enum":["COMPLETE","FAILED","PENDING","AUTHORISED","VOID","REFUND","PARTIAL_REFUND","ABANDONED"],"example":"COMPLETE"}},"components/schemas/RefundFees":{"id":"components/schemas/RefundFees","kind":"json-schema","title":"RefundFees","data":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On a refund transaction, what the refund cost you, as the dashboard"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shows it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on other transactions, and on a refund until its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ledger entries are recorded, usually within 15 seconds of the refund."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /transactions/{token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Amounts have up to four"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decimal places, as the ledger records them."},"children":[]}]}]}],"properties":{"currency":{"type":"string","description":"Currency of your wallet, in which the amounts below are given.","example":"USD"},"refunded":{"type":"number","description":"What the customer got back.","example":46},"merchant_wallet":{"type":"number","description":"Taken from your wallet. The original sale, less the fees you paid on it.","example":43.801},"fee_refund":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original processing fees Dime returned, so the customer gets"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"back what they paid: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refunded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_wallet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when your wallet and the refund are in different currencies."},"children":[]}]}]}],"example":2.199},"platform_refund_fee":{"type":"number","description":"The refund fee charged to your wallet.","example":0.35},"total_refund_cost":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refunded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform_refund_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":46.35}}}}},"exampleStore":{"paths/~1payments~1hosted-page/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","checkoutUrl":"https://example.com/cart","items":[{"name":"Sample Item","price":1100,"quantity":1,"sku":"SAMPLE"}]},"key":"simple","summary":"A one-item order","id":"paths/~1payments~1hosted-page/post/requestBody/content/application~1json/examples/simple"},"paths/~1payments~1hosted-page/post/responses/201/content/application~1json/examples/created":{"value":{"id":"ord_b77e80d5-db7d-4865-b946-a0ba19fbb3c4","object":"order","token":"o9gUHb9p1xbv-KuB","currency":"JMD","checkout_url":"https://example.com/cart","created_at":"2026-09-10T18:59:55.676Z"},"key":"created","summary":"created","id":"paths/~1payments~1hosted-page/post/responses/201/content/application~1json/examples/created"},"paths/~1payments~1hosted-page/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/~1payments~1hosted-page/post/responses/400/content/application~1json/examples/missing"},"paths/~1payments~1hosted-page/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/~1payments~1hosted-page/post/responses/401/content/application~1json/examples/unauthorized"},"paths/~1payments~1sale/post/requestBody/content/application~1json/examples/sale":{"value":{"token":"card_Xk3m9QpL2vR7tYw","id":"3f8a1e02-9c4d-4b71-a5e3-6d2f0b8c7a19","currency":"JMD","subtotal":1000,"total":1100,"tax":100,"email":"buyer@example.com","ipAddress":"198.51.100.10","referenceTransactionId":"sale-1024"},"key":"sale","summary":"sale","id":"paths/~1payments~1sale/post/requestBody/content/application~1json/examples/sale"},"paths/~1payments~1sale/post/requestBody/content/application~1json/examples/bridge":{"value":{"token":"card_Xk3m9QpL2vR7tYw","id":"9d2b7c54-1e8f-4a36-b7c1-5f0e2d8a4c13","currency":"USD","subtotal":2000,"total":2000,"tax":0,"email":"buyer@example.com","ipAddress":"198.51.100.10","referenceTransactionId":"sale-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 charge 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/~1payments~1sale/post/requestBody/content/application~1json/examples/bridge"},"paths/~1payments~1sale/post/responses/200/content/application~1json/examples/sale":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"COMPLETE","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"sale","summary":"Sale: charged and captured; the order is now COMPLETE","id":"paths/~1payments~1sale/post/responses/200/content/application~1json/examples/sale"},"paths/~1payments~1sale/post/responses/200/content/application~1json/examples/auth":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"AUTHORISED","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"PENDING","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"auth","summary":"Auth: funds held, not yet captured","id":"paths/~1payments~1sale/post/responses/200/content/application~1json/examples/auth"},"paths/~1payments~1sale/post/responses/200/content/application~1json/examples/capture":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"COMPLETE","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"capture","summary":"Capture of an earlier auth","id":"paths/~1payments~1sale/post/responses/200/content/application~1json/examples/capture"},"paths/~1payments~1sale/post/responses/200/content/application~1json/examples/void":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"VOID","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"VOIDED","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"void","summary":"Void of an uncaptured auth","id":"paths/~1payments~1sale/post/responses/200/content/application~1json/examples/void"},"paths/~1payments~1sale/post/responses/200/content/application~1json/examples/refund":{"value":{"id":"txn_a4c1d2e3-5f6a-4b7c-8d9e-0f1a2b3c4d5e","object":"transaction","token":"tM3nP8qRz2LwX6vK","status":"PARTIAL_REFUND","authorized":true,"currency":"JMD","amount":500,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":"6689a2b2-8e3a-4701-a0c4-48e7da854e1b","last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"refund","summary":"Partial refund: the new refund transaction, pointing back at the original","id":"paths/~1payments~1sale/post/responses/200/content/application~1json/examples/refund"},"paths/~1payments~1sale/post/responses/400/content/application~1json/examples/unknownCard":{"value":{"error":{"type":"invalid_request_error","code":"parameter_invalid","message":"No such card token.","param":"token"}},"key":"unknownCard","summary":"The card token does not exist","id":"paths/~1payments~1sale/post/responses/400/content/application~1json/examples/unknownCard"},"paths/~1payments~1sale/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/~1payments~1sale/post/responses/400/content/application~1json/examples/bridgeNotEnabled"},"paths/~1payments~1sale/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/~1payments~1sale/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch"},"paths/~1payments~1sale/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/~1payments~1sale/post/responses/401/content/application~1json/examples/unauthorized"},"paths/~1payments~1sale/post/responses/402/content/application~1json/examples/declined":{"value":{"error":{"type":"card_error","code":"card_declined","message":"Payment was declined.","param":"token"}},"key":"declined","summary":"declined","id":"paths/~1payments~1sale/post/responses/402/content/application~1json/examples/declined"},"paths/~1payments~1sale/post/responses/500/content/application~1json/examples/unavailable":{"value":{"error":{"type":"api_error","code":"internal_error","message":"The payment processor did not respond."}},"key":"unavailable","summary":"unavailable","id":"paths/~1payments~1sale/post/responses/500/content/application~1json/examples/unavailable"},"paths/~1payments~1auth/post/responses/200/content/application~1json/examples/sale":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"COMPLETE","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"sale","summary":"Sale: charged and captured; the order is now COMPLETE","id":"paths/~1payments~1auth/post/responses/200/content/application~1json/examples/sale"},"paths/~1payments~1auth/post/responses/200/content/application~1json/examples/auth":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"AUTHORISED","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"PENDING","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"auth","summary":"Auth: funds held, not yet captured","id":"paths/~1payments~1auth/post/responses/200/content/application~1json/examples/auth"},"paths/~1payments~1auth/post/responses/200/content/application~1json/examples/capture":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"COMPLETE","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"capture","summary":"Capture of an earlier auth","id":"paths/~1payments~1auth/post/responses/200/content/application~1json/examples/capture"},"paths/~1payments~1auth/post/responses/200/content/application~1json/examples/void":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"VOID","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"VOIDED","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"void","summary":"Void of an uncaptured auth","id":"paths/~1payments~1auth/post/responses/200/content/application~1json/examples/void"},"paths/~1payments~1auth/post/responses/200/content/application~1json/examples/refund":{"value":{"id":"txn_a4c1d2e3-5f6a-4b7c-8d9e-0f1a2b3c4d5e","object":"transaction","token":"tM3nP8qRz2LwX6vK","status":"PARTIAL_REFUND","authorized":true,"currency":"JMD","amount":500,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":"6689a2b2-8e3a-4701-a0c4-48e7da854e1b","last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"refund","summary":"Partial refund: the new refund transaction, pointing back at the original","id":"paths/~1payments~1auth/post/responses/200/content/application~1json/examples/refund"},"paths/~1payments~1auth/post/responses/400/content/application~1json/examples/unknownCard":{"value":{"error":{"type":"invalid_request_error","code":"parameter_invalid","message":"No such card token.","param":"token"}},"key":"unknownCard","summary":"The card token does not exist","id":"paths/~1payments~1auth/post/responses/400/content/application~1json/examples/unknownCard"},"paths/~1payments~1auth/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/~1payments~1auth/post/responses/400/content/application~1json/examples/bridgeNotEnabled"},"paths/~1payments~1auth/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/~1payments~1auth/post/responses/400/content/application~1json/examples/bridgeTotalsMismatch"},"paths/~1payments~1auth/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/~1payments~1auth/post/responses/401/content/application~1json/examples/unauthorized"},"paths/~1payments~1auth/post/responses/402/content/application~1json/examples/declined":{"value":{"error":{"type":"card_error","code":"card_declined","message":"Payment was declined.","param":"token"}},"key":"declined","summary":"declined","id":"paths/~1payments~1auth/post/responses/402/content/application~1json/examples/declined"},"paths/~1payments~1auth/post/responses/500/content/application~1json/examples/unavailable":{"value":{"error":{"type":"api_error","code":"internal_error","message":"The payment processor did not respond."}},"key":"unavailable","summary":"unavailable","id":"paths/~1payments~1auth/post/responses/500/content/application~1json/examples/unavailable"},"paths/~1payments~1capture/put/responses/200/content/application~1json/examples/sale":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"COMPLETE","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"sale","summary":"Sale: charged and captured; the order is now COMPLETE","id":"paths/~1payments~1capture/put/responses/200/content/application~1json/examples/sale"},"paths/~1payments~1capture/put/responses/200/content/application~1json/examples/auth":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"AUTHORISED","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"PENDING","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"auth","summary":"Auth: funds held, not yet captured","id":"paths/~1payments~1capture/put/responses/200/content/application~1json/examples/auth"},"paths/~1payments~1capture/put/responses/200/content/application~1json/examples/capture":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"COMPLETE","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"capture","summary":"Capture of an earlier auth","id":"paths/~1payments~1capture/put/responses/200/content/application~1json/examples/capture"},"paths/~1payments~1capture/put/responses/200/content/application~1json/examples/void":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"VOID","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"VOIDED","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"void","summary":"Void of an uncaptured auth","id":"paths/~1payments~1capture/put/responses/200/content/application~1json/examples/void"},"paths/~1payments~1capture/put/responses/200/content/application~1json/examples/refund":{"value":{"id":"txn_a4c1d2e3-5f6a-4b7c-8d9e-0f1a2b3c4d5e","object":"transaction","token":"tM3nP8qRz2LwX6vK","status":"PARTIAL_REFUND","authorized":true,"currency":"JMD","amount":500,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":"6689a2b2-8e3a-4701-a0c4-48e7da854e1b","last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"refund","summary":"Partial refund: the new refund transaction, pointing back at the original","id":"paths/~1payments~1capture/put/responses/200/content/application~1json/examples/refund"},"paths/~1payments~1capture/put/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/~1payments~1capture/put/responses/400/content/application~1json/examples/missing"},"paths/~1payments~1capture/put/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/~1payments~1capture/put/responses/401/content/application~1json/examples/unauthorized"},"paths/~1payments~1capture/put/responses/404/content/application~1json/examples/missing":{"value":{"error":{"type":"invalid_request_error","code":"resource_missing","message":"No such transaction: 99999999-9999-4999-8999-999999999999","param":"transaction_id"}},"key":"missing","summary":"missing","id":"paths/~1payments~1capture/put/responses/404/content/application~1json/examples/missing"},"paths/~1payments~1void/put/responses/200/content/application~1json/examples/sale":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"COMPLETE","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"sale","summary":"Sale: charged and captured; the order is now COMPLETE","id":"paths/~1payments~1void/put/responses/200/content/application~1json/examples/sale"},"paths/~1payments~1void/put/responses/200/content/application~1json/examples/auth":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"AUTHORISED","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"PENDING","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"auth","summary":"Auth: funds held, not yet captured","id":"paths/~1payments~1void/put/responses/200/content/application~1json/examples/auth"},"paths/~1payments~1void/put/responses/200/content/application~1json/examples/capture":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"COMPLETE","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"capture","summary":"Capture of an earlier auth","id":"paths/~1payments~1void/put/responses/200/content/application~1json/examples/capture"},"paths/~1payments~1void/put/responses/200/content/application~1json/examples/void":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"VOID","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"VOIDED","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"void","summary":"Void of an uncaptured auth","id":"paths/~1payments~1void/put/responses/200/content/application~1json/examples/void"},"paths/~1payments~1void/put/responses/200/content/application~1json/examples/refund":{"value":{"id":"txn_a4c1d2e3-5f6a-4b7c-8d9e-0f1a2b3c4d5e","object":"transaction","token":"tM3nP8qRz2LwX6vK","status":"PARTIAL_REFUND","authorized":true,"currency":"JMD","amount":500,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":"6689a2b2-8e3a-4701-a0c4-48e7da854e1b","last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"refund","summary":"Partial refund: the new refund transaction, pointing back at the original","id":"paths/~1payments~1void/put/responses/200/content/application~1json/examples/refund"},"paths/~1payments~1void/put/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/~1payments~1void/put/responses/400/content/application~1json/examples/missing"},"paths/~1payments~1void/put/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/~1payments~1void/put/responses/401/content/application~1json/examples/unauthorized"},"paths/~1payments~1void/put/responses/404/content/application~1json/examples/missing":{"value":{"error":{"type":"invalid_request_error","code":"resource_missing","message":"No such transaction: 99999999-9999-4999-8999-999999999999","param":"transaction_id"}},"key":"missing","summary":"missing","id":"paths/~1payments~1void/put/responses/404/content/application~1json/examples/missing"},"paths/~1payments~1refund/put/requestBody/content/application~1json/examples/partial":{"value":{"transaction_id":"6689a2b2-8e3a-4701-a0c4-48e7da854e1b","amount":500},"key":"partial","summary":"Partial refund","id":"paths/~1payments~1refund/put/requestBody/content/application~1json/examples/partial"},"paths/~1payments~1refund/put/responses/200/content/application~1json/examples/sale":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"COMPLETE","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"sale","summary":"Sale: charged and captured; the order is now COMPLETE","id":"paths/~1payments~1refund/put/responses/200/content/application~1json/examples/sale"},"paths/~1payments~1refund/put/responses/200/content/application~1json/examples/auth":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"AUTHORISED","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"PENDING","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"auth","summary":"Auth: funds held, not yet captured","id":"paths/~1payments~1refund/put/responses/200/content/application~1json/examples/auth"},"paths/~1payments~1refund/put/responses/200/content/application~1json/examples/capture":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"COMPLETE","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"capture","summary":"Capture of an earlier auth","id":"paths/~1payments~1refund/put/responses/200/content/application~1json/examples/capture"},"paths/~1payments~1refund/put/responses/200/content/application~1json/examples/void":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"VOID","authorized":true,"currency":"JMD","amount":1100,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":null,"last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"VOIDED","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"void","summary":"Void of an uncaptured auth","id":"paths/~1payments~1refund/put/responses/200/content/application~1json/examples/void"},"paths/~1payments~1refund/put/responses/200/content/application~1json/examples/refund":{"value":{"id":"txn_a4c1d2e3-5f6a-4b7c-8d9e-0f1a2b3c4d5e","object":"transaction","token":"tM3nP8qRz2LwX6vK","status":"PARTIAL_REFUND","authorized":true,"currency":"JMD","amount":500,"fees":null,"error_code":null,"error_message":null,"reference_transaction_id":"6689a2b2-8e3a-4701-a0c4-48e7da854e1b","last_four_digits":"4242","card_scheme":"visa","order":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE","currency":"JMD","total":1100,"subtotal":1000},"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"refund","summary":"Partial refund: the new refund transaction, pointing back at the original","id":"paths/~1payments~1refund/put/responses/200/content/application~1json/examples/refund"},"paths/~1payments~1refund/put/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/~1payments~1refund/put/responses/400/content/application~1json/examples/missing"},"paths/~1payments~1refund/put/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/~1payments~1refund/put/responses/401/content/application~1json/examples/unauthorized"},"paths/~1payments~1refund/put/responses/402/content/application~1json/examples/overRefund":{"value":{"error":{"type":"card_error","code":"card_declined","message":"Refund amount 500.00 exceeds remaining refundable amount 100.00","param":"transaction_id"}},"key":"overRefund","summary":"overRefund","id":"paths/~1payments~1refund/put/responses/402/content/application~1json/examples/overRefund"},"paths/~1payments~1refund/put/responses/404/content/application~1json/examples/missing":{"value":{"error":{"type":"invalid_request_error","code":"resource_missing","message":"No such transaction: 99999999-9999-4999-8999-999999999999","param":"transaction_id"}},"key":"missing","summary":"missing","id":"paths/~1payments~1refund/put/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/payments","isMockServer":true,"description":"Mock server"},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/apis/v2/payments","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/v2/payments.json?download"},{"url":"/_bundle/apis/v2/payments.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Dime Partner API v2 — Payments","description":"Charge a stored card, then capture, void, or refund the resulting\ntransaction.\n\n## Choosing an operation\n\n- **Sale** authorizes and captures in one step.\n- **Authorize** holds the funds; follow with capture to take them, or void\n  to release them.\n- **Refund** returns money after a transaction has settled.\n\nCard tokens come from a verified tokenization request.\n"}},"baseSlug":"/apis/v2/payments","routesMapping":{}}