{"items":[{"type":"link","label":"Trustap API","link":"/apis/openapi","routeSlug":"/apis/openapi","content":{"contentType":"overview","meta":{"name":"Trustap API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/apis/@v2.0/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/apis/@v2.0/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"E-mail","titleTranslationKey":"info.contact.name","email":"support@trustap.com","label":"support@trustap.com","withCopyButton":true,"copyContent":"support@trustap.com"}]},{"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":"https://api.test.trustap.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Trustap API (2.0.1)","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":"The Trustap API is a REST-based API for managing user data and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactions for Trustap users."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that, like Stripe, all API "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields expect"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amounts to be provided in a currency's smallest unit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://stripe.com/docs/currencies#zero-decimal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Stripe"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some endpoints such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints can be accessed directly"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"using an API key. API keys are provided as the \"username\" portion of a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"basic auth authentication. For example, the Trustap fee for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction can be determined using the following cURL request with an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -i -X GET -u '<API_KEY>:'​ 'https://api.test.trustap.com/v2/fees?currency=usd&amount=896'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -i -X GET -u '<API_KEY>:'​ 'https://api.test.trustap.com/v2/fees?currency=usd&amount=896'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated endpoints are tagged with the word "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the start"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of their description. The deprecation message will describe what"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoints/approach should be used instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that deprecated endpoints will not be removed from the current"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"version of the API, but their use is discouraged. Furthermore, migrating"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to later major versions of the API will be made easier by avoiding"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deprecated endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This documentation references the staging environment of the Trustap"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API, which is available at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.test.trustap.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and uses the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trustap-stage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" realm during authentication. This environment can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used for implementing and testing features using test credit cards, bank"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accounts, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When all features using Trustap have been implemented and tested"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sufficiently, the production environment of the Trustap API can be used"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to process actual currency. This environment is available at"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.trustap.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and uses the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trustap"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" realm during"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only your client ID will be the same in the staging and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production Trustap API environments; your client secret and API key will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be different in the two environments."},"children":[]}]}]}]}],"sectionId":"/apis/openapi"}],"sectionId":"/apis/openapi"}]}]}},{"type":"separator","label":"Users","content":null},{"type":"group","label":"Buyers and Sellers","link":"/apis/openapi/buyers-and-sellers","routeSlug":"/apis/openapi/buyers-and-sellers","items":[{"label":"Create a new guest user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/buyers-and-sellers/v2_users.createguestuser","routeSlug":"/apis/openapi/buyers-and-sellers/v2_users.createguestuser","metadata":{"seo":{"title":"Create a new guest user","description":"This endpoint creates a new guest user which can be used as the buyer or the seller in a transaction. Guest users can be used to create transactions for users that don't yet have login details, or who choose not to use the logged-in user for creating the new transaction. Emails are sent to guest users which will contain details for adding guest transactions to their logged-in profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_users.createGuestUser","name":"Create a new guest user","isWebhook":false,"pointer":"/paths/~1v2~1guest_users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new guest user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint creates a new guest user which can be used as the buyer or\nthe seller in a transaction. Guest users can be used to create transactions\nfor users that don't yet have login details, or who choose not to use the\nlogged-in user for creating the new transaction. Emails are sent to guest\nusers which will contain details for adding guest transactions to their\nlogged-in profile.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_137"}},"schemaId":"schema_137","pointer":"/paths/~1v2~1guest_users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/guest_users","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_137"}},"responseCodes":["201","400"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/guest_users","href":"buyers-and-sellers/v2_users.createguestuser","openApiOperationId":"v2_users.createGuestUser","summary":"Create a new guest user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"schemaId":"schema_137","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_137"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_users.User"}},"schemaId":"components/schemas/v2_users.User"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}},"schemaId":"schema_138"}],"pointer":"/paths/~1v2~1guest_users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/v2_users.User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_users.User"}}},{"code":"400","schemaId":"schema_138","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyers-and-sellers/v2_users.createguestuser"}],"panels":[]}]},"httpPath":"/v2/guest_users"}],"content":{"contentType":"group","meta":{"name":"Buyers and Sellers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Buyers and Sellers","showPageActions":true},{"nodeType":"markdoc","content":"Users represent users of the platform."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/guest_users","summary":"Create a new guest user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyers-and-sellers/v2_users.createguestuser","deprecated":false}]}]}]}]}},{"type":"separator","label":"Payment","content":null},{"type":"group","label":"Payment","link":"/apis/openapi/payment","routeSlug":"/apis/openapi/payment","items":[{"label":"Get the Trustap fee for a transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/payment/v2_transactions.getfees","routeSlug":"/apis/openapi/payment/v2_transactions.getfees","metadata":{"seo":{"title":"Get the Trustap fee for a transaction","description":"This returns the Trustap fee, in the currency's smallest unit,for a transaction involving goods with the supplied amount. Seethe Stripedocumentationfor more details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.getFees","name":"Get the Trustap fee for a transaction","isWebhook":false,"pointer":"/paths/~1v2~1fees/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the Trustap fee for 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":"This returns the Trustap fee, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s smallest unit,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for a transaction involving goods with the supplied "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://stripe.com/docs/currencies#zero-decimal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Stripe"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currency","in":"query","schemaId":"schema_139","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified in."},"children":[]}]}]}],"required":true},{"name":"amount","in":"query","schemaId":"schema_140","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price of the goods being sold in this transaction, in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s smallest unit. For example, if a trading"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card is being sold for $12.34 (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then the request for the fees for this transaction would"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/fees?amount=1234&currency=usd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"amount_extra","in":"query","schemaId":"schema_140","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents an additional charge to be paid by the buyer added"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the transaction total. Use this field to include costs like"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processing fees or local taxes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be an integer provided in the smallest unit of the currency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(for example, 500 for $5.00 USD). Defaults to 0 if not provided."},"children":[]}]}]}]},{"name":"amount_postage","in":"query","schemaId":"schema_140","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents an additional charge to be paid by the buyer, seller or client."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to include costs like shipping surcharges."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be an integer provided in the smallest unit of the currency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(for example, 500 for $5.00 USD)."},"children":[]}]}]}]},{"name":"payment_method","in":"query","schemaId":"schema_141","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment method that will be used to pay for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction. This is necessary because different payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"methods may result in different fees."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank_transfer"},"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":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"fees_config","in":"query","schemaId":"schema_140","description":"The fee config for which the fees are computed.\n"}],"pointer":"/paths/~1v2~1fees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/fees","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[],"query":[{"name":"currency","in":"query","required":true,"schemaId":"schema_139"},{"name":"amount","in":"query","required":true,"schemaId":"schema_140"},{"name":"amount_extra","in":"query","required":false,"schemaId":"schema_140"},{"name":"amount_postage","in":"query","required":false,"schemaId":"schema_140"},{"name":"payment_method","in":"query","required":false,"schemaId":"schema_141"},{"name":"fees_config","in":"query","required":false,"schemaId":"schema_140"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/fees","href":"payment/v2_transactions.getfees","openApiOperationId":"v2_transactions.getFees","summary":"Get the Trustap fee for a transaction","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Fees"}},"schemaId":"components/schemas/v2_transactions.Fees"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}},"schemaId":"schema_142"}],"pointer":"/paths/~1v2~1fees/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.Fees","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Fees"}}},{"code":"400","schemaId":"schema_142","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/v2_transactions.getfees"}],"panels":[]}]},"httpPath":"/v2/fees"},{"label":"Accept the payment for a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/payment/v2_transactions.acceptpaymentfortransaction","routeSlug":"/apis/openapi/payment/v2_transactions.acceptpaymentfortransaction","metadata":{"seo":{"title":"Accept the payment for a transaction","description":"Accept the payment for a transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.acceptPaymentForTransaction","name":"Accept the payment for a transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1accept_payment/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept the payment for a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1accept_payment/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Trustap-User","in":"header","schemaId":"schema_141","description":"Required in client flows, where you make API calls on behalf of another Trustap user."}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1accept_payment/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transaction_id}/accept_payment","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[{"name":"Trustap-User","in":"header","required":false,"schemaId":"schema_141"}],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions/{transaction_id}/accept_payment","href":"payment/v2_transactions.acceptpaymentfortransaction","openApiOperationId":"v2_transactions.acceptPaymentForTransaction","summary":"Accept the payment for a transaction","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1accept_payment/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1accept_payment/post/responses/200/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1accept_payment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1accept_payment/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1accept_payment/post/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/v2_transactions.acceptpaymentfortransaction"}],"panels":[]}]},"httpPath":"/v2/transactions/{transaction_id}/accept_payment"}],"content":{"contentType":"group","meta":{"name":"Payment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment","showPageActions":true},{"nodeType":"markdoc","content":"Payment endpoints for transactions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/fees","summary":"Get the Trustap fee for a transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment/v2_transactions.getfees","deprecated":false},{"title":"/v2/transactions/{transaction_id}/accept_payment","summary":"Accept the payment for a transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/v2_transactions.acceptpaymentfortransaction","deprecated":false}]}]}]}]}},{"type":"separator","label":"Transactions","content":null},{"type":"group","label":"Transactions","link":"/apis/openapi/transactions","routeSlug":"/apis/openapi/transactions","items":[{"label":"Create a new transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/transactions/v2_transactions.createtransaction","routeSlug":"/apis/openapi/transactions/v2_transactions.createtransaction","metadata":{"seo":{"title":"Create a new transaction","description":"Offline access is allowed for this endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.createTransaction","name":"Create a new transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Offline access is allowed for this endpoint.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_143"}},"schemaId":"schema_143","pointer":"/paths/~1v2~1transactions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_143"}},"responseCodes":["201","400"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions","href":"transactions/v2_transactions.createtransaction","openApiOperationId":"v2_transactions.createTransaction","summary":"Create a new transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"schemaId":"schema_143","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_143"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions/post/responses/201/content/application~1json/examples/response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_144"}},"schemaId":"schema_144"}],"pointer":"/paths/~1v2~1transactions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions/post/responses/201/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_144","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_144"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/v2_transactions.createtransaction"}],"panels":[]}]},"httpPath":"/v2/transactions"},{"label":"Get a transaction by its ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/transactions/v2_transactions.gettransaction","routeSlug":"/apis/openapi/transactions/v2_transactions.gettransaction","metadata":{"seo":{"title":"Get a transaction by its ID","description":"Get a transaction by its ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.getTransaction","name":"Get a transaction by its ID","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transaction_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a transaction by its ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/transactions/{transaction_id}","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions/{transaction_id}","href":"transactions/v2_transactions.gettransaction","openApiOperationId":"v2_transactions.getTransaction","summary":"Get a transaction by its ID","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/v2_transactions.gettransaction"}],"panels":[]}]},"httpPath":"/v2/transactions/{transaction_id}"},{"label":"Get the bank transfer details for a transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/transactions/v2_transactions.getbanktransferdetails","routeSlug":"/apis/openapi/transactions/v2_transactions.getbanktransferdetails","metadata":{"seo":{"title":"Get the bank transfer details for a transaction","description":"Get the bank transfer details for a transaction with payment method bank_transfer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.getBankTransferDetails","name":"Get the bank transfer details for a transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1bank_transfer_details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the bank transfer details for 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":"Get the bank transfer details for a transaction with payment method "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank_transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1bank_transfer_details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/transactions/{transaction_id}/bank_transfer_details","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions/{transaction_id}/bank_transfer_details","href":"transactions/v2_transactions.getbanktransferdetails","openApiOperationId":"v2_transactions.getBankTransferDetails","summary":"Get the bank transfer details for a transaction","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.BankTransferDetails"}},"schemaId":"components/schemas/v2_transactions.BankTransferDetails"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_145"}},"schemaId":"schema_145"}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1bank_transfer_details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.BankTransferDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.BankTransferDetails"}}},{"code":"400","schemaId":"schema_145","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_145"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/v2_transactions.getbanktransferdetails"}],"panels":[]}]},"httpPath":"/v2/transactions/{transaction_id}/bank_transfer_details"},{"label":"Get the buyer's contact details for a transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/transactions/v2_transactions.getbuyerdetailsfortransaction","routeSlug":"/apis/openapi/transactions/v2_transactions.getbuyerdetailsfortransaction","metadata":{"seo":{"title":"Get the buyer's contact details for a transaction","description":"Get the buyer's contact details for a transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.getBuyerDetailsForTransaction","name":"Get the buyer's contact details for a transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1buyer_details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the buyer's contact details for a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1buyer_details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/transactions/{transaction_id}/buyer_details","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions/{transaction_id}/buyer_details","href":"transactions/v2_transactions.getbuyerdetailsfortransaction","openApiOperationId":"v2_transactions.getBuyerDetailsForTransaction","summary":"Get the buyer's contact details for a transaction","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.UserDetails"}},"schemaId":"components/schemas/v2_transactions.UserDetails"}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1buyer_details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.UserDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.UserDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/v2_transactions.getbuyerdetailsfortransaction"}],"panels":[]}]},"httpPath":"/v2/transactions/{transaction_id}/buyer_details"},{"label":"Cancel a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/transactions/v2_transactions.canceltransaction","routeSlug":"/apis/openapi/transactions/v2_transactions.canceltransaction","metadata":{"seo":{"title":"Cancel a transaction","description":"Cancel a transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.cancelTransaction","name":"Cancel a transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Trustap-User","in":"header","schemaId":"schema_141","description":"Required in client flows, where you make API calls on behalf of another Trustap user."}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_146"}},"schemaId":"schema_146","pointer":"/paths/~1v2~1transactions~1{transaction_id}~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transaction_id}/cancel","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[{"name":"Trustap-User","in":"header","required":false,"schemaId":"schema_141"}],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_146"}},"responseCodes":["200","400"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions/{transaction_id}/cancel","href":"transactions/v2_transactions.canceltransaction","openApiOperationId":"v2_transactions.cancelTransaction","summary":"Cancel a transaction","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"schemaId":"schema_146","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_146"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1cancel/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1cancel/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_147"}},"schemaId":"schema_147"}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1cancel/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1cancel/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_147","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_147"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/v2_transactions.canceltransaction"}],"panels":[]}]},"httpPath":"/v2/transactions/{transaction_id}/cancel"},{"label":"Claim a transaction on behalf of a Trustap user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/transactions/v2_transactions.claimtransaction","routeSlug":"/apis/openapi/transactions/v2_transactions.claimtransaction","metadata":{"seo":{"title":"Claim a transaction on behalf of a Trustap user","description":"This endpoint enables a client to claim a transaction on behalf of a Trustap user as a buyer or seller. This endpoint can only be accessed by clients."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.claimTransaction","name":"Claim a transaction on behalf of a Trustap user","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1claim/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Claim a transaction on behalf of a Trustap user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint enables a client to claim a transaction on behalf of a\nTrustap user as a buyer or seller. This endpoint can only be accessed\nby clients.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1claim/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Trustap-User","in":"header","schemaId":"schema_141","description":"Required in client flows, where you make API calls on behalf of another Trustap user."}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1claim/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_148"}},"schemaId":"schema_148","pointer":"/paths/~1v2~1transactions~1{transaction_id}~1claim/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transaction_id}/claim","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[{"name":"Trustap-User","in":"header","required":false,"schemaId":"schema_141"}],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_148"}},"responseCodes":["200","400"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions/{transaction_id}/claim","href":"transactions/v2_transactions.claimtransaction","openApiOperationId":"v2_transactions.claimTransaction","summary":"Claim a transaction on behalf of a Trustap user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"schemaId":"schema_148","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_148"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1claim/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1claim/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_149"}},"schemaId":"schema_149"}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1claim/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1claim/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1claim/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_149","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_149"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/v2_transactions.claimtransaction"}],"panels":[]}]},"httpPath":"/v2/transactions/{transaction_id}/claim"},{"label":"Set metadata for a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/transactions/v2_transactions.settransactionmetadata","routeSlug":"/apis/openapi/transactions/v2_transactions.settransactionmetadata","metadata":{"seo":{"title":"Set metadata for a transaction","description":"Set metadata for a transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.setTransactionMetadata","name":"Set metadata for a transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1metadata/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set metadata for a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1metadata/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_150"}},"schemaId":"schema_150","pointer":"/paths/~1v2~1transactions~1{transaction_id}~1metadata/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transaction_id}/metadata","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_150"}},"responseCodes":["200","400"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions/{transaction_id}/metadata","href":"transactions/v2_transactions.settransactionmetadata","openApiOperationId":"v2_transactions.setTransactionMetadata","summary":"Set metadata for a transaction","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"schemaId":"schema_150","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_150"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1metadata/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1metadata/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_151"}},"schemaId":"schema_151"}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1metadata/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1metadata/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1metadata/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_151","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_151"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/v2_transactions.settransactionmetadata"}],"panels":[]}]},"httpPath":"/v2/transactions/{transaction_id}/metadata"}],"content":{"contentType":"group","meta":{"name":"Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for creating and managing transactions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/transactions","summary":"Create a new transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/v2_transactions.createtransaction","deprecated":false},{"title":"/v2/transactions/{transaction_id}","summary":"Get a transaction by its ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/v2_transactions.gettransaction","deprecated":false},{"title":"/v2/transactions/{transaction_id}/bank_transfer_details","summary":"Get the bank transfer details for a transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/v2_transactions.getbanktransferdetails","deprecated":false},{"title":"/v2/transactions/{transaction_id}/buyer_details","summary":"Get the buyer's contact details for a transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/v2_transactions.getbuyerdetailsfortransaction","deprecated":false},{"title":"/v2/transactions/{transaction_id}/cancel","summary":"Cancel a transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/v2_transactions.canceltransaction","deprecated":false},{"title":"/v2/transactions/{transaction_id}/claim","summary":"Claim a transaction on behalf of a Trustap user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/v2_transactions.claimtransaction","deprecated":false},{"title":"/v2/transactions/{transaction_id}/metadata","summary":"Set metadata for a transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/v2_transactions.settransactionmetadata","deprecated":false}]}]}]}]}},{"type":"group","label":"Transaction Issues","link":"/apis/openapi/transaction-issues","routeSlug":"/apis/openapi/transaction-issues","items":[{"label":"Accept a complaint for this transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/transaction-issues/v2_transactions.acceptcomplaintfortransaction","routeSlug":"/apis/openapi/transaction-issues/v2_transactions.acceptcomplaintfortransaction","metadata":{"seo":{"title":"Accept a complaint for this transaction","description":"Accept a complaint for this transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.acceptComplaintForTransaction","name":"Accept a complaint for this transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1accept_complaint/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept a complaint for this transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1accept_complaint/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Trustap-User","in":"header","schemaId":"schema_141","description":"Required in client flows, where you make API calls on behalf of another Trustap user."}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1accept_complaint/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transaction_id}/accept_complaint","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[{"name":"Trustap-User","in":"header","required":false,"schemaId":"schema_141"}],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions/{transaction_id}/accept_complaint","href":"transaction-issues/v2_transactions.acceptcomplaintfortransaction","openApiOperationId":"v2_transactions.acceptComplaintForTransaction","summary":"Accept a complaint for this transaction","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1accept_complaint/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1accept_complaint/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_152"}},"schemaId":"schema_152"}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1accept_complaint/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1accept_complaint/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1accept_complaint/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_152","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_152"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction-issues/v2_transactions.acceptcomplaintfortransaction"}],"panels":[]}]},"httpPath":"/v2/transactions/{transaction_id}/accept_complaint"},{"label":"Submit a complaint for this transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/transaction-issues/v2_transactions.submitcomplaintfortransaction","routeSlug":"/apis/openapi/transaction-issues/v2_transactions.submitcomplaintfortransaction","metadata":{"seo":{"title":"Submit a complaint for this transaction","description":"A complaint is submitted for problems with transactions after the order has been shipped or handover has been confirmed. Before that an order issue should be submitted instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.submitComplaintForTransaction","name":"Submit a complaint for this transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1submit_complaint/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a complaint for this transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A complaint is submitted for problems with transactions after the order\nhas been shipped or handover has been confirmed. Before that an order\nissue should be submitted instead.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1submit_complaint/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Trustap-User","in":"header","schemaId":"schema_141","description":"Required in client flows, where you make API calls on behalf of another Trustap user."}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1submit_complaint/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_153"}},"schemaId":"schema_153","pointer":"/paths/~1v2~1transactions~1{transaction_id}~1submit_complaint/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transaction_id}/submit_complaint","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[{"name":"Trustap-User","in":"header","required":false,"schemaId":"schema_141"}],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_153"}},"responseCodes":["200","400"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions/{transaction_id}/submit_complaint","href":"transaction-issues/v2_transactions.submitcomplaintfortransaction","openApiOperationId":"v2_transactions.submitComplaintForTransaction","summary":"Submit a complaint for this transaction","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"schemaId":"schema_153","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_153"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1submit_complaint/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1submit_complaint/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_154"}},"schemaId":"schema_154"}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1submit_complaint/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1submit_complaint/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1submit_complaint/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_154","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_154"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction-issues/v2_transactions.submitcomplaintfortransaction"}],"panels":[]}]},"httpPath":"/v2/transactions/{transaction_id}/submit_complaint"},{"label":"Submit an order issue for this transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/transaction-issues/v2_transactions.submitorderissuefortransaction","routeSlug":"/apis/openapi/transaction-issues/v2_transactions.submitorderissuefortransaction","metadata":{"seo":{"title":"Submit an order issue for this transaction","description":"An order issue is submitted for problems with transactions after payment confirmation and before the order has been shipped or handover has been confirmed. After that a complaint should be submitted instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.submitOrderIssueForTransaction","name":"Submit an order issue for this transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1submit_order_issue/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit an order issue for this transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An order issue is submitted for problems with transactions after payment\nconfirmation and before the order has been shipped or handover has been\nconfirmed. After that a complaint should be submitted instead.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1submit_order_issue/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Trustap-User","in":"header","schemaId":"schema_141","description":"Required in client flows, where you make API calls on behalf of another Trustap user."}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1submit_order_issue/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_155"}},"schemaId":"schema_155","pointer":"/paths/~1v2~1transactions~1{transaction_id}~1submit_order_issue/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transaction_id}/submit_order_issue","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[{"name":"Trustap-User","in":"header","required":false,"schemaId":"schema_141"}],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_155"}},"responseCodes":["200","400","403"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions/{transaction_id}/submit_order_issue","href":"transaction-issues/v2_transactions.submitorderissuefortransaction","openApiOperationId":"v2_transactions.submitOrderIssueForTransaction","summary":"Submit an order issue for this transaction","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"schemaId":"schema_155","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_155"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1submit_order_issue/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1submit_order_issue/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_156"}},"schemaId":"schema_156"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157"}},"schemaId":"schema_157"}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1submit_order_issue/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1submit_order_issue/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1submit_order_issue/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_156","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_156"}}},{"code":"403","schemaId":"schema_157","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction-issues/v2_transactions.submitorderissuefortransaction"}],"panels":[]}]},"httpPath":"/v2/transactions/{transaction_id}/submit_order_issue"}],"content":{"contentType":"group","meta":{"name":"Transaction Issues"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction Issues","showPageActions":true},{"nodeType":"markdoc","content":"Transaction issues endpoints are used for reporting and managing transaction\nissues."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/transactions/{transaction_id}/accept_complaint","summary":"Accept a complaint for this transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transaction-issues/v2_transactions.acceptcomplaintfortransaction","deprecated":false},{"title":"/v2/transactions/{transaction_id}/submit_complaint","summary":"Submit a complaint for this transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transaction-issues/v2_transactions.submitcomplaintfortransaction","deprecated":false},{"title":"/v2/transactions/{transaction_id}/submit_order_issue","summary":"Submit an order issue for this transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transaction-issues/v2_transactions.submitorderissuefortransaction","deprecated":false}]}]}]}]}},{"type":"separator","label":"Delivery","content":null},{"type":"group","label":"Handover","link":"/apis/openapi/handover","routeSlug":"/apis/openapi/handover","items":[],"content":{"contentType":"group","meta":{"name":"Handover"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Handover","showPageActions":true},{"nodeType":"markdoc","content":"Endpoint for confirming handover of goods for transactions."}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/handover"}],"panels":[]}]}},{"type":"group","label":"Shipping","link":"/apis/openapi/shipping","routeSlug":"/apis/openapi/shipping","items":[{"label":"Get the supported carriers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/shipping/v2_transactions.getsupportedcarriers","routeSlug":"/apis/openapi/shipping/v2_transactions.getsupportedcarriers","metadata":{"seo":{"title":"Get the supported carriers","description":"This returns the carriers that are currently supported forautomated tracking. The carrier nameshould be shown to users but the code should be submitted tothe /track endpoint when submitting tracking details.Likewise, when showing a transaction to the user, the carrierfield stored with the transaction should be used to index thesecarriers and show the human-readable name of the carrier to theuser, if this index is found."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.getSupportedCarriers","name":"Get the supported carriers","isWebhook":false,"pointer":"/paths/~1v2~1carriers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the supported carriers","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":"This returns the carriers that are currently supported for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automated tracking. The carrier "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"should be shown to users but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be submitted to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/track"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint when submitting tracking details."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Likewise, when showing a transaction to the user, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field stored with the transaction should be used to index these"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"carriers and show the human-readable name of the carrier to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user, if this index is found."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/carriers","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/carriers","href":"shipping/v2_transactions.getsupportedcarriers","openApiOperationId":"v2_transactions.getSupportedCarriers","summary":"Get the supported carriers","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_158"}},"schemaId":"schema_158"}],"pointer":"/paths/~1v2~1carriers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_158","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_158"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping/v2_transactions.getsupportedcarriers"}],"panels":[]}]},"httpPath":"/v2/carriers"},{"label":"Confirm delivery for this transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/shipping/v2_transactions.confirmdeliveryfortransaction","routeSlug":"/apis/openapi/shipping/v2_transactions.confirmdeliveryfortransaction","metadata":{"seo":{"title":"Confirm delivery for this transaction","description":"This endpoint allows a user to confirm the delivery of the item in the case that the state of the transaction was not updated asynchronously by Trustap"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.confirmDeliveryForTransaction","name":"Confirm delivery for this transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1confirm_delivery/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirm delivery for this transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows a user to confirm the delivery\nof the item in the case that the state of the transaction was\nnot updated asynchronously by Trustap\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1confirm_delivery/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Trustap-User","in":"header","schemaId":"schema_141","description":"Required in client flows, where you make API calls on behalf of another Trustap user."}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1confirm_delivery/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transaction_id}/confirm_delivery","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[{"name":"Trustap-User","in":"header","required":false,"schemaId":"schema_141"}],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions/{transaction_id}/confirm_delivery","href":"shipping/v2_transactions.confirmdeliveryfortransaction","openApiOperationId":"v2_transactions.confirmDeliveryForTransaction","summary":"Confirm delivery for this transaction","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1confirm_delivery/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1confirm_delivery/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159"}},"schemaId":"schema_159"}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1confirm_delivery/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1confirm_delivery/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1confirm_delivery/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_159","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping/v2_transactions.confirmdeliveryfortransaction"}],"panels":[]}]},"httpPath":"/v2/transactions/{transaction_id}/confirm_delivery"},{"label":"Get the shipping details of the buyer for a transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/shipping/v2_transactions.getshippingdetailsfortransaction","routeSlug":"/apis/openapi/shipping/v2_transactions.getshippingdetailsfortransaction","metadata":{"seo":{"title":"Get the shipping details of the buyer for a transaction","description":"Get the shipping details of the buyer for a transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.getShippingDetailsForTransaction","name":"Get the shipping details of the buyer for a transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1shipping_details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the shipping details of the buyer for a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1shipping_details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/transactions/{transaction_id}/shipping_details","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions/{transaction_id}/shipping_details","href":"shipping/v2_transactions.getshippingdetailsfortransaction","openApiOperationId":"v2_transactions.getShippingDetailsForTransaction","summary":"Get the shipping details of the buyer for a transaction","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.ShippingDetails"}},"schemaId":"components/schemas/v2_transactions.ShippingDetails"}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1shipping_details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.ShippingDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.ShippingDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping/v2_transactions.getshippingdetailsfortransaction"}],"panels":[]}]},"httpPath":"/v2/transactions/{transaction_id}/shipping_details"},{"label":"Post the shipping details of the buyer for a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/shipping/v2_transactions.setshippingdetailsfortransaction","routeSlug":"/apis/openapi/shipping/v2_transactions.setshippingdetailsfortransaction","metadata":{"seo":{"title":"Post the shipping details of the buyer for a transaction","description":"Post the shipping details of the buyer for a transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.setShippingDetailsForTransaction","name":"Post the shipping details of the buyer for a transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1shipping_details/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post the shipping details of the buyer for a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1shipping_details/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_160"}},"schemaId":"schema_160","pointer":"/paths/~1v2~1transactions~1{transaction_id}~1shipping_details/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transaction_id}/shipping_details","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_160"}},"responseCodes":["200","400"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions/{transaction_id}/shipping_details","href":"shipping/v2_transactions.setshippingdetailsfortransaction","openApiOperationId":"v2_transactions.setShippingDetailsForTransaction","summary":"Post the shipping details of the buyer for a transaction","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"schemaId":"schema_160","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_160"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.ShippingDetails"}},"schemaId":"components/schemas/v2_transactions.ShippingDetails"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_161"}},"schemaId":"schema_161"}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1shipping_details/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.ShippingDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.ShippingDetails"}}},{"code":"400","schemaId":"schema_161","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_161"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping/v2_transactions.setshippingdetailsfortransaction"}],"panels":[]}]},"httpPath":"/v2/transactions/{transaction_id}/shipping_details"},{"label":"Set postal tracking details for a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/shipping/v2_transactions.tracktransaction","routeSlug":"/apis/openapi/shipping/v2_transactions.tracktransaction","metadata":{"seo":{"title":"Set postal tracking details for a transaction","description":"After the tracking information has been submitted then the stateof the transaction will be updated asynchronously by Trustaponce the delivery of the item has been confirmed, at which pointthe delivered field of the transaction will be set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_transactions.trackTransaction","name":"Set postal tracking details for a transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1track/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set postal tracking details for 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":"After the tracking information has been submitted then the state"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the transaction will be updated asynchronously by Trustap"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"once the delivery of the item has been confirmed, at which point"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delivered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the transaction will be set."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"APIKey","scopes":[],"type":"http","scheme":"basic"}]},{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1track/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Trustap-User","in":"header","schemaId":"schema_141","description":"Required in client flows, where you make API calls on behalf of another Trustap user."}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1track/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_162"}},"schemaId":"schema_162","pointer":"/paths/~1v2~1transactions~1{transaction_id}~1track/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transaction_id}/track","servers":[{"url":"https://api.test.trustap.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[{"name":"Trustap-User","in":"header","required":false,"schemaId":"schema_141"}],"cookie":[]},"security":[{"schemes":[{"id":"APIKey","type":"http","scheme":"basic","x-defaultUsername":"<API_KEY>","x-defaultPassword":"​"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_162"}},"responseCodes":["200","400","403","409"],"requestValues":{"security":{"APIKey":{"username":"<API_KEY>","password":"​"}}},"pointer":"/v2/transactions/{transaction_id}/track","href":"shipping/v2_transactions.tracktransaction","openApiOperationId":"v2_transactions.trackTransaction","summary":"Set postal tracking details for a transaction","securityGroups":[{"APIKey":[]},{"OAuth2":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.trustap.com"}],"schemaId":"schema_162","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_162"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1track/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1track/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163"}},"schemaId":"schema_163"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_164"}},"schemaId":"schema_164"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_165"}},"schemaId":"schema_165"}],"pointer":"/paths/~1v2~1transactions~1{transaction_id}~1track/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1track/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v2_transactions.Transaction","exampleIds":["paths/~1v2~1transactions~1{transaction_id}~1track/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_163","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163"}}},{"code":"403","schemaId":"schema_164","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_164"}}},{"code":"409","schemaId":"schema_165","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_165"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping/v2_transactions.tracktransaction"}],"panels":[]}]},"httpPath":"/v2/transactions/{transaction_id}/track"}],"content":{"contentType":"group","meta":{"name":"Shipping"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipping","showPageActions":true},{"nodeType":"markdoc","content":"Shipping endpoints for transactions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/carriers","summary":"Get the supported carriers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipping/v2_transactions.getsupportedcarriers","deprecated":false},{"title":"/v2/transactions/{transaction_id}/confirm_delivery","summary":"Confirm delivery for this transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipping/v2_transactions.confirmdeliveryfortransaction","deprecated":false},{"title":"/v2/transactions/{transaction_id}/shipping_details","summary":"Get the shipping details of the buyer for a transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipping/v2_transactions.getshippingdetailsfortransaction","deprecated":false},{"title":"/v2/transactions/{transaction_id}/shipping_details","summary":"Post the shipping details of the buyer for a transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipping/v2_transactions.setshippingdetailsfortransaction","deprecated":false},{"title":"/v2/transactions/{transaction_id}/track","summary":"Set postal tracking details for a transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipping/v2_transactions.tracktransaction","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/experiences.Experience":{"id":"components/schemas/experiences.Experience","kind":"json-schema","title":"experiences.Experience","data":{"properties":{"activity":{"type":"string"},"category":{"type":"string"},"date":{"type":"string"},"display_title":{"type":"string"},"id":{"type":"integer"},"image":{"type":"string"},"is_featured":{"type":"boolean"},"location":{"type":"string"},"max_price":{"type":"integer"},"min_price":{"type":"integer"},"open_time":{"type":"string"},"participants":{"items":{"$ref":"#/components/schemas/experiences.Participant"},"type":"array"},"title":{"type":"string"},"total_listings":{"type":"integer"},"type":{"type":"string"},"venue":{"$ref":"#/components/schemas/experiences.Venue"}},"required":["id"],"type":"object"}},"components/schemas/experiences.PaginatedExperiences":{"id":"components/schemas/experiences.PaginatedExperiences","kind":"json-schema","title":"experiences.PaginatedExperiences","data":{"properties":{"experiences":{"items":{"$ref":"#/components/schemas/experiences.Experience"},"type":"array"},"pagination":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"},"total_items":{"type":"integer"},"total_pages":{"type":"integer"}},"required":["page","page_size","total_items","total_pages"],"type":"object"}},"type":"object"}},"components/schemas/experiences.Participant":{"id":"components/schemas/experiences.Participant","kind":"json-schema","title":"experiences.Participant","data":{"properties":{"id":{"type":"integer"},"image":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id"],"type":"object"}},"components/schemas/experiences.Venue":{"id":"components/schemas/experiences.Venue","kind":"json-schema","title":"experiences.Venue","data":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"state":{"type":"string"}},"required":["id"],"type":"object"}},"components/schemas/v2_transactions.BankTransferDetails":{"id":"components/schemas/v2_transactions.BankTransferDetails","kind":"json-schema","title":"v2_transactions.BankTransferDetails","data":{"properties":{"processor":{"type":"string"},"stripe":{"$ref":"#/components/schemas/v2_transactions.StripeBankTransferDetails"}},"required":["processor"],"type":"object"}},"components/schemas/v2_transactions.Carrier":{"id":"components/schemas/v2_transactions.Carrier","kind":"json-schema","title":"v2_transactions.Carrier","data":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["code","name"],"type":"object"}},"components/schemas/v2_transactions.ComplaintCategory":{"id":"components/schemas/v2_transactions.ComplaintCategory","kind":"json-schema","title":"v2_transactions.ComplaintCategory","data":{"enum":["item_not_received","item_not_as_described","other"],"example":"other","type":"string"}},"components/schemas/v2_transactions.Events":{"id":"components/schemas/v2_transactions.Events","kind":"json-schema","title":"v2_transactions.Events","data":{"properties":{"by_key":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These fields indicate the time that the first instance of the given"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"event occurred. Where events can repeat (such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refunded"},"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":"duplicate instances can be retrieved from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"by_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sibling"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property."},"children":[]}]}]}],"properties":{"buyer_handover_confirmed":{"format":"date-time","type":"string"},"cancelled":{"format":"date-time","type":"string"},"claimed_by_buyer":{"format":"date-time","type":"string"},"claimed_by_seller":{"format":"date-time","type":"string"},"complaint_period_ended":{"format":"date-time","type":"string"},"complaint_submitted":{"format":"date-time","type":"string"},"created":{"format":"date-time","type":"string"},"delivered":{"format":"date-time","type":"string"},"funds_released":{"format":"date-time","type":"string"},"joined":{"format":"date-time","type":"string"},"order_issue_submitted":{"format":"date-time","type":"string"},"paid":{"format":"date-time","type":"string"},"payment_accepted":{"format":"date-time","type":"string"},"refunded":{"format":"date-time","type":"string"},"rejected":{"format":"date-time","type":"string"},"review_flagged":{"format":"date-time","type":"string"},"seller_handover_confirmed":{"format":"date-time","type":"string"},"tracked":{"format":"date-time","type":"string"}},"required":["created"],"type":"object"},"by_time":{"items":{"properties":{"at":{"format":"date-time","type":"string"},"by":{"description":"This contains the ID of the user that triggered this event. It\nis not present for events that are triggered by the platform,\nsuch as by automated systems.\n","type":"string"},"code":{"type":"string"}},"required":["code","at"],"type":"object"},"type":"array"}},"required":["by_time","by_key"],"type":"object"}},"components/schemas/v2_transactions.Fees":{"id":"components/schemas/v2_transactions.Fees","kind":"json-schema","title":"v2_transactions.Fees","data":{"example":{"buyer":78,"config":1,"seller":0},"properties":{"buyer":{"format":"int64","type":"integer"},"config":{"format":"int64","type":"integer"},"seller":{"format":"int64","type":"integer"}},"required":["buyer","seller","config"],"type":"object"}},"components/schemas/v2_transactions.OrderIssueCategory":{"id":"components/schemas/v2_transactions.OrderIssueCategory","kind":"json-schema","title":"v2_transactions.OrderIssueCategory","data":{"enum":["item_not_received","other"],"example":"other","type":"string"}},"components/schemas/v2_transactions.Pricing":{"id":"components/schemas/v2_transactions.Pricing","kind":"json-schema","title":"v2_transactions.Pricing","data":{"properties":{"amount":{"format":"int64","type":"integer"},"amount_extra":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents an additional charge to be paid by the buyer added"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the transaction total. Use this field to include costs like"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processing fees or local taxes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be an integer provided in the smallest unit of the currency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(for example, 500 for $5.00 USD). Defaults to 0 if not provided."},"children":[]}]}]}],"format":"int64","type":"integer"},"amount_postage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents an additional charge to be paid by the buyer, seller or client."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to include costs like shipping surcharges."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be an integer provided in the smallest unit of the currency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(for example, 500 for $5.00 USD)."},"children":[]}]}]}],"format":"int64","type":"integer"},"currency":{"description":"The currency of the transaction. Note that, at present, the\nbuyer must pay using the transaction's currency and the\nseller will be paid in the transaction's currency. Conversion to this\ncurrency will happen automatically during payment if the buyer pays\nwith a different currency.\n","format":"currency","type":"string"},"fees":{"properties":{"buyer":{"format":"int64","type":"integer"},"buyer_client":{"format":"int64","type":"integer"},"international_payment":{"format":"int64","type":"integer"},"seller":{"format":"int64","type":"integer"},"seller_client":{"format":"int64","type":"integer"}},"required":["buyer","seller","buyer_client","seller_client"],"type":"object"},"postage_bearer":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates who is responsible for paying the postage amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only present if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_postage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}],"enum":["buyer","seller","client"],"type":"string"}},"required":["amount","amount_extra","currency","fees"],"type":"object"}},"components/schemas/v2_transactions.ShippingDetails":{"id":"components/schemas/v2_transactions.ShippingDetails","kind":"json-schema","title":"v2_transactions.ShippingDetails","data":{"properties":{"address":{"$ref":"#/components/schemas/v2_transactions.ShippingDetailsAddress"},"name":{"type":"string"},"phone":{"type":"string"}},"required":["address","name","phone"],"type":"object"}},"components/schemas/v2_transactions.ShippingDetailsAddress":{"id":"components/schemas/v2_transactions.ShippingDetailsAddress","kind":"json-schema","title":"v2_transactions.ShippingDetailsAddress","data":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"required":["city","country","line1","line2","state","postal_code"],"type":"object"}},"components/schemas/v2_transactions.Status":{"id":"components/schemas/v2_transactions.Status","kind":"json-schema","title":"v2_transactions.Status","data":{"enum":["created","joined","rejected","cancelled","paid","review_flagged","payment_accepted","complaint_submitted","complaint_period_ended","refunded","tracked","delivered","funds_released","claimed_by_buyer","claimed_by_seller"],"type":"string"}},"components/schemas/v2_transactions.StripeAba":{"id":"components/schemas/v2_transactions.StripeAba","kind":"json-schema","title":"v2_transactions.StripeAba","data":{"properties":{"account_number":{"type":"string"},"bank_name":{"type":"string"},"routing_number":{"type":"string"}},"required":["account_number","bank_name","routing_number"],"type":"object"}},"components/schemas/v2_transactions.StripeBankTransferDetails":{"id":"components/schemas/v2_transactions.StripeBankTransferDetails","kind":"json-schema","title":"v2_transactions.StripeBankTransferDetails","data":{"properties":{"amount":{"format":"int64","type":"integer"},"currency":{"type":"string"},"financial_address":{"$ref":"#/components/schemas/v2_transactions.StripeFinancialAddress"},"hosted_instructions_url":{"type":"string"},"reference":{"type":"string"}},"required":["amount","currency","hosted_instructions_url","reference","financial_address"],"type":"object"}},"components/schemas/v2_transactions.StripeFinancialAddress":{"id":"components/schemas/v2_transactions.StripeFinancialAddress","kind":"json-schema","title":"v2_transactions.StripeFinancialAddress","data":{"properties":{"aba":{"$ref":"#/components/schemas/v2_transactions.StripeAba"},"iban":{"$ref":"#/components/schemas/v2_transactions.StripeIban"},"sort_code":{"$ref":"#/components/schemas/v2_transactions.StripeSortCode"},"swift":{"$ref":"#/components/schemas/v2_transactions.StripeSwift"}},"type":"object"}},"components/schemas/v2_transactions.StripeIban":{"id":"components/schemas/v2_transactions.StripeIban","kind":"json-schema","title":"v2_transactions.StripeIban","data":{"properties":{"account_holder_name":{"type":"string"},"bic":{"type":"string"},"country":{"type":"string"},"iban":{"type":"string"}},"required":["account_holder_name","bic","country","iban"],"type":"object"}},"components/schemas/v2_transactions.StripeSortCode":{"id":"components/schemas/v2_transactions.StripeSortCode","kind":"json-schema","title":"v2_transactions.StripeSortCode","data":{"properties":{"account_holder_name":{"type":"string"},"account_number":{"type":"string"},"sort_code":{"type":"string"}},"required":["account_holder_name","account_number","sort_code"],"type":"object"}},"components/schemas/v2_transactions.StripeSwift":{"id":"components/schemas/v2_transactions.StripeSwift","kind":"json-schema","title":"v2_transactions.StripeSwift","data":{"properties":{"account_number":{"type":"string"},"bank_name":{"type":"string"},"swift_code":{"type":"string"}},"required":["account_number","bank_name","swift_code"],"type":"object"}},"components/schemas/v2_transactions.Tracking":{"id":"components/schemas/v2_transactions.Tracking","kind":"json-schema","title":"v2_transactions.Tracking","data":{"properties":{"carrier":{"type":"string"},"tracking_code":{"type":"string"}},"required":["carrier","tracking_code"],"type":"object"}},"components/schemas/v2_transactions.Transaction":{"id":"components/schemas/v2_transactions.Transaction","kind":"json-schema","title":"v2_transactions.Transaction","data":{"example":{"buyer":{"id":"9097","is_guest":false},"client_id":"1234","deadlines":{"complaints":"2019-12-25T15:00:00Z"},"description":"Soccer ticket","events":{"by_key":{"created":"2019-12-25T09:00:00Z","delivered":"2019-12-25T16:00:00Z","funds_released":"2019-12-25T17:00:00Z","joined":"2019-12-25T10:00:00Z","paid":"2019-12-25T11:00:00Z","payment_accepted":"2019-12-25T12:00:00Z"},"by_time":[]},"funds_release":{"refunds":[],"released_to_seller":false},"id":"tx_21066","pricing":{"amount":1000,"amount_extra":0,"currency":"eur","fees":{"buyer":110,"buyer_client":10,"international_payment":20,"seller":0,"seller_client":5}},"review":{"approved":true,"outcome_reason":"Not fraudulent."},"seller":{"id":"9790","is_guest":false},"status":"funds_released"},"properties":{"buyer":{"$ref":"#/components/schemas/v2_transactions.User"},"cancellation":{"properties":{"description":{"type":"string"}},"required":["description"],"type":"object"},"client_id":{"type":"string"},"complaint":{"properties":{"accepted":{"format":"date-time","type":"string"},"category":{"$ref":"#/components/schemas/v2_transactions.ComplaintCategory"},"description":{"type":"string"}},"required":["description","category"],"type":"object"},"contains_shipping":{"type":"boolean"},"deadlines":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This property contains all possible actions that have associated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deadlines for completion. Actions with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not have deadlines"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currently pending."},"children":[]}]}]}],"properties":{"complaints":{"format":"date-time","type":"string","nullable":true}},"type":"object"},"description":{"type":"string"},"events":{"$ref":"#/components/schemas/v2_transactions.Events"},"funds_release":{"properties":{"payout_id":{"type":"string"},"refunds":{"items":{"properties":{"amount":{"format":"int64","type":"integer"},"id":{"type":"string"}},"required":["id","amount"],"type":"object"},"type":"array"},"released_to_seller":{"type":"boolean"}},"required":["released_to_seller","refunds"],"type":"object"},"id":{"format":"type_id","type":"string"},"join_code":{"type":"string"},"metadata":{"additionalProperties":true,"description":"Arbitrary key-value string pairs for adding extra information to transactions.","type":"object"},"order_issue":{"properties":{"category":{"$ref":"#/components/schemas/v2_transactions.OrderIssueCategory"},"description":{"type":"string"}},"required":["description","category"],"type":"object"},"payment_link":{"description":"URL to the actions page where the buyer can pay the deposit.\n","type":"string"},"pricing":{"$ref":"#/components/schemas/v2_transactions.Pricing"},"review":{"properties":{"approved":{"type":"boolean"},"outcome_reason":{"type":"string"}},"required":["approved","outcome_reason"],"type":"object"},"seller":{"$ref":"#/components/schemas/v2_transactions.User"},"status":{"$ref":"#/components/schemas/v2_transactions.Status"},"tracking":{"$ref":"#/components/schemas/v2_transactions.Tracking"}},"required":["id","status","client_id","pricing","deadlines","description","events"],"type":"object"}},"components/schemas/v2_transactions.User":{"id":"components/schemas/v2_transactions.User","kind":"json-schema","title":"v2_transactions.User","data":{"example":{"id":"9097","is_guest":false},"properties":{"id":{"type":"string"},"is_guest":{"type":"boolean"}},"required":["id","is_guest"],"type":"object"}},"components/schemas/v2_transactions.UserDetails":{"id":"components/schemas/v2_transactions.UserDetails","kind":"json-schema","title":"v2_transactions.UserDetails","data":{"properties":{"email":{"type":"string"},"name":{"$ref":"#/components/schemas/v2_transactions.UserDetailsName"},"phone":{"type":"string"}},"required":["email"],"type":"object"}},"components/schemas/v2_transactions.UserDetailsName":{"id":"components/schemas/v2_transactions.UserDetailsName","kind":"json-schema","title":"v2_transactions.UserDetailsName","data":{"properties":{"first":{"type":"string"},"last":{"type":"string"}},"required":["first","last"],"type":"object"}},"components/schemas/v2_users.TosAcceptance":{"id":"components/schemas/v2_users.TosAcceptance","kind":"json-schema","title":"v2_users.TosAcceptance","data":{"properties":{"ip":{"minLength":1,"type":"string"},"unix_timestamp":{"format":"int64","type":"integer"}},"required":["unix_timestamp","ip"],"type":"object"}},"components/schemas/v2_users.User":{"id":"components/schemas/v2_users.User","kind":"json-schema","title":"v2_users.User","data":{"example":{"created_at":"2019-12-25T13:00:00Z","email":"jo@example.com","id":"1-feb33a87-3917-4538-9260-127c8a6b5232"},"properties":{"created_at":{"format":"date-time","type":"string"},"deleted_at":{"format":"date-time","type":"string"},"email":{"type":"string"},"id":{"type":"string"}},"required":["id","email","created_at"],"type":"object"}},"schema_137":{"kind":"json-schema","data":{"example":{"country_code":"IE","email":"guest@test.com","first_name":"Test","last_name":"User","tos_acceptance":{"ip":"192.168.1.2","unix_timestamp":1672531200}},"properties":{"country_code":{"type":"string"},"email":{"minLength":1,"type":"string"},"first_name":{"minLength":1,"type":"string"},"last_name":{"minLength":1,"type":"string"},"tos_acceptance":{"$ref":"#/components/schemas/v2_users.TosAcceptance"}},"required":["email","country_code","tos_acceptance"],"type":"object"},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"properties":{"code":{"enum":["invalid_email","missing_country_code","missing_tos_acceptance","invalid_tos_acceptance_date","invalid_country_code"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"string","format":"currency"},"id":"schema_139"},"schema_140":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_140"},"schema_141":{"kind":"json-schema","data":{"type":"string"},"id":"schema_141"},"schema_142":{"kind":"json-schema","data":{"example":{"code":"negative_amount","message":"`amount` cannot be negative"},"properties":{"code":{"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unsupported_combination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The provided payment method,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fee config and currency combination isn't supported."},"children":[]}]}]}]}],"enum":["currency_missing","invalid_amount","negative_amount","amount_too_low","unsupported_currency","invalid_fee_config","unsupported_combination"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"properties":{"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price of the goods being sold in this transaction, in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s smallest unit. For example, if a trading"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card is being sold for $12.34 (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then the body would contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"amount\": 1234, \"currency\": \"usd\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64","type":"integer"},"amount_extra":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents an additional charge to be paid by the buyer added"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the transaction total. Use this field to include costs like"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processing fees or local taxes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be an integer provided in the smallest unit of the currency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(for example, 500 for $5.00 USD). Defaults to 0 if not provided."},"children":[]}]}]}],"format":"int64","type":"integer"},"amount_postage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents an additional charge to be paid by the buyer, seller or client."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to include costs like shipping surcharges."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be an integer provided in the smallest unit of the currency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(for example, 500 for $5.00 USD)."},"children":[]}]}]}],"format":"int64","type":"integer"},"buyer_id":{"description":"The ID of the user that will be the buyer in this transaction.\n","type":"string"},"contains_shipping":{"description":"Specifies if the transactions contains a shippable item and\nthe shipping details should be collected from the buyer.\n","type":"boolean"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified in."},"children":[]}]}]}],"format":"currency","type":"string","x-toc-ref":"#/definitions/Currency"},"description":{"description":"A description of the goods being sold.","type":"string"},"fees_buyer":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The buyer fees for this transaction, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s smallest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unit."},"children":[]}]}]}],"format":"int64","type":"integer"},"fees_config":{"description":"The fee config for which the fees are computed.","format":"int64","type":"integer"},"fees_seller":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The seller fees for this transaction, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s smallest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unit."},"children":[]}]}]}],"format":"int64","type":"integer"},"image_url":{"description":"URL of the image displayed on the Trustap payment page to show the buyer\nthe item they are paying for.\nSupports jpg, png, gif, bmp, webp and svg files. Images displayed as a\nsquares. Non-square images are cropped.\n","format":"absolute_url","maxLength":2047,"type":"string"},"payment_method":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment method that will be used to pay for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction. This is necessary because different payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"methods may result in different fees."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank_transfer"},"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":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"role":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The role of the user creating the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","x-toc-ref":"#/definitions/Role"},"seller_id":{"description":"The ID of the user that will be the seller in this transaction.\n","type":"string"}},"required":["currency","amount","fees_buyer","description"],"type":"object"},"id":"schema_143"},"schema_144":{"kind":"json-schema","data":{"example":{"code":"negative_amount","message":"`price` cannot be negative"},"properties":{"code":{"enum":["invalid_currency","missing_user_id","invalid_user_id","missing_seller_id","missing_buyer_id","invalid_seller_id","invalid_buyer_id","incorrect_charge","negative_amount","amount_too_low","invalid_charge_config","missing_role","invalid_role","unsupported_role"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_144"},"schema_145":{"kind":"json-schema","data":{"properties":{"code":{"enum":["payment_method_not_bank_transfer","paid_with_balance"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_145"},"schema_146":{"kind":"json-schema","data":{"properties":{"description":{"description":"A description of the cancellation reason.\n","type":"string"}},"required":["description"],"type":"object"},"id":"schema_146"},"schema_147":{"kind":"json-schema","data":{"properties":{"code":{"enum":["already_cancelled","handover_already_confirmed"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_147"},"schema_148":{"kind":"json-schema","data":{"properties":{"role":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The role of the user claiming the transaction. Supported values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","x-toc-ref":"#/definitions/Role"}},"required":["role"],"type":"object"},"id":"schema_148"},"schema_149":{"kind":"json-schema","data":{"properties":{"code":{"enum":["cannot_claim_own_transaction","invalid_role","invalid_user_id","emails_mismatched","user_is_not_guest"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_149"},"schema_150":{"kind":"json-schema","data":{"additionalProperties":true,"type":"object"},"id":"schema_150"},"schema_151":{"kind":"json-schema","data":{"properties":{"code":{"enum":["too_many_keys","value_too_long","key_too_long","empty_json","unsupported_type"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_151"},"schema_152":{"kind":"json-schema","data":{"properties":{"code":{"enum":["funds_already_released","deposit_not_paid","deposit_already_refunded","not_complained"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_152"},"schema_153":{"kind":"json-schema","data":{"properties":{"category":{"$ref":"#/components/schemas/v2_transactions.ComplaintCategory"},"description":{"type":"string"}},"required":["description"],"type":"object"},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"properties":{"code":{"enum":["remainder_required","already_complained","funds_already_released","complaint_period_expired","handover_or_delivery_required"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"properties":{"category":{"$ref":"#/components/schemas/v2_transactions.OrderIssueCategory"},"description":{"minLength":1,"type":"string"}},"required":["description"],"type":"object"},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"properties":{"code":{"enum":["remainder_required","payment_not_accepted","handover_already_confirmed","item_already_delivered","order_issue_already_submitted"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"properties":{"code":{"enum":["not_buyer"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/v2_transactions.Carrier"},"type":"array"},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"properties":{"code":{"enum":["delivery_not_supported","delivery_already_set","invalid_id"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"properties":{"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"city":{"type":"string"},"country":{"minLength":1,"type":"string"},"name":{"minLength":1,"type":"string"},"phone":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"required":["name","country"],"type":"object"},"id":"schema_160"},"schema_161":{"kind":"json-schema","data":{"properties":{"code":{"enum":["empty_name","empty_country"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_161"},"schema_162":{"kind":"json-schema","data":{"example":{"carrier":"ups","tracking_code":"***"},"properties":{"carrier":{"minLength":1,"type":"string"},"tracking_code":{"minLength":1,"type":"string"}},"required":["carrier","tracking_code"],"type":"object"},"id":"schema_162"},"schema_163":{"kind":"json-schema","data":{"properties":{"code":{"enum":["invalid_id","empty_carrier","empty_tracking_code","tracking_already_added","payment_details_not_added","tracking_details_deadline_expired","already_cancelled","tracking_not_supported"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_163"},"schema_164":{"kind":"json-schema","data":{"properties":{"code":{"enum":["not_seller"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_164"},"schema_165":{"kind":"json-schema","data":{"properties":{"code":{"enum":["missing_payment_intent"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"id":"schema_165"}},"exampleStore":{"paths/~1v2~1transactions~1{transaction_id}~1accept_payment/post/responses/200/content/application~1json/examples/response":{"value":{"buyer":{"id":"1-def29dfe-8626-48a2-8863-b6fdf2b96ff0","is_guest":true},"client_id":"5ad5451d-70c7-43c6-86c9-e1d90556856c","deadlines":{"complaints":null},"description":"Trustap socks","events":{"by_key":{"created":"2026-04-29T11:04:26Z","joined":"2026-04-29T11:04:26Z","paid":"2026-04-29T11:05:19Z","payment_accepted":"2026-04-29T11:06:06Z"},"by_time":[{"at":"2026-04-29T11:04:26Z","code":"created"},{"at":"2026-04-29T11:04:26Z","code":"joined"},{"at":"2026-04-29T11:05:19Z","by":"1-def29dfe-8626-48a2-8863-b6fdf2b96ff0","code":"paid"},{"at":"2026-04-29T11:06:06Z","by":"1-3f546125-2ec2-4b14-87f6-54a14ae73e98","code":"payment_accepted"}]},"funds_release":{"refunds":[],"released_to_seller":false},"id":"tx_01kq7pz74mffj9x5vsesqkve08","metadata":{},"pricing":{"amount":20000,"amount_extra":0,"currency":"gbp","fees":{"buyer":640,"buyer_client":0,"international_payment":310,"seller":0,"seller_client":0}},"seller":{"id":"1-3f546125-2ec2-4b14-87f6-54a14ae73e98","is_guest":true},"status":"payment_accepted"},"key":"response","summary":"response","id":"paths/~1v2~1transactions~1{transaction_id}~1accept_payment/post/responses/200/content/application~1json/examples/response"},"paths/~1v2~1transactions/post/responses/201/content/application~1json/examples/response":{"value":{"buyer":{"id":"1-def29dfe-8626-48a2-8863-b6fdf2b96ff1","is_guest":true},"client_id":"5ad5451d-70c7-43c6-86c9-e1d90556856c","deadlines":{"complaints":null},"description":"Trustap socks","events":{"by_key":{"created":"2026-07-30T15:49:46Z","joined":"2026-07-30T15:49:46Z"},"by_time":[{"at":"2026-07-30T15:49:46Z","code":"created"},{"at":"2026-07-30T15:49:46Z","code":"joined"}]},"funds_release":{"refunds":[],"released_to_seller":false},"id":"tx_01kysvfb1ff1j8st5akj3vqknf","metadata":{},"payment_link":"https://actions.stage.trustap.com/transactions/tx_01kysvfb1ff1j8st5akj3vqknf/pay","pricing":{"amount":20000,"amount_extra":200,"amount_postage":500,"currency":"gbp","fees":{"buyer":661,"buyer_client":0,"seller":0,"seller_client":0},"postage_bearer":"buyer"},"seller":{"id":"8e5cbedc-e57b-42e5-a3bd-2f9ced81a2d0","is_guest":false},"status":"joined"},"key":"response","summary":"response","id":"paths/~1v2~1transactions/post/responses/201/content/application~1json/examples/response"},"paths/~1v2~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/response":{"value":{"buyer":{"id":"1-def29dfe-8626-48a2-8863-b6fdf2b96ff1","is_guest":true},"client_id":"5ad5451d-70c7-43c6-86c9-e1d90556856c","deadlines":{"complaints":null},"description":"Trustap socks","events":{"by_key":{"created":"2026-07-30T15:49:46Z","joined":"2026-07-30T15:49:46Z"},"by_time":[{"at":"2026-07-30T15:49:46Z","code":"created"},{"at":"2026-07-30T15:49:46Z","code":"joined"}]},"funds_release":{"refunds":[],"released_to_seller":false},"id":"tx_01kysvfb1ff1j8st5akj3vqknf","metadata":{},"payment_link":"https://actions.stage.trustap.com/transactions/tx_01kysvfb1ff1j8st5akj3vqknf/pay","pricing":{"amount":20000,"amount_extra":200,"amount_postage":500,"currency":"gbp","fees":{"buyer":661,"buyer_client":0,"seller":0,"seller_client":0},"postage_bearer":"buyer"},"seller":{"id":"8e5cbedc-e57b-42e5-a3bd-2f9ced81a2d0","is_guest":false},"status":"joined"},"key":"response","summary":"response","id":"paths/~1v2~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1transactions~1{transaction_id}~1cancel/post/responses/200/content/application~1json/examples/response":{"value":{"buyer":{"id":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","is_guest":true},"cancellation":{"description":"Colour does not match description"},"client_id":"5a3d7990-9f1c-4e11-8d67-3da5b160c50a","deadlines":{"complaints":null},"description":"Trustap socks","events":{"by_key":{"cancelled":"2026-07-31T16:14:03Z","created":"2026-07-31T16:05:12Z","joined":"2026-07-31T16:05:12Z"},"by_time":[{"at":"2026-07-31T16:05:12Z","code":"created"},{"at":"2026-07-31T16:05:12Z","code":"joined"},{"at":"2026-07-31T16:14:03Z","code":"cancelled"}]},"funds_release":{"refunds":[],"released_to_seller":false},"id":"tx_01kyweratweaf9kv5kn2yz6966","metadata":{},"pricing":{"amount":20000,"amount_extra":0,"currency":"eur","fees":{"buyer":1050,"buyer_client":0,"seller":0,"seller_client":0}},"seller":{"id":"1-22ad0309-d966-440c-8296-9989ff65eebf","is_guest":true},"status":"cancelled"},"key":"response","summary":"response","id":"paths/~1v2~1transactions~1{transaction_id}~1cancel/post/responses/200/content/application~1json/examples/response"},"paths/~1v2~1transactions~1{transaction_id}~1claim/post/responses/200/content/application~1json/examples/response":{"value":{"buyer":{"id":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","is_guest":true},"client_id":"5a3d7990-9f1c-4e11-8d67-3da5b160c50a","deadlines":{"complaints":null},"description":"Trustap socks","events":{"by_key":{"claimed_by_seller":"2026-07-31T19:25:29Z","created":"2026-07-31T19:22:05Z","joined":"2026-07-31T19:22:05Z","paid":"2026-07-31T19:22:50Z","payment_accepted":"2026-07-31T19:23:11Z"},"by_time":[{"at":"2026-07-31T19:22:05Z","code":"created"},{"at":"2026-07-31T19:22:05Z","code":"joined"},{"at":"2026-07-31T19:22:50Z","by":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","code":"paid"},{"at":"2026-07-31T19:23:11Z","by":"9c11d028-252b-4124-bd85-21a650f6a793","code":"payment_accepted"},{"at":"2026-07-31T19:25:29Z","by":"9c11d028-252b-4124-bd85-21a650f6a793","code":"claimed_by_seller"}]},"funds_release":{"refunds":[],"released_to_seller":false},"id":"tx_01kywt0t07eaf8v1abyr7wpank","metadata":{},"payment_link":"https://actions.stage.trustap.com/transactions/tx_01kywt0t07eaf8v1abyr7wpank/pay","pricing":{"amount":20000,"amount_extra":0,"currency":"eur","fees":{"buyer":1050,"buyer_client":0,"international_payment":316,"seller":0,"seller_client":0}},"seller":{"id":"9c11d028-252b-4124-bd85-21a650f6a793","is_guest":false},"status":"payment_accepted"},"key":"response","summary":"response","id":"paths/~1v2~1transactions~1{transaction_id}~1claim/post/responses/200/content/application~1json/examples/response"},"paths/~1v2~1transactions~1{transaction_id}~1metadata/post/responses/200/content/application~1json/examples/response":{"value":{"buyer":{"id":"1-506ec116-f0b3-4ea8-bfd0-ea0e7b9d18aa","is_guest":true},"client_id":"5a3d7990-9f1c-4e11-8d67-3da5b160c50a","contains_shipping":true,"deadlines":{"complaints":null},"description":"Trustap socks","events":{"by_key":{"created":"2026-06-16T09:22:35Z","joined":"2026-06-16T09:22:35Z"},"by_time":[{"at":"2026-06-16T09:22:35Z","code":"created"},{"at":"2026-06-16T09:22:35Z","code":"joined"}]},"id":"tx_01kv7vtr9vfr5rnttm3n4x17z2","metadata":{"customer_url":"https://my-bike-parts.com/","part_number":"98932"},"pricing":{"amount":20000,"amount_extra":0,"currency":"eur","fees":{"buyer":1050,"buyer_client":0,"seller":0,"seller_client":0}},"seller":{"id":"8e5cbedc-e57b-42e5-a3bd-2f9ced81a2d0","is_guest":false},"status":"joined"},"key":"response","summary":"response","id":"paths/~1v2~1transactions~1{transaction_id}~1metadata/post/responses/200/content/application~1json/examples/response"},"paths/~1v2~1transactions~1{transaction_id}~1accept_complaint/post/responses/200/content/application~1json/examples/response":{"value":{"buyer":{"id":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","is_guest":true},"client_id":"5a3d7990-9f1c-4e11-8d67-3da5b160c50a","complaint":{"accepted":"2026-07-31T18:34:53Z","category":"other","description":"Item arrived damaged"},"deadlines":{"complaints":"2026-07-31T18:38:49Z"},"description":"Trustap socks","events":{"by_key":{"complaint_submitted":"2026-07-31T18:34:09Z","created":"2026-07-31T18:31:13Z","delivered":"2026-07-31T18:33:49Z","joined":"2026-07-31T18:31:13Z","paid":"2026-07-31T18:31:58Z","payment_accepted":"2026-07-31T18:33:07Z","refunded":"2026-07-31T18:34:52Z","tracked":"2026-07-31T18:33:38Z"},"by_time":[{"at":"2026-07-31T18:31:13Z","code":"created"},{"at":"2026-07-31T18:31:13Z","code":"joined"},{"at":"2026-07-31T18:31:58Z","by":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","code":"paid"},{"at":"2026-07-31T18:33:07Z","by":"8e5cbedc-e57b-42e5-a3bd-2f9ced81a2d0","code":"payment_accepted"},{"at":"2026-07-31T18:33:38Z","code":"tracked"},{"at":"2026-07-31T18:33:49Z","code":"delivered"},{"at":"2026-07-31T18:34:09Z","by":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","code":"complaint_submitted"},{"at":"2026-07-31T18:34:52Z","code":"refunded"}]},"funds_release":{"refunds":[{"amount":20000,"id":"4984"}],"released_to_seller":false},"id":"tx_01kywq3p00eaf8h40zmtv6mxhz","metadata":{},"pricing":{"amount":20000,"amount_extra":0,"currency":"eur","fees":{"buyer":1050,"buyer_client":0,"seller":0,"seller_client":0}},"seller":{"id":"8e5cbedc-e57b-42e5-a3bd-2f9ced81a2d0","is_guest":false},"status":"refunded","tracking":{"carrier":"ups","tracking_code":"345345123"}},"key":"response","summary":"response","id":"paths/~1v2~1transactions~1{transaction_id}~1accept_complaint/post/responses/200/content/application~1json/examples/response"},"paths/~1v2~1transactions~1{transaction_id}~1submit_complaint/post/responses/200/content/application~1json/examples/response":{"value":{"buyer":{"id":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","is_guest":true},"client_id":"5a3d7990-9f1c-4e11-8d67-3da5b160c50a","complaint":{"category":"other","description":"Item arrived damaged"},"deadlines":{"complaints":"2026-07-31T18:13:10Z"},"description":"Trustap socks","events":{"by_key":{"complaint_submitted":"2026-07-31T18:10:56Z","created":"2026-07-31T17:57:20Z","delivered":"2026-07-31T18:08:10Z","joined":"2026-07-31T17:57:20Z","paid":"2026-07-31T17:58:34Z","payment_accepted":"2026-07-31T18:02:31Z","tracked":"2026-07-31T18:03:25Z"},"by_time":[{"at":"2026-07-31T17:57:20Z","code":"created"},{"at":"2026-07-31T17:57:20Z","code":"joined"},{"at":"2026-07-31T17:58:34Z","by":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","code":"paid"},{"at":"2026-07-31T18:02:31Z","by":"1-22ad0309-d966-440c-8296-9989ff65eebf","code":"payment_accepted"},{"at":"2026-07-31T18:03:25Z","code":"tracked"},{"at":"2026-07-31T18:08:10Z","code":"delivered"},{"at":"2026-07-31T18:10:56Z","by":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","code":"complaint_submitted"}]},"funds_release":{"refunds":[],"released_to_seller":false},"id":"tx_01kywn5ma0eafbk92b1qvfv1dw","metadata":{},"pricing":{"amount":20000,"amount_extra":0,"currency":"eur","fees":{"buyer":1050,"buyer_client":0,"international_payment":316,"seller":0,"seller_client":0}},"seller":{"id":"1-22ad0309-d966-440c-8296-9989ff65eebf","is_guest":true},"status":"complaint_submitted","tracking":{"carrier":"ups","tracking_code":"345345123"}},"key":"response","summary":"response","id":"paths/~1v2~1transactions~1{transaction_id}~1submit_complaint/post/responses/200/content/application~1json/examples/response"},"paths/~1v2~1transactions~1{transaction_id}~1submit_order_issue/post/responses/200/content/application~1json/examples/response":{"value":{"buyer":{"id":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","is_guest":true},"client_id":"5a3d7990-9f1c-4e11-8d67-3da5b160c50a","deadlines":{"complaints":null},"description":"Trustap socks","events":{"by_key":{"created":"2026-07-31T18:38:12Z","joined":"2026-07-31T18:38:12Z","order_issue_submitted":"2026-07-31T18:42:20Z","paid":"2026-07-31T18:39:02Z","payment_accepted":"2026-07-31T18:39:24Z"},"by_time":[{"at":"2026-07-31T18:38:12Z","code":"created"},{"at":"2026-07-31T18:38:12Z","code":"joined"},{"at":"2026-07-31T18:39:02Z","by":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","code":"paid"},{"at":"2026-07-31T18:39:24Z","by":"8e5cbedc-e57b-42e5-a3bd-2f9ced81a2d0","code":"payment_accepted"},{"at":"2026-07-31T18:42:20Z","by":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","code":"order_issue_submitted"}]},"funds_release":{"refunds":[],"released_to_seller":false},"id":"tx_01kywqgetdeafageg8d7ntam8f","metadata":{},"order_issue":{"category":"item_not_received","description":"No contact from seller"},"pricing":{"amount":20000,"amount_extra":0,"currency":"eur","fees":{"buyer":1050,"buyer_client":0,"seller":0,"seller_client":0}},"seller":{"id":"8e5cbedc-e57b-42e5-a3bd-2f9ced81a2d0","is_guest":false},"status":"payment_accepted"},"key":"response","summary":"response","id":"paths/~1v2~1transactions~1{transaction_id}~1submit_order_issue/post/responses/200/content/application~1json/examples/response"},"paths/~1v2~1transactions~1{transaction_id}~1confirm_delivery/post/responses/200/content/application~1json/examples/response":{"value":{"buyer":{"id":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","is_guest":true},"client_id":"5a3d7990-9f1c-4e11-8d67-3da5b160c50a","deadlines":{"complaints":"2026-07-31T18:13:10Z"},"description":"Trustap socks","events":{"by_key":{"created":"2026-07-31T17:57:20Z","delivered":"2026-07-31T18:08:10Z","joined":"2026-07-31T17:57:20Z","paid":"2026-07-31T17:58:34Z","payment_accepted":"2026-07-31T18:02:31Z","tracked":"2026-07-31T18:03:25Z"},"by_time":[{"at":"2026-07-31T17:57:20Z","code":"created"},{"at":"2026-07-31T17:57:20Z","code":"joined"},{"at":"2026-07-31T17:58:34Z","by":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","code":"paid"},{"at":"2026-07-31T18:02:31Z","by":"1-22ad0309-d966-440c-8296-9989ff65eebf","code":"payment_accepted"},{"at":"2026-07-31T18:03:25Z","code":"tracked"},{"at":"2026-07-31T18:08:10Z","code":"delivered"}]},"funds_release":{"refunds":[],"released_to_seller":false},"id":"tx_01kywn5ma0eafbk92b1qvfv1dw","metadata":{},"pricing":{"amount":20000,"amount_extra":0,"currency":"eur","fees":{"buyer":1050,"buyer_client":0,"international_payment":316,"seller":0,"seller_client":0}},"seller":{"id":"1-22ad0309-d966-440c-8296-9989ff65eebf","is_guest":true},"status":"delivered","tracking":{"carrier":"ups","tracking_code":"345345123"}},"key":"response","summary":"response","id":"paths/~1v2~1transactions~1{transaction_id}~1confirm_delivery/post/responses/200/content/application~1json/examples/response"},"paths/~1v2~1transactions~1{transaction_id}~1track/post/responses/200/content/application~1json/examples/response":{"value":{"buyer":{"id":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","is_guest":true},"client_id":"5a3d7990-9f1c-4e11-8d67-3da5b160c50a","deadlines":{"complaints":null},"description":"Trustap socks","events":{"by_key":{"created":"2026-07-31T17:57:20Z","joined":"2026-07-31T17:57:20Z","paid":"2026-07-31T17:58:34Z","payment_accepted":"2026-07-31T18:02:31Z","tracked":"2026-07-31T18:03:25Z"},"by_time":[{"at":"2026-07-31T17:57:20Z","code":"created"},{"at":"2026-07-31T17:57:20Z","code":"joined"},{"at":"2026-07-31T17:58:34Z","by":"1-a5034d6a-1110-4d33-b6dd-c6ff1b3b2e28","code":"paid"},{"at":"2026-07-31T18:02:31Z","by":"1-22ad0309-d966-440c-8296-9989ff65eebf","code":"payment_accepted"},{"at":"2026-07-31T18:03:25Z","code":"tracked"}]},"funds_release":{"refunds":[],"released_to_seller":false},"id":"tx_01kywn5ma0eafbk92b1qvfv1dw","metadata":{},"pricing":{"amount":20000,"amount_extra":0,"currency":"eur","fees":{"buyer":1050,"buyer_client":0,"international_payment":316,"seller":0,"seller_client":0}},"seller":{"id":"1-22ad0309-d966-440c-8296-9989ff65eebf","is_guest":true},"status":"tracked","tracking":{"carrier":"ups","tracking_code":"345345123"}},"key":"response","summary":"response","id":"paths/~1v2~1transactions~1{transaction_id}~1track/post/responses/200/content/application~1json/examples/response"}},"securitySchemeStore":{"APIKey":{"id":"APIKey","type":"http","scheme":"basic"},"OAuth2":{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/auth","tokenUrl":"https://sso.trustap.com/auth/realms/trustap-stage/protocol/openid-connect/token","scopes":{}}}}},"servers":[{"url":"https://api.test.trustap.com"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/@v2.0/openapi.json?download"},{"url":"/_bundle/apis/@v2.0/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Trustap API","description":"The Trustap API is a REST-based API for managing user data and\ntransactions for Trustap users.\n\nNote that, like Stripe, all API `price` and `charge` fields expect\namounts to be provided in a currency's smallest unit. See [the Stripe\ndocumentation](https://stripe.com/docs/currencies#zero-decimal) for more\ndetails.\n\nAPI Keys\n--------\n\nSome endpoints such as `/charge` endpoints can be accessed directly\nusing an API key. API keys are provided as the \"username\" portion of a\nbasic auth authentication. For example, the Trustap fee for a \ntransaction can be determined using the following cURL request with an\nAPI key:\n\n``` bash\ncurl -i -X GET -u '<API_KEY>:'​ 'https://api.test.trustap.com/v2/fees?currency=usd&amount=896'\n```\n\nDeprecation\n-----------\n\nDeprecated endpoints are tagged with the word `DEPRECATED` at the start\nof their description. The deprecation message will describe what\nendpoints/approach should be used instead.\n\nNote that deprecated endpoints will not be removed from the current\nversion of the API, but their use is discouraged. Furthermore, migrating\nto later major versions of the API will be made easier by avoiding\ndeprecated endpoints.\n\nProduction\n----------\n\nThis documentation references the staging environment of the Trustap\nAPI, which is available at `https://api.test.trustap.com` and uses the\n`trustap-stage` realm during authentication. This environment can be\nused for implementing and testing features using test credit cards, bank\naccounts, etc.\n\nWhen all features using Trustap have been implemented and tested\nsufficiently, the production environment of the Trustap API can be used\nto process actual currency. This environment is available at\n`https://api.trustap.com` and uses the `trustap` realm during\nauthentication.\n\nNote that only your client ID will be the same in the staging and\nproduction Trustap API environments; your client secret and API key will\nbe different in the two environments.\n"}},"baseSlug":"/apis/openapi","routesMapping":{}}