{"items":[{"type":"link","label":"Dime Partner API v2 — Transactions","link":"/apis/v2/transactions","routeSlug":"/apis/v2/transactions","content":{"contentType":"overview","meta":{"name":"Dime Partner API v2 — Transactions"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"transactions.json","url":"/_bundle/apis/v2/transactions.json?download"},{"kind":"download","label":"transactions.yaml","url":"/_bundle/apis/v2/transactions.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/transactions","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 — Transactions (2.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Transactions are the record of money moving. Each one settles against an\nentity such as an order, an invoice, or a point-of-sale sale."}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Transactions","link":"/apis/v2/transactions/transactions","routeSlug":"/apis/v2/transactions/transactions","items":[{"label":"List transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/transactions/transactions/listtransactions","routeSlug":"/apis/v2/transactions/transactions/listtransactions","metadata":{"seo":{"title":"List transactions","description":"Returns your transactions, newest first. Cursor-paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTransactions","name":"List transactions","isWebhook":false,"pointer":"/paths/~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your transactions, newest first. Cursor-paginated.\n\nAn unrecognized filter value is rejected rather than silently returning\nnothing.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientKey","scopes":[],"type":"apiKey","in":"header","paramName":"client_key","description":"Your partner API key. Use a sandbox key when testing."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How many records to return, 1–100."},"children":[]}]}]}]},{"name":"starting_after","in":"query","schemaId":"schema_1","description":"Return records after this id. Use the last id of the previous page to\nwalk forward.\n"},{"name":"ending_before","in":"query","schemaId":"schema_1","description":"Return records before this id, to walk backward."},{"name":"status","in":"query","schemaId":"schema_2"},{"name":"entity_type","in":"query","schemaId":"schema_3","description":"What the transaction settled against."},{"name":"currency","in":"query","schemaId":"schema_4"},{"name":"subscription","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters to transactions billed against this subscription, by its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An unknown token returns an empty page."},"children":[]}]}]}],"example":"subV1StGXR8_Z5jdHi"},{"name":"order_id","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own identifier for the order this transaction settled"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"against, the same value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"origin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters by on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not unique, so a match can span more than one order's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactions."},"children":[]}]}]}],"example":"order-1024"},{"name":"customer_name","in":"query","schemaId":"schema_1","description":"Matches against the customer's full name or either half of it,\ncase-insensitively, as a substring.\n","example":"Jane"},{"name":"card_scheme","in":"query","schemaId":"schema_1","description":"Matches the card scheme used, e.g. VISA.","example":"VISA"},{"name":"last_four_digits","in":"query","schemaId":"schema_1","description":"Matches the last four digits of the card used.","example":"4242"}],"pointer":"/paths/~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions","servers":[{"url":"/_mock/apis/v2/transactions","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_0"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_1"},{"name":"ending_before","in":"query","required":false,"schemaId":"schema_1"},{"name":"status","in":"query","example":"COMPLETE","schemaId":"components/schemas/TransactionStatus"},{"name":"entity_type","in":"query","schemaId":"components/schemas/EntityType"},{"name":"currency","in":"query","example":"JMD","schemaId":"components/schemas/Currency"},{"name":"subscription","in":"query","example":"subV1StGXR8_Z5jdHi","schemaId":"schema_1"},{"name":"order_id","in":"query","example":"order-1024","schemaId":"schema_1"},{"name":"customer_name","in":"query","example":"Jane","schemaId":"schema_1"},{"name":"card_scheme","in":"query","example":"VISA","schemaId":"schema_1"},{"name":"last_four_digits","in":"query","example":"4242","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientKey","type":"apiKey","name":"client_key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/transactions","href":"transactions/listtransactions","openApiOperationId":"listTransactions","summary":"List transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/v2/transactions","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A page of transactions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1transactions/get/responses/200/content/application~1json/examples/page"]}},"schemaId":"schema_5","exampleIds":["paths/~1transactions/get/responses/200/content/application~1json/examples/page"]},{"code":"400","description":"A filter value was not recognized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1transactions/get/responses/400/content/application~1json/examples/badStatus"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1transactions/get/responses/400/content/application~1json/examples/badStatus"]},{"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/~1transactions/get/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1transactions/get/responses/401/content/application~1json/examples/unauthorized"]}],"pointer":"/paths/~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_5","exampleIds":["paths/~1transactions/get/responses/200/content/application~1json/examples/page"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1transactions/get/responses/200/content/application~1json/examples/page"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1transactions/get/responses/400/content/application~1json/examples/badStatus"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1transactions/get/responses/400/content/application~1json/examples/badStatus"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1transactions/get/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1transactions/get/responses/401/content/application~1json/examples/unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/listtransactions"}],"panels":[]}]},"httpPath":"/transactions"},{"label":"Retrieve a transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/transactions/transactions/retrievetransaction","routeSlug":"/apis/v2/transactions/transactions/retrievetransaction","metadata":{"seo":{"title":"Retrieve a transaction","description":"Takes the transaction's token. It is in every transaction object:the response to a sale, auth, capture, void or refund, the listendpoint, a chargeback's transaction_token, and a webhook'spayload.transaction.token. A token that matches no transactionreturns 404."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveTransaction","name":"Retrieve a transaction","isWebhook":false,"pointer":"/paths/~1transactions~1{token}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve 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":"Takes the transaction's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It is in every transaction object:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the response to a sale, auth, capture, void or refund, the list"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint, a chargeback's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and a webhook's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload.transaction.token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A token that matches no transaction"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token","in":"path","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"tR7kQ2mXz9LpW4vB"}],"pointer":"/paths/~1transactions~1{token}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions/{token}","servers":[{"url":"/_mock/apis/v2/transactions","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"parameters":{"path":[{"name":"token","in":"path","required":true,"example":"tR7kQ2mXz9LpW4vB","schemaId":"schema_1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientKey","type":"apiKey","name":"client_key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/transactions/{token}","href":"transactions/retrievetransaction","openApiOperationId":"retrieveTransaction","summary":"Retrieve a transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/v2/transactions","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The transaction.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction","exampleIds":["paths/~1transactions~1{token}/get/responses/200/content/application~1json/examples/transaction"]}},"schemaId":"components/schemas/Transaction","exampleIds":["paths/~1transactions~1{token}/get/responses/200/content/application~1json/examples/transaction"]},{"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/~1transactions~1{token}/get/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1transactions~1{token}/get/responses/401/content/application~1json/examples/unauthorized"]},{"code":"404","description":"No record matches the id or token in the request. Check that you are\nusing the right kind of identifier for this endpoint.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1transactions~1{token}/get/responses/404/content/application~1json/examples/missing"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1transactions~1{token}/get/responses/404/content/application~1json/examples/missing"]}],"pointer":"/paths/~1transactions~1{token}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transaction","exampleIds":["paths/~1transactions~1{token}/get/responses/200/content/application~1json/examples/transaction"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction","exampleIds":["paths/~1transactions~1{token}/get/responses/200/content/application~1json/examples/transaction"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1transactions~1{token}/get/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1transactions~1{token}/get/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1transactions~1{token}/get/responses/404/content/application~1json/examples/missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1transactions~1{token}/get/responses/404/content/application~1json/examples/missing"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/retrievetransaction"}],"panels":[]}]},"httpPath":"/transactions/{token}"}],"content":{"contentType":"group","meta":{"name":"Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transactions","summary":"List transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/listtransactions","deprecated":false},{"title":"/transactions/{token}","summary":"Retrieve a transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/retrievetransaction","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"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/EntityType":{"id":"components/schemas/EntityType","kind":"json-schema","title":"EntityType","data":{"type":"string","enum":["TRANSFER","INVOICE","ORDER","BILL","POS","PRODUCT"]}},"components/schemas/Transaction":{"id":"components/schemas/Transaction","kind":"json-schema","title":"Transaction","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":"Public token. Use it to address the transaction in URLs.","example":"tR7kQ2mXz9LpW4vB"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","description":"The amount requested.","example":1100},"final_amount":{"type":["number","null"],"description":"The amount actually settled, after fees and adjustments.","example":1100},"consumer_fee":{"type":["number","null"],"example":0},"tip_value":{"type":["number","null"],"example":1.23},"fees":{"type":["number","null"],"description":"Total processing fee charged on this transaction, in the currency's major unit.","example":38.5},"source":{"type":["string","null"],"description":"How the payment was taken.","example":"example"},"description":{"type":["string","null"],"example":"A short description."},"authorized":{"type":"boolean","example":true},"captured":{"type":"boolean","example":true},"refunded":{"type":"boolean","example":true},"voided":{"type":"boolean","example":true},"settled":{"type":"boolean","example":true},"last_four_digits":{"type":["string","null"],"example":"4242"},"card_scheme":{"type":["string","null"],"example":"VISA"},"customer_id":{"type":["string","null"],"example":"3f8a1e02-9c4d-4b71-a5e3-6d2f0b8c7a19"},"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},"subscription":{"type":["string","null"],"description":"The subscription this transaction was billed against, when there is one.","example":"sub_3f8a1e02-9c4d-4b71-a5e3-6d2f0b8c7a19"},"entity":{"type":["object","null"],"description":"What this transaction settled against.","additionalProperties":true},"error_code":{"type":["string","null"],"example":"parameter_missing"},"error_message":{"type":["string","null"],"example":"Order ID is required."},"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/ListEnvelope":{"id":"components/schemas/ListEnvelope","kind":"json-schema","title":"ListEnvelope","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists are cursor-paginated. There is no total count: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_more"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reports"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whether another page exists."},"children":[]}]}]}],"required":["object","data","has_more"],"properties":{"object":{"type":"string","const":"list","example":"list"},"data":{"type":"array","items":{}},"has_more":{"type":"boolean","example":true}}}},"components/schemas/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}}}},"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"}}}}}},"schema_0":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":10},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TransactionStatus"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EntityType"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Currency"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListEnvelope"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}}}}]},"id":"schema_5"}},"exampleStore":{"paths/~1transactions/get/responses/200/content/application~1json/examples/page":{"value":{"object":"list","data":[{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"COMPLETE","currency":"JMD","amount":1100,"final_amount":1100,"consumer_fee":null,"tip_value":null,"fees":38.5,"source":"API","description":null,"authorized":true,"captured":true,"refunded":false,"voided":false,"settled":false,"last_four_digits":"4242","card_scheme":"visa","customer_id":"cus_3f8a1e02-9c4d-4b71-a5e3-6d2f0b8c7a19","reference_transaction_id":null,"subscription":null,"entity":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","object":"order","token":null,"status":null},"error_code":null,"error_message":null,"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"}],"has_more":false},"key":"page","summary":"A page of transactions; entity token and status are only loaded on retrieve","id":"paths/~1transactions/get/responses/200/content/application~1json/examples/page"},"paths/~1transactions/get/responses/400/content/application~1json/examples/badStatus":{"value":{"error":{"type":"invalid_request_error","code":"parameter_invalid","message":"status must be one of: COMPLETE, FAILED, PENDING, AUTHORISED, VOID, REFUND, PARTIAL_REFUND, ABANDONED.","param":"status"}},"key":"badStatus","summary":"badStatus","id":"paths/~1transactions/get/responses/400/content/application~1json/examples/badStatus"},"paths/~1transactions/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"error":{"type":"invalid_request_error","code":"unauthorized","message":"No API key provided."}},"key":"unauthorized","summary":"unauthorized","id":"paths/~1transactions/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1transactions~1{token}/get/responses/200/content/application~1json/examples/transaction":{"value":{"id":"txn_6689a2b2-8e3a-4701-a0c4-48e7da854e1b","object":"transaction","token":"tR7kQ2mXz9LpW4vB","status":"COMPLETE","currency":"JMD","amount":1100,"final_amount":1100,"consumer_fee":null,"tip_value":null,"fees":38.5,"source":"API","description":null,"authorized":true,"captured":true,"refunded":false,"voided":false,"settled":false,"last_four_digits":"4242","card_scheme":"visa","customer_id":"cus_3f8a1e02-9c4d-4b71-a5e3-6d2f0b8c7a19","reference_transaction_id":null,"subscription":null,"entity":{"id":"ord_30800d0f-da91-4c38-9ec2-1016c27f8209","object":"order","token":"ob9gWGGx5ACvn6KU","status":"COMPLETE"},"error_code":null,"error_message":null,"refund_fees":null,"created_at":"2026-10-27T15:04:05.000Z"},"key":"transaction","summary":"A captured card sale against an order","id":"paths/~1transactions~1{token}/get/responses/200/content/application~1json/examples/transaction"},"paths/~1transactions~1{token}/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"error":{"type":"invalid_request_error","code":"unauthorized","message":"No API key provided."}},"key":"unauthorized","summary":"unauthorized","id":"paths/~1transactions~1{token}/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1transactions~1{token}/get/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":"id"}},"key":"missing","summary":"missing","id":"paths/~1transactions~1{token}/get/responses/404/content/application~1json/examples/missing"}},"securitySchemeStore":{"ClientKey":{"id":"ClientKey","type":"apiKey","description":"Your partner API key. Use a sandbox key when testing.","in":"header","paramName":"client_key"}},"specVersion":"3.1.0","servers":[{"url":"/_mock/apis/v2/transactions","isMockServer":true,"description":"Mock server"},{"url":"https://sandbox.api.dimepay.app/dapi/v2"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/apis/v2/transactions","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/v2/transactions.json?download"},{"url":"/_bundle/apis/v2/transactions.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Dime Partner API v2 — Transactions","description":"Transactions are the record of money moving. Each one settles against an\nentity such as an order, an invoice, or a point-of-sale sale.\n"}},"baseSlug":"/apis/v2/transactions","routesMapping":{}}