{"items":[{"type":"link","label":"Easypay Payments API","link":"/pt/openapi","routeSlug":"/pt/openapi","content":{"contentType":"overview","meta":{"name":"Easypay Payments API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/@l10n/pt/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/@l10n/pt/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"Easypay Documentation","email":"correio@easypay.pt","label":"correio@easypay.pt","withCopyButton":true,"copyContent":"correio@easypay.pt"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"MIT","url":"https://spdx.org/licenses/MIT"}]},{"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.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Easypay Payments API (2.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.easypay.pt/en/legal-terms-and-conditions/","className":"item"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terms conditions and legal terms"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.easypay.pt/en/privacy-and-data-protection-policy/","className":"item"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Privacy Policy"},"children":[]}]}]}]}]}],"sectionId":"/pt/openapi"}],"sectionId":"/pt/openapi"}]}]}},{"type":"group","label":"Single Payment","link":"/pt/openapi/single-payment","routeSlug":"/pt/openapi/single-payment","items":[{"label":"Lists single payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/single-payment/single-get","routeSlug":"/pt/openapi/single-payment/single-get","metadata":{"seo":{"title":"Lists single payments","description":"Full report with all the single payments from your Account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"single-get","name":"Lists single payments","isWebhook":false,"pointer":"/paths/~1single/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists single payments","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":"Full report with all the single payments from your Account"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_210","description":"Specifies the page number of the results to retrieve. This parameter is used for paginating through a collection of records, allowing the client to navigate to different pages of the dataset. The value must be a positive integer (e.g., \"1\" for the first page)."},{"name":"records_per_page","in":"query","schemaId":"schema_211","description":"Specifies the number of records to retrieve per page. This parameter is used for controlling the size of each page in a paginated collection of records. The value must be a positive integer, determining how many records are displayed on each page (e.g., \"20\" for 20 records per page)."},{"name":"type","in":"query","schemaId":"schema_212","description":"Filter by type of financial operation being performed. Possible values are \"Sale\" (a complete transaction where funds are immediately captured) or \"Authorisation\" (a temporary hold on funds pending a future capture)."},{"name":"expiration_time","in":"query","schemaId":"schema_213","description":"Filter records by expiration datetime interval. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)"},{"name":"method","in":"query","schemaId":"schema_214","description":"Filter by payment method used in the transaction."},{"name":"customer","in":"query","schemaId":"schema_215","description":"A user-defined identifier used to filter the customers. This parameter allows the client to specify a key to retrieve records or transactions that match the provided key. The value is a string and may not be unique, as it is determined by the user."},{"name":"id","in":"query","schemaId":"schema_216","description":"Filter by the unique identifier for the resource. Typically formatted as a UUID (Universally Unique Identifier)."},{"name":"key","in":"query","schemaId":"schema_217","description":"A user-defined identifier used to filter the results. This parameter allows the client to specify a key to retrieve records or transactions that match the provided key. The value is a string and may not be unique, as it is determined by the user."},{"name":"value","in":"query","schemaId":"schema_218","description":"Filter records by the exact transaction amount."},{"name":"created_at","in":"query","schemaId":"schema_213","description":"Filter records by creation datetime interval in UTC. Maximum allowed range is 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)."}],"pointer":"/paths/~1single/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/single","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_210"},{"name":"records_per_page","in":"query","required":false,"example":20,"schemaId":"schema_211"},{"name":"type","in":"query","required":false,"example":"sale","schemaId":"schema_212"},{"name":"expiration_time","in":"query","required":false,"example":"interval(2006-01-02 15:04,2006-01-02 15:04)","schemaId":"schema_213"},{"name":"method","in":"query","required":false,"example":"MB","schemaId":"schema_214"},{"name":"customer","in":"query","required":false,"example":"01J32EDWGNX94XMWP8PWB23KBK","schemaId":"schema_215"},{"name":"id","in":"query","required":false,"example":"bb3e7e60-20f3-4208-9b21-64c635a51f42","schemaId":"schema_216"},{"name":"key","in":"query","required":false,"example":"01J32EESEC1Z543P7J3PKSF1Q9","schemaId":"schema_217"},{"name":"value","in":"query","example":10.32,"schemaId":"schema_218"},{"name":"created_at","in":"query","required":false,"example":"interval(2006-01-02 15:04,2006-01-02 15:04)","schemaId":"schema_213"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","403","404","412","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/single","href":"single-payment/single-get","openApiOperationId":"single-get","summary":"Lists single payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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_219","exampleIds":["paths/~1single/get/responses/200/content/application~1json/examples/List All"]}},"schemaId":"schema_219","exampleIds":["paths/~1single/get/responses/200/content/application~1json/examples/List All"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1single/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_219","exampleIds":["paths/~1single/get/responses/200/content/application~1json/examples/List All"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_219","exampleIds":["paths/~1single/get/responses/200/content/application~1json/examples/List All"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/single-payment/single-get"}],"panels":[]}]},"httpPath":"/single"},{"label":"Create single payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/single-payment/single-post","routeSlug":"/pt/openapi/single-payment/single-post","metadata":{"seo":{"title":"Create single payment","description":"Creates a Single Payment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"single-post","name":"Create single payment","isWebhook":false,"pointer":"/paths/~1single/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create single payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a Single Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single:create"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_221","exampleIds":["paths/~1single/post/requestBody/content/application~1json/examples/Multibanco","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product SPG","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product FILE","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product CHECKDIGIT","paths/~1single/post/requestBody/content/application~1json/examples/Direct Debit","paths/~1single/post/requestBody/content/application~1json/examples/CC Authorisation","paths/~1single/post/requestBody/content/application~1json/examples/CC Sale","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Authorisation","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Sale","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Sale with dedicated payer phone","paths/~1single/post/requestBody/content/application~1json/examples/Virtual IBAN","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Reward Redemption","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits and Rewards","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits and Reward Redemption","paths/~1single/post/requestBody/content/application~1json/examples/IPP Sale"]}},"schemaId":"schema_221","exampleIds":["paths/~1single/post/requestBody/content/application~1json/examples/Multibanco","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product SPG","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product FILE","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product CHECKDIGIT","paths/~1single/post/requestBody/content/application~1json/examples/Direct Debit","paths/~1single/post/requestBody/content/application~1json/examples/CC Authorisation","paths/~1single/post/requestBody/content/application~1json/examples/CC Sale","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Authorisation","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Sale","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Sale with dedicated payer phone","paths/~1single/post/requestBody/content/application~1json/examples/Virtual IBAN","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Reward Redemption","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits and Rewards","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits and Reward Redemption","paths/~1single/post/requestBody/content/application~1json/examples/IPP Sale"],"pointer":"/paths/~1single/post/requestBody","description":"Configuration object to generate a single payment"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/single","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_221","exampleIds":["paths/~1single/post/requestBody/content/application~1json/examples/Multibanco","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product SPG","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product FILE","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product CHECKDIGIT","paths/~1single/post/requestBody/content/application~1json/examples/Direct Debit","paths/~1single/post/requestBody/content/application~1json/examples/CC Authorisation","paths/~1single/post/requestBody/content/application~1json/examples/CC Sale","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Authorisation","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Sale","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Sale with dedicated payer phone","paths/~1single/post/requestBody/content/application~1json/examples/Virtual IBAN","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Reward Redemption","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits and Rewards","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits and Reward Redemption","paths/~1single/post/requestBody/content/application~1json/examples/IPP Sale"]}},"responseCodes":["201","400","403","404","409","412","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/single","href":"single-payment/single-post","openApiOperationId":"single-post","summary":"Create single payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_221","exampleIds":["paths/~1single/post/requestBody/content/application~1json/examples/Multibanco","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product SPG","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product FILE","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product CHECKDIGIT","paths/~1single/post/requestBody/content/application~1json/examples/Direct Debit","paths/~1single/post/requestBody/content/application~1json/examples/CC Authorisation","paths/~1single/post/requestBody/content/application~1json/examples/CC Sale","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Authorisation","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Sale","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Sale with dedicated payer phone","paths/~1single/post/requestBody/content/application~1json/examples/Virtual IBAN","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Reward Redemption","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits and Rewards","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits and Reward Redemption","paths/~1single/post/requestBody/content/application~1json/examples/IPP Sale"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_221","exampleIds":["paths/~1single/post/requestBody/content/application~1json/examples/Multibanco","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product SPG","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product FILE","paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product CHECKDIGIT","paths/~1single/post/requestBody/content/application~1json/examples/Direct Debit","paths/~1single/post/requestBody/content/application~1json/examples/CC Authorisation","paths/~1single/post/requestBody/content/application~1json/examples/CC Sale","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Authorisation","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Sale","paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Sale with dedicated payer phone","paths/~1single/post/requestBody/content/application~1json/examples/Virtual IBAN","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Reward Redemption","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits and Rewards","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits","paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits and Reward Redemption","paths/~1single/post/requestBody/content/application~1json/examples/IPP Sale"]}},"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":"schema_222","exampleIds":["paths/~1single/post/responses/201/content/application~1json/examples/Created Direct Debit with success","paths/~1single/post/responses/201/content/application~1json/examples/Created Digital IBAN with success","paths/~1single/post/responses/201/content/application~1json/examples/Created Multibanco with success","paths/~1single/post/responses/201/content/application~1json/examples/Created Credit Card with success","paths/~1single/post/responses/201/content/application~1json/examples/Created MB Way with success","paths/~1single/post/responses/201/content/application~1json/examples/Created MB WAY with dedicated payer phone","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Reward Redemption","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits and Rewards","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits and Reward Redemption"]}},"schemaId":"schema_222","exampleIds":["paths/~1single/post/responses/201/content/application~1json/examples/Created Direct Debit with success","paths/~1single/post/responses/201/content/application~1json/examples/Created Digital IBAN with success","paths/~1single/post/responses/201/content/application~1json/examples/Created Multibanco with success","paths/~1single/post/responses/201/content/application~1json/examples/Created Credit Card with success","paths/~1single/post/responses/201/content/application~1json/examples/Created MB Way with success","paths/~1single/post/responses/201/content/application~1json/examples/Created MB WAY with dedicated payer phone","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Reward Redemption","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits and Rewards","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits and Reward Redemption"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/404/content/application~1json/examples/Resource not found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/409/content/application~1json/examples/conflict"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1single/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_222","exampleIds":["paths/~1single/post/responses/201/content/application~1json/examples/Created Direct Debit with success","paths/~1single/post/responses/201/content/application~1json/examples/Created Digital IBAN with success","paths/~1single/post/responses/201/content/application~1json/examples/Created Multibanco with success","paths/~1single/post/responses/201/content/application~1json/examples/Created Credit Card with success","paths/~1single/post/responses/201/content/application~1json/examples/Created MB Way with success","paths/~1single/post/responses/201/content/application~1json/examples/Created MB WAY with dedicated payer phone","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Reward Redemption","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits and Rewards","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits and Reward Redemption"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_222","exampleIds":["paths/~1single/post/responses/201/content/application~1json/examples/Created Direct Debit with success","paths/~1single/post/responses/201/content/application~1json/examples/Created Digital IBAN with success","paths/~1single/post/responses/201/content/application~1json/examples/Created Multibanco with success","paths/~1single/post/responses/201/content/application~1json/examples/Created Credit Card with success","paths/~1single/post/responses/201/content/application~1json/examples/Created MB Way with success","paths/~1single/post/responses/201/content/application~1json/examples/Created MB WAY with dedicated payer phone","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Reward Redemption","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits and Rewards","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits","paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits and Reward Redemption"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"409","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single/post/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/single-payment/single-post"}],"panels":[]}]},"httpPath":"/single"},{"label":"Shows single payment details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/single-payment/single-id-get","routeSlug":"/pt/openapi/single-payment/single-id-get","metadata":{"seo":{"title":"Shows single payment details","description":"Retrieve a single payment details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"single-id-get","name":"Shows single payment details","isWebhook":false,"pointer":"/paths/~1single~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shows single payment details","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":"Retrieve a single payment details"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1single~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/single/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","403","404","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/single/{id}","href":"single-payment/single-id-get","openApiOperationId":"single-id-get","summary":"Shows single payment details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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_224","exampleIds":["paths/~1single~1{id}/get/responses/200/content/application~1json/examples/IPP Payment","paths/~1single~1{id}/get/responses/200/content/application~1json/examples/MB WAY with dedicated payer phone","paths/~1single~1{id}/get/responses/200/content/application~1json/examples/Sale with Reward Redemption"]}},"schemaId":"schema_224","exampleIds":["paths/~1single~1{id}/get/responses/200/content/application~1json/examples/IPP Payment","paths/~1single~1{id}/get/responses/200/content/application~1json/examples/MB WAY with dedicated payer phone","paths/~1single~1{id}/get/responses/200/content/application~1json/examples/Sale with Reward Redemption"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1single~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_224","exampleIds":["paths/~1single~1{id}/get/responses/200/content/application~1json/examples/IPP Payment","paths/~1single~1{id}/get/responses/200/content/application~1json/examples/MB WAY with dedicated payer phone","paths/~1single~1{id}/get/responses/200/content/application~1json/examples/Sale with Reward Redemption"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1single~1{id}/get/responses/200/content/application~1json/examples/IPP Payment","paths/~1single~1{id}/get/responses/200/content/application~1json/examples/MB WAY with dedicated payer phone","paths/~1single~1{id}/get/responses/200/content/application~1json/examples/Sale with Reward Redemption"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/single-payment/single-id-get"}],"panels":[]}]},"httpPath":"/single/{id}"},{"label":"Deletes single payment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/single-payment/single-delete","routeSlug":"/pt/openapi/single-payment/single-delete","metadata":{"seo":{"title":"Deletes single payment","description":"This endpoint allows for the deletion of a single payment identified by its unique ID. The DELETE operation performs the following actions based on the payment method:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"single-delete","name":"Deletes single payment","isWebhook":false,"pointer":"/paths/~1single~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes single payment","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 endpoint allows for the deletion of a single payment identified by its unique ID. The DELETE operation performs the following actions based on the payment method:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MB WAY and Credit Cards: Voids all authorizations."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multibanco: Cancels the Multibanco Reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Debit: Cancels the Direct Debit if the request is made before the cutoff hour(18:00 Europe/Lisbon)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation ensures that all associated authorizations and references are properly handled and terminated according to the specified payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single:delete"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1single~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/single/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["204","400","403","404","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/single/{id}","href":"single-payment/single-delete","openApiOperationId":"single-delete","summary":"Deletes single payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1single~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/delete/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/single-payment/single-delete"}],"panels":[]}]},"httpPath":"/single/{id}"},{"label":"Update a single Payment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/single-payment/single-update","routeSlug":"/pt/openapi/single-payment/single-update","metadata":{"seo":{"title":"Update a single Payment","description":"Apply partial modifications to a single payment resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"single-update","name":"Update a single Payment","isWebhook":false,"pointer":"/paths/~1single~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a single Payment","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":"Apply partial modifications to a single payment resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single:update"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1single~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_225"}},"schemaId":"schema_225","pointer":"/paths/~1single~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/single/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_225"}},"responseCodes":["200","400","403","404","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/single/{id}","href":"single-payment/single-update","openApiOperationId":"single-update","summary":"Update a single Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_225","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_225"}},"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_226","exampleIds":["paths/~1single~1{id}/patch/responses/200/content/application~1json/examples/Example 1"]}},"schemaId":"schema_226","exampleIds":["paths/~1single~1{id}/patch/responses/200/content/application~1json/examples/Example 1"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/patch/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/patch/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1single~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_226","exampleIds":["paths/~1single~1{id}/patch/responses/200/content/application~1json/examples/Example 1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_226","exampleIds":["paths/~1single~1{id}/patch/responses/200/content/application~1json/examples/Example 1"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/patch/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1single~1{id}/patch/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/single-payment/single-update"}],"panels":[]}]},"httpPath":"/single/{id}"}],"content":{"contentType":"group","meta":{"name":"Single Payment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Single Payment","showPageActions":true},{"nodeType":"markdoc","content":"Create and manage one-time payment transactions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/single","summary":"Lists single payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/single-payment/single-get","deprecated":false},{"title":"/single","summary":"Create single payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/single-payment/single-post","deprecated":false},{"title":"/single/{id}","summary":"Shows single payment details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/single-payment/single-id-get","deprecated":false},{"title":"/single/{id}","summary":"Deletes single payment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/single-payment/single-delete","deprecated":false},{"title":"/single/{id}","summary":"Update a single Payment","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/single-payment/single-update","deprecated":false}]}]}]}]}},{"type":"group","label":"Frequent Payment","link":"/pt/openapi/frequent-payment","routeSlug":"/pt/openapi/frequent-payment","items":[{"label":"Lists frequent payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/frequent-payment/frequent-get","routeSlug":"/pt/openapi/frequent-payment/frequent-get","metadata":{"seo":{"title":"Lists frequent payments","description":"Full report with all the frequent payments from your Account Id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"frequent-get","name":"Lists frequent payments","isWebhook":false,"pointer":"/paths/~1frequent/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists frequent payments","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":"Full report with all the frequent payments from your Account Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frequent:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_210","description":"Specifies the page number of the results to retrieve. This parameter is used for paginating through a collection of records, allowing the client to navigate to different pages of the dataset. The value must be a positive integer (e.g., \"1\" for the first page)."},{"name":"records_per_page","in":"query","schemaId":"schema_211","description":"Specifies the number of records to retrieve per page. This parameter is used for controlling the size of each page in a paginated collection of records. The value must be a positive integer, determining how many records are displayed on each page (e.g., \"20\" for 20 records per page)."},{"name":"expiration_time","in":"query","schemaId":"schema_213","description":"Filter records by expiration datetime interval. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)"},{"name":"method","in":"query","schemaId":"schema_214","description":"Filter by payment method used in the transaction."},{"name":"customer","in":"query","schemaId":"schema_215","description":"A user-defined identifier used to filter the customers. This parameter allows the client to specify a key to retrieve records or transactions that match the provided key. The value is a string and may not be unique, as it is determined by the user."},{"name":"id","in":"query","schemaId":"schema_216","description":"Filter by the unique identifier for the resource. Typically formatted as a UUID (Universally Unique Identifier)."},{"name":"key","in":"query","schemaId":"schema_217","description":"A user-defined identifier used to filter the results. This parameter allows the client to specify a key to retrieve records or transactions that match the provided key. The value is a string and may not be unique, as it is determined by the user."},{"name":"created_at","in":"query","schemaId":"schema_213","description":"Filter records by creation datetime interval in UTC. Maximum allowed range is 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)."}],"pointer":"/paths/~1frequent/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/frequent","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_210"},{"name":"records_per_page","in":"query","required":false,"example":20,"schemaId":"schema_211"},{"name":"expiration_time","in":"query","required":false,"example":"interval(2006-01-02 15:04,2006-01-02 15:04)","schemaId":"schema_213"},{"name":"method","in":"query","required":false,"example":"MB","schemaId":"schema_214"},{"name":"customer","in":"query","required":false,"example":"01J32EDWGNX94XMWP8PWB23KBK","schemaId":"schema_215"},{"name":"id","in":"query","required":false,"example":"bb3e7e60-20f3-4208-9b21-64c635a51f42","schemaId":"schema_216"},{"name":"key","in":"query","required":false,"example":"01J32EESEC1Z543P7J3PKSF1Q9","schemaId":"schema_217"},{"name":"created_at","in":"query","required":false,"example":"interval(2006-01-02 15:04,2006-01-02 15:04)","schemaId":"schema_213"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","403","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/frequent","href":"frequent-payment/frequent-get","openApiOperationId":"frequent-get","summary":"Lists frequent payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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_227","exampleIds":["paths/~1frequent/get/responses/200/content/application~1json/examples/Response"]}},"schemaId":"schema_227","exampleIds":["paths/~1frequent/get/responses/200/content/application~1json/examples/Response"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1frequent/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_227","exampleIds":["paths/~1frequent/get/responses/200/content/application~1json/examples/Response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_227","exampleIds":["paths/~1frequent/get/responses/200/content/application~1json/examples/Response"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/frequent-payment/frequent-get"}],"panels":[]}]},"httpPath":"/frequent"},{"label":"Create frequent payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/frequent-payment/post_frequent","routeSlug":"/pt/openapi/frequent-payment/post_frequent","metadata":{"seo":{"title":"Create frequent payment","description":"Frequent payments are repeatable transactions of varying sums without the client having to enter their payment details again."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post_frequent","name":"Create frequent payment","isWebhook":false,"pointer":"/paths/~1frequent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create frequent payment","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":"Frequent payments are repeatable transactions of varying sums without the client having to enter their payment details again."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is possible to limit the transferred sums by choosing minimum or maximum values, either to the total sum of the transactions or each individual transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported methods for frequent payments are: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{"style":{"color":"red"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Card, MB WAY, Multibanco, Direct Debit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{"style":{"color":"red"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Virtual IBAN"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frequent:create"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_228","exampleIds":["paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment DD","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment CC","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment MBW","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment MB","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment VI"]}},"schemaId":"schema_228","exampleIds":["paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment DD","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment CC","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment MBW","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment MB","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment VI"],"pointer":"/paths/~1frequent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/frequent","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_228","exampleIds":["paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment DD","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment CC","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment MBW","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment MB","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment VI"]}},"responseCodes":["201","400","403","412","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/frequent","href":"frequent-payment/post_frequent","openApiOperationId":"post_frequent","summary":"Create frequent payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_228","exampleIds":["paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment DD","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment CC","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment MBW","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment MB","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment VI"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_228","exampleIds":["paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment DD","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment CC","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment MBW","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment MB","paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment VI"]}},"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":"schema_229","exampleIds":["paths/~1frequent/post/responses/201/content/application~1json/examples/Response from CC method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from DD method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from MB method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from VI method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from MBW method"]}},"schemaId":"schema_229","exampleIds":["paths/~1frequent/post/responses/201/content/application~1json/examples/Response from CC method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from DD method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from MB method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from VI method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from MBW method"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1frequent/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_229","exampleIds":["paths/~1frequent/post/responses/201/content/application~1json/examples/Response from CC method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from DD method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from MB method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from VI method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from MBW method"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229","exampleIds":["paths/~1frequent/post/responses/201/content/application~1json/examples/Response from CC method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from DD method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from MB method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from VI method","paths/~1frequent/post/responses/201/content/application~1json/examples/Response from MBW method"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent/post/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/frequent-payment/post_frequent"}],"panels":[]}]},"httpPath":"/frequent"},{"label":"Shows frequent payment details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/frequent-payment/frequent-id-get","routeSlug":"/pt/openapi/frequent-payment/frequent-id-get","metadata":{"seo":{"title":"Shows frequent payment details","description":"Retrieve a Frequent Payment details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"frequent-id-get","name":"Shows frequent payment details","isWebhook":false,"pointer":"/paths/~1frequent~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shows frequent payment details","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":"Retrieve a Frequent Payment details"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frequent:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1frequent~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/frequent/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/frequent/{id}","href":"frequent-payment/frequent-id-get","openApiOperationId":"frequent-id-get","summary":"Shows frequent payment details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/frequent-with-transactions","exampleIds":["paths/~1frequent~1{id}/get/responses/200/content/application~1json/examples/Response"]}},"schemaId":"components/schemas/frequent-with-transactions","exampleIds":["paths/~1frequent~1{id}/get/responses/200/content/application~1json/examples/Response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1frequent~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/frequent-with-transactions","exampleIds":["paths/~1frequent~1{id}/get/responses/200/content/application~1json/examples/Response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/frequent-with-transactions","exampleIds":["paths/~1frequent~1{id}/get/responses/200/content/application~1json/examples/Response"]}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/frequent-payment/frequent-id-get"}],"panels":[]}]},"httpPath":"/frequent/{id}"},{"label":"Deletes frequent payment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/frequent-payment/delete_frequent_id","routeSlug":"/pt/openapi/frequent-payment/delete_frequent_id","metadata":{"seo":{"title":"Deletes frequent payment","description":"3 times a day (10am, 3pm and 10pm) our system will attempt to close your deleted MB payments.All CC and MBW authorisations will be deleted, releasing the funds.All MBW operations waiting for user interaction will be cancelled.Before 6pm all Sepa Direct Debits waiting for file processing will be cancelled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_frequent_id","name":"Deletes frequent payment","isWebhook":false,"pointer":"/paths/~1frequent~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes frequent payment","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":"3 times a day (10am, 3pm and 10pm) our system will attempt to close your deleted MB payments."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All CC and MBW authorisations will be deleted, releasing the funds."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All MBW operations waiting for user interaction will be cancelled."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before 6pm all Sepa Direct Debits waiting for file processing will be cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frequent:delete"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1frequent~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/frequent/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/frequent/{id}","href":"frequent-payment/delete_frequent_id","openApiOperationId":"delete_frequent_id","summary":"Deletes frequent payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1frequent~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/frequent-payment/delete_frequent_id"}],"panels":[]}]},"httpPath":"/frequent/{id}"},{"label":"Updates frequent payment details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/frequent-payment/patch_frequent_id","routeSlug":"/pt/openapi/frequent-payment/patch_frequent_id","metadata":{"seo":{"title":"Updates frequent payment details","description":"Required scope: frequent:update"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch_frequent_id","name":"Updates frequent payment details","isWebhook":false,"pointer":"/paths/~1frequent~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates frequent payment details","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frequent:update"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1frequent~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_230","exampleIds":["paths/~1frequent~1{id}/patch/requestBody/content/application~1json/examples/Update frequent payment"]}},"schemaId":"schema_230","exampleIds":["paths/~1frequent~1{id}/patch/requestBody/content/application~1json/examples/Update frequent payment"],"pointer":"/paths/~1frequent~1{id}/patch/requestBody","description":"Frequent Payment object to edit existing one"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/frequent/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_230","exampleIds":["paths/~1frequent~1{id}/patch/requestBody/content/application~1json/examples/Update frequent payment"]}},"responseCodes":["200","400","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/frequent/{id}","href":"frequent-payment/patch_frequent_id","openApiOperationId":"patch_frequent_id","summary":"Updates frequent payment details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_230","exampleIds":["paths/~1frequent~1{id}/patch/requestBody/content/application~1json/examples/Update frequent payment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_230","exampleIds":["paths/~1frequent~1{id}/patch/requestBody/content/application~1json/examples/Update frequent payment"]}},"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","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1frequent~1{id}/patch/responses/200/content/application~1json/examples/Full Response","paths/~1frequent~1{id}/patch/responses/200/content/application~1json/examples/Response from CC Method"]},"application/xml":{}},"schemaId":"schema_231","exampleIds":["paths/~1frequent~1{id}/patch/responses/200/content/application~1json/examples/Full Response","paths/~1frequent~1{id}/patch/responses/200/content/application~1json/examples/Response from CC Method"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1frequent~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_231","exampleIds":["paths/~1frequent~1{id}/patch/responses/200/content/application~1json/examples/Full Response","paths/~1frequent~1{id}/patch/responses/200/content/application~1json/examples/Response from CC Method"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1frequent~1{id}/patch/responses/200/content/application~1json/examples/Full Response","paths/~1frequent~1{id}/patch/responses/200/content/application~1json/examples/Response from CC Method"]},"application/xml":{}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1{id}/patch/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/frequent-payment/patch_frequent_id"}],"panels":[]}]},"httpPath":"/frequent/{id}"},{"label":"Request Authorisation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/frequent-payment/frequent-authorisation","routeSlug":"/pt/openapi/frequent-payment/frequent-authorisation","metadata":{"seo":{"title":"Request Authorisation","description":"Create a new authorisation on a given Frequent Payment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"frequent-authorisation","name":"Request Authorisation","isWebhook":false,"pointer":"/paths/~1frequent~1authorisation~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request Authorisation","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":"Create a new authorisation on a given Frequent Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frequent:create"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1frequent~1authorisation~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_232","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create MB WAY Frequent Authorisation","paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create CC Frequent Authorisation","paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create CC Frequent Authorisation with 3DS authentication"]}},"schemaId":"schema_232","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create MB WAY Frequent Authorisation","paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create CC Frequent Authorisation","paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create CC Frequent Authorisation with 3DS authentication"],"pointer":"/paths/~1frequent~1authorisation~1{id}/post/requestBody","description":"Payment configuration object to generate a payment"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/frequent/authorisation/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_232","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create MB WAY Frequent Authorisation","paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create CC Frequent Authorisation","paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create CC Frequent Authorisation with 3DS authentication"]}},"responseCodes":["201","400","403","404","412","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/frequent/authorisation/{id}","href":"frequent-payment/frequent-authorisation","openApiOperationId":"frequent-authorisation","summary":"Request Authorisation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_232","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create MB WAY Frequent Authorisation","paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create CC Frequent Authorisation","paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create CC Frequent Authorisation with 3DS authentication"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_232","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create MB WAY Frequent Authorisation","paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create CC Frequent Authorisation","paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create CC Frequent Authorisation with 3DS authentication"]}},"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":"schema_233","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/201/content/application~1json/examples/Response"]}},"schemaId":"schema_233","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/201/content/application~1json/examples/Response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/404/content/application~1json/examples/Resource not found"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1frequent~1authorisation~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_233","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/201/content/application~1json/examples/Response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_233","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/201/content/application~1json/examples/Response"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1frequent~1authorisation~1{id}/post/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/frequent-payment/frequent-authorisation"}],"panels":[]}]},"httpPath":"/frequent/authorisation/{id}"}],"content":{"contentType":"group","meta":{"name":"Frequent Payment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Frequent Payment","showPageActions":true},{"nodeType":"markdoc","content":"Tokenize payment details for variable on-demand charges"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/frequent","summary":"Lists frequent payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/frequent-payment/frequent-get","deprecated":false},{"title":"/frequent","summary":"Create frequent payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/frequent-payment/post_frequent","deprecated":false},{"title":"/frequent/{id}","summary":"Shows frequent payment details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/frequent-payment/frequent-id-get","deprecated":false},{"title":"/frequent/{id}","summary":"Deletes frequent payment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/frequent-payment/delete_frequent_id","deprecated":false},{"title":"/frequent/{id}","summary":"Updates frequent payment details","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/frequent-payment/patch_frequent_id","deprecated":false},{"title":"/frequent/authorisation/{id}","summary":"Request Authorisation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/frequent-payment/frequent-authorisation","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscription Payment","link":"/pt/openapi/subscription-payment","routeSlug":"/pt/openapi/subscription-payment","items":[{"label":"List subscription payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/get_subscription","routeSlug":"/pt/openapi/subscription-payment/get_subscription","metadata":{"seo":{"title":"List subscription payments","description":"Full report with all the subscriptions payments from your Account Id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_subscription","name":"List subscription payments","isWebhook":false,"pointer":"/paths/~1subscription/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List subscription payments","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":"Full report with all the subscriptions payments from your Account Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_234","description":"Page Number"},{"name":"records_per_page","in":"query","schemaId":"schema_235","description":"Limit records per page (Max: 100)"},{"name":"expiration_time","in":"query","schemaId":"schema_236","description":"Filter by expiration time interval (max 30 days)"},{"name":"method","in":"query","schemaId":"schema_236","description":"Filter by method"},{"name":"customer","in":"query","schemaId":"schema_236","description":"Filter by customer key"},{"name":"id","in":"query","schemaId":"schema_236","description":"Filter by id"},{"name":"key","in":"query","schemaId":"schema_236","description":"Filter by subscription key"},{"name":"created_at","in":"query","schemaId":"schema_236","description":"Filter by created datetime interval (max 30 days)"},{"name":"status","in":"query","schemaId":"schema_237","description":"Filter by Subscription Status"},{"name":"value","in":"query","schemaId":"schema_238","description":"Filter by Subscription Value"}],"pointer":"/paths/~1subscription/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_234"},{"name":"records_per_page","in":"query","schemaId":"schema_235"},{"name":"expiration_time","in":"query","schemaId":"schema_236"},{"name":"method","in":"query","schemaId":"schema_236"},{"name":"customer","in":"query","schemaId":"schema_236"},{"name":"id","in":"query","schemaId":"schema_236"},{"name":"key","in":"query","schemaId":"schema_236"},{"name":"created_at","in":"query","schemaId":"schema_236"},{"name":"status","in":"query","example":"active","schemaId":"schema_237"},{"name":"value","in":"query","example":"10.55","schemaId":"schema_238"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","403","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/subscription","href":"subscription-payment/get_subscription","openApiOperationId":"get_subscription","summary":"List subscription payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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_239","exampleIds":["paths/~1subscription/get/responses/200/content/application~1json/examples/Success"]}},"schemaId":"schema_239","exampleIds":["paths/~1subscription/get/responses/200/content/application~1json/examples/Success"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1subscription/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_239","exampleIds":["paths/~1subscription/get/responses/200/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_239","exampleIds":["paths/~1subscription/get/responses/200/content/application~1json/examples/Success"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-payment/get_subscription"}],"panels":[]}]},"httpPath":"/subscription"},{"label":"Create subscription payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/post_subscription","routeSlug":"/pt/openapi/subscription-payment/post_subscription","metadata":{"seo":{"title":"Create subscription payment","description":"Creates a Subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post_subscription","name":"Create subscription payment","isWebhook":false,"pointer":"/paths/~1subscription/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create subscription payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a Subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription:create"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_240","exampleIds":["paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a CC payment method","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a DD payment method","paths/~1subscription/post/requestBody/content/application~1json/examples/Full filled example","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a Frequent Payment","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with unlimited payments"]}},"schemaId":"schema_240","exampleIds":["paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a CC payment method","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a DD payment method","paths/~1subscription/post/requestBody/content/application~1json/examples/Full filled example","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a Frequent Payment","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with unlimited payments"],"pointer":"/paths/~1subscription/post/requestBody","description":"Payment configuration object to generate a payment"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_240","exampleIds":["paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a CC payment method","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a DD payment method","paths/~1subscription/post/requestBody/content/application~1json/examples/Full filled example","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a Frequent Payment","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with unlimited payments"]}},"responseCodes":["201","400","403","412","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/subscription","href":"subscription-payment/post_subscription","openApiOperationId":"post_subscription","summary":"Create subscription payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_240","exampleIds":["paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a CC payment method","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a DD payment method","paths/~1subscription/post/requestBody/content/application~1json/examples/Full filled example","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a Frequent Payment","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with unlimited payments"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_240","exampleIds":["paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a CC payment method","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a DD payment method","paths/~1subscription/post/requestBody/content/application~1json/examples/Full filled example","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a Frequent Payment","paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with unlimited payments"]}},"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/subscription-response-on-detail","exampleIds":["paths/~1subscription/post/responses/201/content/application~1json/examples/Response from CC method","paths/~1subscription/post/responses/201/content/application~1json/examples/Response from DD method"]}},"schemaId":"components/schemas/subscription-response-on-detail","exampleIds":["paths/~1subscription/post/responses/201/content/application~1json/examples/Response from CC method","paths/~1subscription/post/responses/201/content/application~1json/examples/Response from DD method"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1subscription/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/subscription-response-on-detail","exampleIds":["paths/~1subscription/post/responses/201/content/application~1json/examples/Response from CC method","paths/~1subscription/post/responses/201/content/application~1json/examples/Response from DD method"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription-response-on-detail","exampleIds":["paths/~1subscription/post/responses/201/content/application~1json/examples/Response from CC method","paths/~1subscription/post/responses/201/content/application~1json/examples/Response from DD method"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription/post/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-payment/post_subscription"}],"panels":[]}]},"httpPath":"/subscription"},{"label":"Shows subscription payment details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/get_subscription_id","routeSlug":"/pt/openapi/subscription-payment/get_subscription_id","metadata":{"seo":{"title":"Shows subscription payment details","description":"Retrieves the subscription payment details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_subscription_id","name":"Shows subscription payment details","isWebhook":false,"pointer":"/paths/~1subscription~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shows subscription payment details","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":"Retrieves the subscription payment details"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1subscription~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/subscription/{id}","href":"subscription-payment/get_subscription_id","openApiOperationId":"get_subscription_id","summary":"Shows subscription payment details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/subscription-response-on-detail","exampleIds":["paths/~1subscription~1{id}/get/responses/200/content/application~1json/examples/Success"]}},"schemaId":"components/schemas/subscription-response-on-detail","exampleIds":["paths/~1subscription~1{id}/get/responses/200/content/application~1json/examples/Success"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1subscription~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription-response-on-detail","exampleIds":["paths/~1subscription~1{id}/get/responses/200/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription-response-on-detail","exampleIds":["paths/~1subscription~1{id}/get/responses/200/content/application~1json/examples/Success"]}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-payment/get_subscription_id"}],"panels":[]}]},"httpPath":"/subscription/{id}"},{"label":"Deletes subscription payment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/delete_subscription_id","routeSlug":"/pt/openapi/subscription-payment/delete_subscription_id","metadata":{"seo":{"title":"Deletes subscription payment","description":"Deletes the subscription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_subscription_id","name":"Deletes subscription payment","isWebhook":false,"pointer":"/paths/~1subscription~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes subscription payment","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":"Deletes the subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription:delete"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1subscription~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscription/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/subscription/{id}","href":"subscription-payment/delete_subscription_id","openApiOperationId":"delete_subscription_id","summary":"Deletes subscription payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1subscription~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-payment/delete_subscription_id"}],"panels":[]}]},"httpPath":"/subscription/{id}"},{"label":"Updates subscription payment details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/patch_subscription_id","routeSlug":"/pt/openapi/subscription-payment/patch_subscription_id","metadata":{"seo":{"title":"Updates subscription payment details","description":"Updates the subscription payment details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch_subscription_id","name":"Updates subscription payment details","isWebhook":false,"pointer":"/paths/~1subscription~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates subscription payment details","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":"Updates the subscription payment details"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription:update"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1subscription~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_241","exampleIds":["paths/~1subscription~1{id}/patch/requestBody/content/application~1json/examples/Full PATCH","paths/~1subscription~1{id}/patch/requestBody/content/application~1json/examples/Example 1"]}},"schemaId":"schema_241","exampleIds":["paths/~1subscription~1{id}/patch/requestBody/content/application~1json/examples/Full PATCH","paths/~1subscription~1{id}/patch/requestBody/content/application~1json/examples/Example 1"],"pointer":"/paths/~1subscription~1{id}/patch/requestBody","description":"Subscription Payment object to edit existing one"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/subscription/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_241","exampleIds":["paths/~1subscription~1{id}/patch/requestBody/content/application~1json/examples/Full PATCH","paths/~1subscription~1{id}/patch/requestBody/content/application~1json/examples/Example 1"]}},"responseCodes":["200","400","401","403","404","412","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/subscription/{id}","href":"subscription-payment/patch_subscription_id","openApiOperationId":"patch_subscription_id","summary":"Updates subscription payment details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_241","exampleIds":["paths/~1subscription~1{id}/patch/requestBody/content/application~1json/examples/Full PATCH","paths/~1subscription~1{id}/patch/requestBody/content/application~1json/examples/Example 1"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_241","exampleIds":["paths/~1subscription~1{id}/patch/requestBody/content/application~1json/examples/Full PATCH","paths/~1subscription~1{id}/patch/requestBody/content/application~1json/examples/Example 1"]}},"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_242","exampleIds":["paths/~1subscription~1{id}/patch/responses/200/content/application~1json/examples/Success"]}},"schemaId":"schema_242","exampleIds":["paths/~1subscription~1{id}/patch/responses/200/content/application~1json/examples/Success"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1subscription~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_242","exampleIds":["paths/~1subscription~1{id}/patch/responses/200/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_242","exampleIds":["paths/~1subscription~1{id}/patch/responses/200/content/application~1json/examples/Success"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}/patch/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-payment/patch_subscription_id"}],"panels":[]}]},"httpPath":"/subscription/{id}"},{"label":"List cycles on a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/get_subscription_id_cycles","routeSlug":"/pt/openapi/subscription-payment/get_subscription_id_cycles","metadata":{"seo":{"title":"List cycles on a subscription","description":"Returns the cycles attached to a subscription, ordered from newest to oldest. Use status[] to narrow the result set — values are case-insensitive. Pagination is cursor-based: pass the previous response's metadata.next_cursor back as cursor. An empty next_cursor means there are no further pages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_subscription_id_cycles","name":"List cycles on a subscription","isWebhook":false,"pointer":"/paths/~1subscription~1{id}~1cycle/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List cycles on a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the cycles attached to a subscription, ordered from newest to oldest. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to narrow the result set — values are case-insensitive. Pagination is cursor-based: pass the previous response's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" back as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means there are no further pages."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"UUID of the subscription whose cycles you want to list.","required":true}],"pointer":"/paths/~1subscription~1{id}~1cycle/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_243","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of cycles to return. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", capped at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_244","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque cursor from the previous response's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omit on the first call."},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"schema_245","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by one or more statuses. Repeat the parameter for multiple values (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status[]=pending&status[]=failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Case-insensitive."},"children":[]}]}]}]}],"pointer":"/paths/~1subscription~1{id}~1cycle/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription/{id}/cycle","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_243"},{"name":"cursor","in":"query","required":false,"example":"lL_j7ilk7rc","schemaId":"schema_244"},{"name":"status","in":"query","required":false,"example":["PENDING","FAILED"],"schemaId":"schema_245","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","412","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/subscription/{id}/cycle","href":"subscription-payment/get_subscription_id_cycles","openApiOperationId":"get_subscription_id_cycles","summary":"List cycles on a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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_246","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/First page","paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/Last page","paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/No cycles"]}},"schemaId":"schema_246","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/First page","paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/Last page","paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/No cycles"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1subscription~1{id}~1cycle/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_246","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/First page","paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/Last page","paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/No cycles"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_246","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/First page","paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/Last page","paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/No cycles"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-payment/get_subscription_id_cycles"}],"panels":[]}]},"httpPath":"/subscription/{id}/cycle"},{"label":"Create a one-off cycle on a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/post_subscription_id_cycles","routeSlug":"/pt/openapi/subscription-payment/post_subscription_id_cycles","metadata":{"seo":{"title":"Create a one-off cycle on a subscription","description":"Triggers an extra capture against an active subscription's saved payment method — useful for billing ad-hoc items like setup fees, add-ons, or upgrades without touching the recurring schedule. The regular cycles keep running unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post_subscription_id_cycles","name":"Create a one-off cycle on a subscription","isWebhook":false,"pointer":"/paths/~1subscription~1{id}~1cycle/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a one-off cycle on a subscription","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":"Triggers an extra capture against an active subscription's saved payment method — useful for billing ad-hoc items like setup fees, add-ons, or upgrades without touching the recurring schedule. The regular cycles keep running unchanged."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capture_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to schedule the capture for later, or omit it to capture right away. The subscription must be active; a one-off cycle on an inactive subscription is rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription:create"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"UUID of the subscription to add the cycle to.","required":true}],"pointer":"/paths/~1subscription~1{id}~1cycle/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_247","exampleIds":["paths/~1subscription~1{id}~1cycle/post/requestBody/content/application~1json/examples/Capture now","paths/~1subscription~1{id}~1cycle/post/requestBody/content/application~1json/examples/Schedule for later"]}},"schemaId":"schema_247","exampleIds":["paths/~1subscription~1{id}~1cycle/post/requestBody/content/application~1json/examples/Capture now","paths/~1subscription~1{id}~1cycle/post/requestBody/content/application~1json/examples/Schedule for later"],"pointer":"/paths/~1subscription~1{id}~1cycle/post/requestBody","description":"Details of the one-off cycle to capture on an active subscription."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription/{id}/cycle","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_247","exampleIds":["paths/~1subscription~1{id}~1cycle/post/requestBody/content/application~1json/examples/Capture now","paths/~1subscription~1{id}~1cycle/post/requestBody/content/application~1json/examples/Schedule for later"]}},"responseCodes":["201","400","401","403","404","409","412","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/subscription/{id}/cycle","href":"subscription-payment/post_subscription_id_cycles","openApiOperationId":"post_subscription_id_cycles","summary":"Create a one-off cycle on a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_247","exampleIds":["paths/~1subscription~1{id}~1cycle/post/requestBody/content/application~1json/examples/Capture now","paths/~1subscription~1{id}~1cycle/post/requestBody/content/application~1json/examples/Schedule for later"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_247","exampleIds":["paths/~1subscription~1{id}~1cycle/post/requestBody/content/application~1json/examples/Capture now","paths/~1subscription~1{id}~1cycle/post/requestBody/content/application~1json/examples/Schedule for later"]}},"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/one-time-charge-response-on-post","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/201/content/application~1json/examples/One-time charge created"]}},"schemaId":"components/schemas/one-time-charge-response-on-post","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/201/content/application~1json/examples/One-time charge created"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/404/content/application~1json/examples/Resource not found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/409/content/application~1json/examples/conflict"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1subscription~1{id}~1cycle/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/one-time-charge-response-on-post","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/201/content/application~1json/examples/One-time charge created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/one-time-charge-response-on-post","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/201/content/application~1json/examples/One-time charge created"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"409","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle/post/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-payment/post_subscription_id_cycles"}],"panels":[]}]},"httpPath":"/subscription/{id}/cycle"},{"label":"Retrieve a cycle on a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/get_subscription_id_cycle_id","routeSlug":"/pt/openapi/subscription-payment/get_subscription_id_cycle_id","metadata":{"seo":{"title":"Retrieve a cycle on a subscription","description":"Returns a single cycle that belongs to the given subscription. A cycle that doesn't exist — or that belongs to a different account — returns 404 Not Found."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_subscription_id_cycle_id","name":"Retrieve a cycle on a subscription","isWebhook":false,"pointer":"/paths/~1subscription~1{id}~1cycle~1{cycle_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a cycle on a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a single cycle that belongs to the given subscription. A cycle that doesn't exist — or that belongs to a different account — returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404 Not Found"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"UUID of the subscription the cycle belongs to.","required":true},{"name":"cycle_id","in":"path","schemaId":"schema_223","description":"UUID of the cycle to retrieve.","required":true}],"pointer":"/paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription/{id}/cycle/{cycle_id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"},{"name":"cycle_id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","412","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/subscription/{id}/cycle/{cycle_id}","href":"subscription-payment/get_subscription_id_cycle_id","openApiOperationId":"get_subscription_id_cycle_id","summary":"Retrieve a cycle on a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/cycle","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/200/content/application~1json/examples/Pending one-off charge","paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/200/content/application~1json/examples/Successful renewal"]}},"schemaId":"components/schemas/cycle","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/200/content/application~1json/examples/Pending one-off charge","paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/200/content/application~1json/examples/Successful renewal"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/cycle","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/200/content/application~1json/examples/Pending one-off charge","paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/200/content/application~1json/examples/Successful renewal"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cycle","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/200/content/application~1json/examples/Pending one-off charge","paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/200/content/application~1json/examples/Successful renewal"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-payment/get_subscription_id_cycle_id"}],"panels":[]}]},"httpPath":"/subscription/{id}/cycle/{cycle_id}"},{"label":"Update a cycle on a subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/subscription-payment/patch_subscription_id_cycle_id","routeSlug":"/pt/openapi/subscription-payment/patch_subscription_id_cycle_id","metadata":{"seo":{"title":"Update a cycle on a subscription","description":"Overrides the charge amount for a single cycle without touching the subscription's recurring schedule or default value. Only RENEWABLE cycles in PENDING status can be patched — anything else (one-off charges, already-processed cycles, deleted cycles) returns 409 Conflict."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch_subscription_id_cycle_id","name":"Update a cycle on a subscription","isWebhook":false,"pointer":"/paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a cycle on a subscription","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":"Overrides the charge amount for a single cycle without touching the subscription's recurring schedule or default value. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RENEWABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cycles in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status can be patched — anything else (one-off charges, already-processed cycles, deleted cycles) returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription:update"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"UUID of the subscription the cycle belongs to.","required":true},{"name":"cycle_id","in":"path","schemaId":"schema_223","description":"UUID of the cycle to update.","required":true}],"pointer":"/paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_248","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/requestBody/content/application~1json/examples/Update amount"]}},"schemaId":"schema_248","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/requestBody/content/application~1json/examples/Update amount"],"pointer":"/paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/requestBody","description":"New amount to charge on this cycle."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/subscription/{id}/cycle/{cycle_id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"},{"name":"cycle_id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_248","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/requestBody/content/application~1json/examples/Update amount"]}},"responseCodes":["200","400","401","403","404","409","412","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/subscription/{id}/cycle/{cycle_id}","href":"subscription-payment/patch_subscription_id_cycle_id","openApiOperationId":"patch_subscription_id_cycle_id","summary":"Update a cycle on a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_248","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/requestBody/content/application~1json/examples/Update amount"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_248","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/requestBody/content/application~1json/examples/Update amount"]}},"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/update-cycle-response-on-patch","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/200/content/application~1json/examples/Cycle updated"]}},"schemaId":"components/schemas/update-cycle-response-on-patch","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/200/content/application~1json/examples/Cycle updated"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/404/content/application~1json/examples/Resource not found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/409/content/application~1json/examples/conflict"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/update-cycle-response-on-patch","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/200/content/application~1json/examples/Cycle updated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/update-cycle-response-on-patch","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/200/content/application~1json/examples/Cycle updated"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"409","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/409/content/application~1json/examples/conflict"]}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-payment/patch_subscription_id_cycle_id"}],"panels":[]}]},"httpPath":"/subscription/{id}/cycle/{cycle_id}"}],"content":{"contentType":"group","meta":{"name":"Subscription Payment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription Payment","showPageActions":true},{"nodeType":"markdoc","content":"Set up and manage automated recurring payments"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscription","summary":"List subscription payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription-payment/get_subscription","deprecated":false},{"title":"/subscription","summary":"Create subscription payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscription-payment/post_subscription","deprecated":false},{"title":"/subscription/{id}","summary":"Shows subscription payment details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription-payment/get_subscription_id","deprecated":false},{"title":"/subscription/{id}","summary":"Deletes subscription payment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscription-payment/delete_subscription_id","deprecated":false},{"title":"/subscription/{id}","summary":"Updates subscription payment details","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/subscription-payment/patch_subscription_id","deprecated":false},{"title":"/subscription/{id}/cycle","summary":"List cycles on a subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription-payment/get_subscription_id_cycles","deprecated":false},{"title":"/subscription/{id}/cycle","summary":"Create a one-off cycle on a subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscription-payment/post_subscription_id_cycles","deprecated":false},{"title":"/subscription/{id}/cycle/{cycle_id}","summary":"Retrieve a cycle on a subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription-payment/get_subscription_id_cycle_id","deprecated":false},{"title":"/subscription/{id}/cycle/{cycle_id}","summary":"Update a cycle on a subscription","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/subscription-payment/patch_subscription_id_cycle_id","deprecated":false}]}]}]}]}},{"type":"group","label":"Captures","link":"/pt/openapi/captures","routeSlug":"/pt/openapi/captures","items":[{"label":"List captures","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/captures/paths/~1capture/get","routeSlug":"/pt/openapi/captures/paths/~1capture/get","metadata":{"seo":{"title":"List captures","description":"Required scope: capture:read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List captures","isWebhook":false,"pointer":"/paths/~1capture/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List captures","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"capture:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_236","description":"The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results."},{"name":"limit","in":"query","schemaId":"schema_234","description":"The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100. "},{"name":"created_at","in":"query","schemaId":"schema_213","description":"Filter records by creation datetime interval in UTC. Maximum allowed range is 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)."},{"name":"updated_at","in":"query","schemaId":"schema_213","description":"Filter records by update datetime interval. Maximum range of 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)"}],"pointer":"/paths/~1capture/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/capture","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_234"},{"name":"created_at","in":"query","required":false,"example":"interval(2006-01-02 15:04,2006-01-02 15:04)","schemaId":"schema_213"},{"name":"updated_at","in":"query","required":false,"example":"interval(2006-01-02 15:04,2006-01-02 15:04)","schemaId":"schema_213"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","401","403","412","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/capture","href":"captures/paths/~1capture/get","summary":"List captures"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/capture-get-list-response"}},"schemaId":"components/schemas/capture-get-list-response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1capture/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/capture-get-list-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/capture-get-list-response"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/captures/paths/~1capture/get"}],"panels":[]}]},"httpPath":"/capture"},{"label":"Captures a Single Auth, Frequent and Frequent Auth","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/captures/paths/~1capture~1{id}/post","routeSlug":"/pt/openapi/captures/paths/~1capture~1{id}/post","metadata":{"seo":{"title":"Captures a Single Auth, Frequent and Frequent Auth","description":"Required scope: capture:create"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Captures a Single Auth, Frequent and Frequent Auth","isWebhook":false,"pointer":"/paths/~1capture~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Captures a Single Auth, Frequent and Frequent Auth","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"capture:create"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1capture~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/capture-post-request"}},"schemaId":"components/schemas/capture-post-request","pointer":"/paths/~1capture~1{id}/post/requestBody","description":"Created"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/capture/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/capture-post-request"}},"responseCodes":["201","400","403","404","412","422","428","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/capture/{id}","href":"captures/paths/~1capture~1{id}/post","summary":"Captures a Single Auth, Frequent and Frequent Auth"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"components/schemas/capture-post-request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/capture-post-request"}},"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/capture-post-response"}},"schemaId":"components/schemas/capture-post-response"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/404/content/application~1json/examples/Resource not found"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/422/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/422/content/application~1json/examples/Rate limit exceeded"]},{"code":"428","description":"Pre condition required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/428/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/428/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1capture~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/capture-post-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/capture-post-response"}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"422","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/422/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/422/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"428","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/428/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/428/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/post/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/captures/paths/~1capture~1{id}/post"}],"panels":[]}]},"httpPath":"/capture/{id}"},{"label":"Shows capture details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/captures/paths/~1capture~1{id}/get","routeSlug":"/pt/openapi/captures/paths/~1capture~1{id}/get","metadata":{"seo":{"title":"Shows capture details","description":"Required scope: capture:read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Shows capture details","isWebhook":false,"pointer":"/paths/~1capture~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shows capture details","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"capture:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1capture~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/capture/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","401","403","404","412","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/capture/{id}","href":"captures/paths/~1capture~1{id}/get","summary":"Shows capture details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/capture-get-by-id-response"}},"schemaId":"components/schemas/capture-get-by-id-response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1capture~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/capture-get-by-id-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/capture-get-by-id-response"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/captures/paths/~1capture~1{id}/get"}],"panels":[]}]},"httpPath":"/capture/{id}"},{"label":"Cancels a capture","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/captures/capture-delete","routeSlug":"/pt/openapi/captures/capture-delete","metadata":{"seo":{"title":"Cancels a capture","description":"This endpoint is rolling out shortly. The shape below is stable, but calls against it will not succeed until the feature ships."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"capture-delete","name":"Cancels a capture","isWebhook":false,"pointer":"/paths/~1capture~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancels a capture","badges":[{"name":"Soon","color":"orange"}],"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is rolling out shortly."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The shape below is stable, but calls against it will not succeed until the feature ships."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a capture before it is processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only captures still in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delayed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be cancelled, and only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for these payment methods:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multibanco:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FILE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" references. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cancels in real time. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FILE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"take up to 24 hours, so the reference may still be paid in that window. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHECKDIGIT"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"references cannot be cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Debit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the instruction is sent to the customer's bank."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Card, Apple Pay, Google Pay and Samsung Wallet:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the customer provides"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"their payment details on the payment page or checkout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once a capture has succeeded, the money has already moved, so issue a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"capture:delete"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1capture~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/capture/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["204","400","403","404","412","422","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/capture/{id}","href":"captures/capture-delete","openApiOperationId":"capture-delete","summary":"Cancels a capture"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/422/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/422/content/application~1json/examples/Rate limit exceeded"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1capture~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"422","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/422/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/422/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/captures/capture-delete"}],"panels":[]}]},"badges":[{"name":"Soon","color":"orange"}],"httpPath":"/capture/{id}"},{"label":"Updates the split of a capture","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/captures/patch_capture_capture_uuid_splits_capture_split_uuid","routeSlug":"/pt/openapi/captures/patch_capture_capture_uuid_splits_capture_split_uuid","metadata":{"seo":{"title":"Updates the split of a capture","description":"Required scope: capture:update"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch_capture_capture_uuid_splits_capture_split_uuid","name":"Updates the split of a capture","isWebhook":false,"pointer":"/paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates the split of a capture","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"capture:update"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"capture-uuid","in":"path","schemaId":"schema_223","description":"Capture Identification","required":true},{"name":"capture-split-uuid","in":"path","schemaId":"schema_223","description":"Capture Split Identification","required":true}],"pointer":"/paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_249"}},"schemaId":"schema_249","pointer":"/paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/requestBody","description":"Payment configuration object to generate a payment"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/capture/{capture-uuid}/splits/{capture-split-uuid}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"capture-uuid","in":"path","required":true,"schemaId":"schema_223"},{"name":"capture-split-uuid","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_249"}},"responseCodes":["201","400","403","412","428","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/capture/{capture-uuid}/splits/{capture-split-uuid}","href":"captures/patch_capture_capture_uuid_splits_capture_split_uuid","openApiOperationId":"patch_capture_capture_uuid_splits_capture_split_uuid","summary":"Updates the split of a capture"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_249","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_249"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/status-details"}},"schemaId":"components/schemas/status-details"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"428","description":"Pre condition required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/428/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/428/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/status-details","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/status-details"}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"428","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/428/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/428/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/captures/patch_capture_capture_uuid_splits_capture_split_uuid"}],"panels":[]}]},"httpPath":"/capture/{capture-uuid}/splits/{capture-split-uuid}"}],"content":{"contentType":"group","meta":{"name":"Captures"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Captures","showPageActions":true},{"nodeType":"markdoc","content":"Operations for managing payment captures"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/capture","summary":"List captures","prefix":{"name":"get","color":"get"},"badges":[],"link":"/captures/paths/~1capture/get","deprecated":false},{"title":"/capture/{id}","summary":"Captures a Single Auth, Frequent and Frequent Auth","prefix":{"name":"post","color":"post"},"badges":[],"link":"/captures/paths/~1capture~1{id}/post","deprecated":false},{"title":"/capture/{id}","summary":"Shows capture details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/captures/paths/~1capture~1{id}/get","deprecated":false},{"title":"/capture/{id}","summary":"Cancels a capture","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Soon","color":"orange"}],"link":"/captures/capture-delete","deprecated":false},{"title":"/capture/{capture-uuid}/splits/{capture-split-uuid}","summary":"Updates the split of a capture","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/captures/patch_capture_capture_uuid_splits_capture_split_uuid","deprecated":false}]}]}]}]}},{"type":"group","label":"Authorisations","link":"/pt/openapi/authorisations","routeSlug":"/pt/openapi/authorisations","items":[{"label":"Shows authorisation details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/authorisations/get_authorisation_id","routeSlug":"/pt/openapi/authorisations/get_authorisation_id","metadata":{"seo":{"title":"Shows authorisation details","description":"Retrieves the details of an authorisation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_authorisation_id","name":"Shows authorisation details","isWebhook":false,"pointer":"/paths/~1authorisation~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shows authorisation details","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":"Retrieves the details of an authorisation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorisation:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1authorisation~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authorisation/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/authorisation/{id}","href":"authorisations/get_authorisation_id","openApiOperationId":"get_authorisation_id","summary":"Shows authorisation details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/authorisation-get-by-id-response"}},"schemaId":"components/schemas/authorisation-get-by-id-response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1authorisation~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/authorisation-get-by-id-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/authorisation-get-by-id-response"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1authorisation~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorisations/get_authorisation_id"}],"panels":[]}]},"httpPath":"/authorisation/{id}"}],"content":{"contentType":"group","meta":{"name":"Authorisations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorisations","showPageActions":true},{"nodeType":"markdoc","content":"Operations for managing payment authorisations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/authorisation/{id}","summary":"Shows authorisation details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authorisations/get_authorisation_id","deprecated":false}]}]}]}]}},{"type":"group","label":"Voids","link":"/pt/openapi/voids","routeSlug":"/pt/openapi/voids","items":[{"label":"Get a void","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/voids/get_void_id","routeSlug":"/pt/openapi/voids/get_void_id","metadata":{"seo":{"title":"Get a void","description":"Returns the details and current status of a void, including the authorisation it cancelled. Use this to track a void's outcome after creation, since processing is asynchronous."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_void_id","name":"Get a void","isWebhook":false,"pointer":"/paths/~1void~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a void","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the details and current status of a void, including the authorisation it cancelled. Use this to track a void's outcome after creation, since processing is asynchronous."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"void:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"void's unique identifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned when the void was created)."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1void~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/void/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/void/{id}","href":"voids/get_void_id","openApiOperationId":"get_void_id","summary":"Get a void"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/void-get-by-id-response"}},"schemaId":"components/schemas/void-get-by-id-response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1void~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/void-get-by-id-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/void-get-by-id-response"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/voids/get_void_id"}],"panels":[]}]},"httpPath":"/void/{id}"},{"label":"Create a void","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/voids/post_void_id","routeSlug":"/pt/openapi/voids/post_void_id","metadata":{"seo":{"title":"Create a void","description":"Cancels a payment authorisation before it is captured, releasing the amount held on the card. Works for single and frequent authorisations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post_void_id","name":"Create a void","isWebhook":false,"pointer":"/paths/~1void~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a void","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":"Cancels a payment authorisation before it is captured, releasing the amount held on the card. Works for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frequent"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorisations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"void:create"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token of the operation to cancel"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the single or frequent payment authorisation token."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1void~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/void-post-request"}},"schemaId":"components/schemas/void-post-request","pointer":"/paths/~1void~1{id}/post/requestBody","description":"Void details"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/void/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/void-post-request"}},"responseCodes":["201","400","403","404","412","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/void/{id}","href":"voids/post_void_id","openApiOperationId":"post_void_id","summary":"Create a void"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"components/schemas/void-post-request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/void-post-request"}},"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/void-post-response"}},"schemaId":"components/schemas/void-post-response"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/404/content/application~1json/examples/Resource not found"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1void~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/void-post-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/void-post-response"}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1void~1{id}/post/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/voids/post_void_id"}],"panels":[]}]},"httpPath":"/void/{id}"}],"content":{"contentType":"group","meta":{"name":"Voids"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Voids","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"void"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cancels a payment authorisation "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"before it is captured"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The acquirer releases the amount that was held on the customer's card, so no money ever moves — as if the transaction had never happened."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use a void to undo an authorisation that has not yet been captured. To return money that has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"already"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" been captured, use a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voids are supported for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frequent"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment authorisations."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/void/{id}","summary":"Get a void","prefix":{"name":"get","color":"get"},"badges":[],"link":"/voids/get_void_id","deprecated":false},{"title":"/void/{id}","summary":"Create a void","prefix":{"name":"post","color":"post"},"badges":[],"link":"/voids/post_void_id","deprecated":false}]}]}]}]}},{"type":"group","label":"Refunds","link":"/pt/openapi/refunds","routeSlug":"/pt/openapi/refunds","items":[{"label":"List Refunds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/refunds/list-refund","routeSlug":"/pt/openapi/refunds/list-refund","metadata":{"seo":{"title":"List Refunds","description":"Cursor based endpoint to retrieve all account refunds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-refund","name":"List Refunds","isWebhook":false,"pointer":"/paths/~1refund/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Refunds","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":"Cursor based endpoint to retrieve all account refunds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_236","description":"The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results."},{"name":"limit","in":"query","schemaId":"schema_234","description":"The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100. "},{"name":"created_at","in":"query","schemaId":"schema_213","description":"Filter records by creation datetime interval in UTC. Maximum allowed range is 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)."},{"name":"updated_at","in":"query","schemaId":"schema_213","description":"Filter records by update datetime interval. Maximum range of 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)"}],"pointer":"/paths/~1refund/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/refund","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_234"},{"name":"created_at","in":"query","required":false,"example":"interval(2006-01-02 15:04,2006-01-02 15:04)","schemaId":"schema_213"},{"name":"updated_at","in":"query","required":false,"example":"interval(2006-01-02 15:04,2006-01-02 15:04)","schemaId":"schema_213"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","400","403","412","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/refund","href":"refunds/list-refund","openApiOperationId":"list-refund","summary":"List Refunds"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/refund-get-list-response"}},"schemaId":"components/schemas/refund-get-list-response"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund/get/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund/get/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1refund/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/refund-get-list-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/refund-get-list-response"}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund/get/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund/get/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/list-refund"}],"panels":[]}]},"httpPath":"/refund"},{"label":"Refunds a Single Transaction or Frequent Transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/refunds/paths/~1refund~1{id}/post","routeSlug":"/pt/openapi/refunds/paths/~1refund~1{id}/post","metadata":{"seo":{"title":"Refunds a Single Transaction or Frequent Transaction","description":"Each method has a specific time window during which a refund can be issued. Once this period expires, refunds can no longer be processed via the API for that payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Refunds a Single Transaction or Frequent Transaction","isWebhook":false,"pointer":"/paths/~1refund~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refunds a Single Transaction or Frequent 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":"Each method has a specific time window during which a refund can be issued. Once this period expires, refunds can no longer be processed via the API for that payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"refunds/paths/~1refund~1{id}/post/request/refund-deadlines-by-payment-method","deepLinkHash":"/refunds/paths/~1refund~1{id}/post#refunds/paths/~1refund~1{id}/post/request/refund-deadlines-by-payment-method"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund Deadlines by Payment Method"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Method"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum Refund Time"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MB WAY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12 months"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa & Mastercard"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12 months"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Pay"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12 months"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Pay"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12 months"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Samsung Pay"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12 months"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MB SPG references"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"120 days"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other MB references"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No limit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Debit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"180 days"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund:create"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"The capture uuid associated with Single or Frequent Transaction","required":true}],"pointer":"/paths/~1refund~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/refund-post-request","exampleIds":["paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Total Revert","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Partial Revert","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Partial Revert and Reward Redemption Reversal"]}},"schemaId":"components/schemas/refund-post-request","exampleIds":["paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Total Revert","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Partial Revert","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Partial Revert and Reward Redemption Reversal"],"pointer":"/paths/~1refund~1{id}/post/requestBody","description":"Request body for creating a refund"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/refund/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/refund-post-request","exampleIds":["paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Total Revert","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Partial Revert","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Partial Revert and Reward Redemption Reversal"]}},"responseCodes":["201","400","403","404","412","422","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/refund/{id}","href":"refunds/paths/~1refund~1{id}/post","summary":"Refunds a Single Transaction or Frequent Transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"components/schemas/refund-post-request","exampleIds":["paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Total Revert","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Partial Revert","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Partial Revert and Reward Redemption Reversal"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/refund-post-request","exampleIds":["paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Total Revert","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Partial Revert","paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Partial Revert and Reward Redemption Reversal"]}},"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/refund-post-response"}},"schemaId":"components/schemas/refund-post-response"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/404/content/application~1json/examples/Resource not found"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/422/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/422/content/application~1json/examples/Rate limit exceeded"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1refund~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/refund-post-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/refund-post-response"}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"422","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/422/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/422/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/post/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/paths/~1refund~1{id}/post"}],"panels":[]}]},"httpPath":"/refund/{id}"},{"label":"Shows refund details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/refunds/paths/~1refund~1{id}/get","routeSlug":"/pt/openapi/refunds/paths/~1refund~1{id}/get","metadata":{"seo":{"title":"Shows refund details","description":"Required scope: refund:read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Shows refund details","isWebhook":false,"pointer":"/paths/~1refund~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shows refund details","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1refund~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/refund/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/refund/{id}","href":"refunds/paths/~1refund~1{id}/get","summary":"Shows refund details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/refund-get-by-id-response"}},"schemaId":"components/schemas/refund-get-by-id-response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1refund~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/refund-get-by-id-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/refund-get-by-id-response"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1refund~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/paths/~1refund~1{id}/get"}],"panels":[]}]},"httpPath":"/refund/{id}"}],"content":{"contentType":"group","meta":{"name":"Refunds"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refunds","showPageActions":true},{"nodeType":"markdoc","content":"Operations for managing payment refunds"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/refund","summary":"List Refunds","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/list-refund","deprecated":false},{"title":"/refund/{id}","summary":"Refunds a Single Transaction or Frequent Transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refunds/paths/~1refund~1{id}/post","deprecated":false},{"title":"/refund/{id}","summary":"Shows refund details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/paths/~1refund~1{id}/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Chargebacks","link":"/pt/openapi/chargebacks","routeSlug":"/pt/openapi/chargebacks","items":[{"label":"List chargebacks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/chargebacks/list-chargeback","routeSlug":"/pt/openapi/chargebacks/list-chargeback","metadata":{"seo":{"title":"List chargebacks","description":"This endpoint retrieves a list of chargebacks associated with your account. A Chargeback is a mandatory transaction reversal initiated by the consumer's card issuer or bank, usually due to a dispute over a transaction. When a chargeback occurs, the costumer effectively reverses the transaction, resulting in a debit of the disputed amount from the merchant's account. This endpoint allows you to view details of chargebacks, including the reason for the dispute, transaction amount, and status, providing insights into consumer disputes and their impact on your financials."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-chargeback","name":"List chargebacks","isWebhook":false,"pointer":"/paths/~1chargeback/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List chargebacks","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 endpoint retrieves a list of chargebacks associated with your account. A Chargeback is a mandatory transaction reversal initiated by the consumer's card issuer or bank, usually due to a dispute over a transaction. When a chargeback occurs, the costumer effectively reverses the transaction, resulting in a debit of the disputed amount from the merchant's account. This endpoint allows you to view details of chargebacks, including the reason for the dispute, transaction amount, and status, providing insights into consumer disputes and their impact on your financials."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargeback:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_236","description":"The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results."},{"name":"limit","in":"query","schemaId":"schema_234","description":"The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100. "},{"name":"created_at","in":"query","schemaId":"schema_213","description":"Filter records by creation datetime interval in UTC. Maximum allowed range is 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)."},{"name":"capture.id","in":"query","schemaId":"schema_223","description":"Filter chargebacks by capture UUID. Returns only chargebacks associated with the specified capture.","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"}],"pointer":"/paths/~1chargeback/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chargeback","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_234"},{"name":"created_at","in":"query","required":false,"example":"interval(2006-01-02 15:04,2006-01-02 15:04)","schemaId":"schema_213"},{"name":"capture.id","in":"query","required":false,"example":"c6056234-a3f9-42de-b944-3ed793fcb6bb","schemaId":"schema_223"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","403","412","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/chargeback","href":"chargebacks/list-chargeback","openApiOperationId":"list-chargeback","summary":"List chargebacks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/chargeback-list-response"}},"schemaId":"components/schemas/chargeback-list-response"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback/get/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback/get/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1chargeback/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/chargeback-list-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/chargeback-list-response"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback/get/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback/get/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chargebacks/list-chargeback"}],"panels":[]}]},"httpPath":"/chargeback"},{"label":"Shows chargeback details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/chargebacks/get-chargeback-details","routeSlug":"/pt/openapi/chargebacks/get-chargeback-details","metadata":{"seo":{"title":"Shows chargeback details","description":"This endpoint retrieves the details of a specific chargeback by its unique identifier. A Chargeback is a mandatory transaction reversal initiated by the consumer's card issuer or bank, usually due to a dispute over a transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-chargeback-details","name":"Shows chargeback details","isWebhook":false,"pointer":"/paths/~1chargeback~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shows chargeback details","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 endpoint retrieves the details of a specific chargeback by its unique identifier. A Chargeback is a mandatory transaction reversal initiated by the consumer's card issuer or bank, usually due to a dispute over a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargeback:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1chargeback~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chargeback/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","401","403","404","412","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/chargeback/{id}","href":"chargebacks/get-chargeback-details","openApiOperationId":"get-chargeback-details","summary":"Shows chargeback details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/chargeback-get-by-id-response"}},"schemaId":"components/schemas/chargeback-get-by-id-response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1chargeback~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/chargeback-get-by-id-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/chargeback-get-by-id-response"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1chargeback~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chargebacks/get-chargeback-details"}],"panels":[]}]},"httpPath":"/chargeback/{id}"}],"content":{"contentType":"group","meta":{"name":"Chargebacks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Chargebacks","showPageActions":true},{"nodeType":"markdoc","content":"Operations for managing chargebacks"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/chargeback","summary":"List chargebacks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chargebacks/list-chargeback","deprecated":false},{"title":"/chargeback/{id}","summary":"Shows chargeback details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chargebacks/get-chargeback-details","deprecated":false}]}]}]}]}},{"type":"group","label":"Notifications / Webhooks","link":"/pt/openapi/notifications-webhooks","routeSlug":"/pt/openapi/notifications-webhooks","items":[{"label":"Generic Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/pt/openapi/notifications-webhooks/paths/yourgenericnotificationendpoint/post","routeSlug":"/pt/openapi/notifications-webhooks/paths/yourgenericnotificationendpoint/post","metadata":{"seo":{"title":"Generic Notification","description":"We will send you this json in our notifications"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Generic Notification","isWebhook":true,"pointer":"/paths/yourGenericNotificationEndpoint/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generic Notification","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"We will send you this json in our notifications"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/notification-generic"}},"schemaId":"components/schemas/notification-generic","pointer":"/paths/yourGenericNotificationEndpoint/post/requestBody","description":"Notification Payload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"yourGenericNotificationEndpoint","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","serverValues":{"https://api.test.easypay.pt/2.0":{}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/notification-generic"}},"responseCodes":["200"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"yourGenericNotificationEndpoint","href":"notifications-webhooks/paths/yourgenericnotificationendpoint/post","summary":"Generic Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"components/schemas/notification-generic","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/notification-generic"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Indicates that the data was received successfully","headers":{"X-Easypay-Code":{"description":"A user defined code","schema":{"type":"string"}}},"headerSchemaId":"schema_250"}],"pointer":"/paths/yourGenericNotificationEndpoint/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications-webhooks/paths/yourgenericnotificationendpoint/post"}],"panels":[]}]},"httpPath":"yourGenericNotificationEndpoint"},{"label":"Authorisation Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/pt/openapi/notifications-webhooks/paths/yourauthorisationnotificationendpoint/post","routeSlug":"/pt/openapi/notifications-webhooks/paths/yourauthorisationnotificationendpoint/post","metadata":{"seo":{"title":"Authorisation Notification","description":"We will send you this json in our notification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Authorisation Notification","isWebhook":true,"pointer":"/paths/yourAuthorisationNotificationEndpoint/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorisation Notification","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"We will send you this json in our notification"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/notification-authorisation"}},"schemaId":"components/schemas/notification-authorisation","pointer":"/paths/yourAuthorisationNotificationEndpoint/post/requestBody","description":"Notification Payload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"yourAuthorisationNotificationEndpoint","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","serverValues":{"https://api.test.easypay.pt/2.0":{}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/notification-authorisation"}},"responseCodes":["200"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"yourAuthorisationNotificationEndpoint","href":"notifications-webhooks/paths/yourauthorisationnotificationendpoint/post","summary":"Authorisation Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"components/schemas/notification-authorisation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/notification-authorisation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Indicates that the data was received successfully","headers":{"X-Easypay-Code":{"description":"A user defined code","schema":{"type":"string"}}},"headerSchemaId":"schema_250"}],"pointer":"/paths/yourAuthorisationNotificationEndpoint/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications-webhooks/paths/yourauthorisationnotificationendpoint/post"}],"panels":[]}]},"httpPath":"yourAuthorisationNotificationEndpoint"},{"label":"Transaction Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/pt/openapi/notifications-webhooks/paths/yournotificationendpoint/post","routeSlug":"/pt/openapi/notifications-webhooks/paths/yournotificationendpoint/post","metadata":{"seo":{"title":"Transaction Notification","description":"We will send you this json in our notification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Transaction Notification","isWebhook":true,"pointer":"/paths/yourNotificationEndpoint/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction Notification","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"We will send you this json in our notification"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/notification-capture"}},"schemaId":"components/schemas/notification-capture","pointer":"/paths/yourNotificationEndpoint/post/requestBody","description":"Notification Payload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"yourNotificationEndpoint","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","serverValues":{"https://api.test.easypay.pt/2.0":{}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/notification-capture"}},"responseCodes":["200"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"yourNotificationEndpoint","href":"notifications-webhooks/paths/yournotificationendpoint/post","summary":"Transaction Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"components/schemas/notification-capture","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/notification-capture"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Indicates that the data was received successfully","headers":{"X-Easypay-Code":{"description":"A user defined code","schema":{"type":"string"}}},"headerSchemaId":"schema_250"}],"pointer":"/paths/yourNotificationEndpoint/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications-webhooks/paths/yournotificationendpoint/post"}],"panels":[]}]},"httpPath":"yourNotificationEndpoint"}],"content":{"contentType":"group","meta":{"name":"Notifications / Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notifications / Webhooks","showPageActions":true},{"nodeType":"markdoc","content":"Configure and manage webhook notifications for payment events"}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"yourGenericNotificationEndpoint","summary":"Generic Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications-webhooks/paths/yourgenericnotificationendpoint/post","deprecated":false},{"title":"yourAuthorisationNotificationEndpoint","summary":"Authorisation Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications-webhooks/paths/yourauthorisationnotificationendpoint/post","deprecated":false},{"title":"yourNotificationEndpoint","summary":"Transaction Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications-webhooks/paths/yournotificationendpoint/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Reports","link":"/pt/openapi/reports","routeSlug":"/pt/openapi/reports","items":[{"label":"Report Ledger","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/reports/get_report_ledger","routeSlug":"/pt/openapi/reports/get_report_ledger","metadata":{"seo":{"title":"Report Ledger","description":"The /reports/ledger endpoint provides access to detailed reports of ledger entries within the Easypay reconciliation system. This endpoint retrieves comprehensive financial data for each transaction recorded in the ledger, including captures, refunds, fees, and other financial operations, and it was designed to help users generate precise and relevant financial reports, aiding in effective account reconciliation and financial management."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_report_ledger","name":"Report Ledger","isWebhook":false,"pointer":"/paths/~1report~1ledger/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Ledger","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":"The /reports/ledger endpoint provides access to detailed reports of ledger entries within the Easypay reconciliation system. This endpoint retrieves comprehensive financial data for each transaction recorded in the ledger, including captures, refunds, fees, and other financial operations, and it was designed to help users generate precise and relevant financial reports, aiding in effective account reconciliation and financial management."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this endpoint, clients can obtain an itemized list of all ledger entries, including relevant financial details such as transaction amounts, fees, taxes, and net transferred amounts. The data returned by this endpoint is ideal for accounting, auditing, and financial analysis purposes, as it ensures transparency and accuracy in financial reporting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_236","description":"The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results."},{"name":"limit","in":"query","schemaId":"schema_251","description":"The maximum number of records to return in a single response. This value determines how many items are included in each page of the results. The default value is 100, and the maximum allowable limit is 100. If not specified, the default limit will be used. Adjust the limit to control the size of the response and manage the data load for each request."},{"name":"created_at","in":"query","schemaId":"schema_213","description":"Filter records by creation datetime interval in UTC. Maximum allowed range is 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)."},{"name":"transaction_type","in":"query","schemaId":"schema_252","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LedgerTransactionType"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a string enum that represents various types of financial transactions recorded in a ledger. Each transaction type is abbreviated with a code and corresponds to a specific financial operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following are the possible values and their descriptions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Capture): Represents the capture of funds, typically after a payment authorization. This transaction finalizes a payment and moves the funds from the payer's account to the payee's account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Refund): Represents a refund transaction where previously captured funds are returned to the payer's account. This transaction often occurs when a customer returns goods or services."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RV"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Revert): Indicates a revert transaction that undoes a previously made transaction, often used to correct errors or reverse transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Split Payment): Represents a split payment transaction, where a payment is divided among multiple recipients or for different purposes within the same transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Fee): Represents a fee transaction, which is a charge applied for a specific service or transaction. This could include service fees, processing fees, or other types of charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Manual Movement): Represents a manual movement of funds, typically entered manually by an administrator or accountant to adjust balances or correct errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TB"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Bank Transfer): Represents a bank transfer transaction, where funds are moved between different bank accounts. This can be a transfer within the same bank or across different banks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Out Transfer): Indicates an out transfer transaction, where funds are transferred out of the current ledger or account to another external account or ledger."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CB"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Chargeback): Represents a chargeback transaction, typically initiated by the payer's bank to reverse a disputed or fraudulent transaction. This transaction withdraws the funds from the payee's account and returns them to the payer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Out Payment): Represents an out payment transaction, where funds are paid out from the ledger to an external party or account. This transaction is usually used to settle debts or make external payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Transfer Funds): Represents a movement of funds from an Easypay account to a bank account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RW"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Reward): Represents a reward earned by a customer, funded from the account balance. The entry links to the capture that earned the reward through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RR"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Reward Redemption): Represents reward credits a customer redeemed against a purchase. The entry links to the capture the credits were redeemed on through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RX"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Reward Expiry): Represents the payout of a customer's unused reward credits when they expire. These entries are not linked to any operation, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not populated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/guides/rewards-and-redemptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rewards & Redemptions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for how reward movements work."},"children":[]}]}]}],"example":"CP"},{"name":"transfer_batch","in":"query","schemaId":"schema_236","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LedgerTransferBatch"},"children":[]}]}]}]}],"example":"584"}],"pointer":"/paths/~1report~1ledger/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/report/ledger","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","schemaId":"schema_251"},{"name":"created_at","in":"query","required":false,"example":"interval(2006-01-02 15:04,2006-01-02 15:04)","schemaId":"schema_213"},{"name":"transaction_type","in":"query","example":"CP","schemaId":"schema_252"},{"name":"transfer_batch","in":"query","example":"584","schemaId":"schema_236"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","403","412","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/report/ledger","href":"reports/get_report_ledger","openApiOperationId":"get_report_ledger","summary":"Report Ledger"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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","application/xml","multipart/form-data","text/html"],"mediaTypeContent":{"application/json":{"schemaId":"schema_253","exampleIds":["paths/~1report~1ledger/get/responses/200/content/application~1json/examples/Example 1"]},"application/xml":{"schemaId":"schema_254"},"multipart/form-data":{"schemaId":"schema_255"},"text/html":{"schemaId":"schema_256"}},"schemaId":"schema_253","exampleIds":["paths/~1report~1ledger/get/responses/200/content/application~1json/examples/Example 1"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1ledger/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1ledger/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1ledger/get/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1ledger/get/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1ledger/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1ledger/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1report~1ledger/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_253","exampleIds":["paths/~1report~1ledger/get/responses/200/content/application~1json/examples/Example 1"],"mediaTypes":["application/json","application/xml","multipart/form-data","text/html"],"mediaTypeContent":{"application/json":{"schemaId":"schema_253","exampleIds":["paths/~1report~1ledger/get/responses/200/content/application~1json/examples/Example 1"]},"application/xml":{"schemaId":"schema_254"},"multipart/form-data":{"schemaId":"schema_255"},"text/html":{"schemaId":"schema_256"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1ledger/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1ledger/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1ledger/get/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1ledger/get/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1ledger/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1ledger/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/get_report_ledger"}],"panels":[]}]},"httpPath":"/report/ledger"},{"label":"Report Transactions","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/reports/get_report_transactions","routeSlug":"/pt/openapi/reports/get_report_transactions","metadata":{"seo":{"title":"Report Transactions","description":"This endpoint is end of life and will be removed on 2026-07-31. Use /report/ledger instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_report_transactions","name":"Report Transactions","deprecated":true,"isWebhook":false,"pointer":"/paths/~1report~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Transactions","badges":[{"name":"End of Life","color":"red"}],"isWebhook":false,"deprecated":true,"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is end of life and will be removed on 2026-07-31."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/report/ledger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List your transactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"schema_257","description":"Filter from this date (inclusive). The date and time must be provided in UTC, using the format Y-m-d H:i."},{"name":"end_date","in":"query","schemaId":"schema_257","description":" Filter until this date (inclusive). The date and time must be provided in UTC, using the format Y-m-d H:i."},{"name":"page","in":"query","schemaId":"schema_234","description":"Page Number"},{"name":"records_per_page","in":"query","schemaId":"schema_235","description":"Limit records per page (Max: 2500)"}],"pointer":"/paths/~1report~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/report/transactions","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[{"name":"start_date","in":"query","schemaId":"schema_257"},{"name":"end_date","in":"query","schemaId":"schema_257"},{"name":"page","in":"query","schemaId":"schema_234"},{"name":"records_per_page","in":"query","schemaId":"schema_235"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","403","412","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/report/transactions","href":"reports/get_report_transactions","openApiOperationId":"get_report_transactions","summary":"Report Transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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","application/xml","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258","exampleIds":["paths/~1report~1transactions/get/responses/200/content/application~1json/examples/Response"]},"application/xml":{"schemaId":"schema_254"},"text/csv":{"schemaId":"schema_254"}},"schemaId":"schema_258","exampleIds":["paths/~1report~1transactions/get/responses/200/content/application~1json/examples/Response"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1transactions/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1transactions/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1transactions/get/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1transactions/get/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1transactions/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1transactions/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1report~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_258","exampleIds":["paths/~1report~1transactions/get/responses/200/content/application~1json/examples/Response"],"mediaTypes":["application/json","application/xml","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258","exampleIds":["paths/~1report~1transactions/get/responses/200/content/application~1json/examples/Response"]},"application/xml":{"schemaId":"schema_254"},"text/csv":{"schemaId":"schema_254"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1transactions/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1transactions/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1transactions/get/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1transactions/get/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1transactions/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1report~1transactions/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/get_report_transactions"}],"panels":[]}]},"badges":[{"name":"End of Life","color":"red"}],"httpPath":"/report/transactions"}],"content":{"contentType":"group","meta":{"name":"Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports","showPageActions":true},{"nodeType":"markdoc","content":"Access transaction and ledger reports"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/report/ledger","summary":"Report Ledger","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/get_report_ledger","deprecated":false},{"title":"/report/transactions","summary":"Report Transactions","prefix":{"name":"get","color":"http-deprecated"},"badges":[{"name":"End of Life","color":"red"}],"link":"/reports/get_report_transactions","deprecated":true}]}]}]}]}},{"type":"group","label":"Settlements","link":"/pt/openapi/settlements","routeSlug":"/pt/openapi/settlements","items":[{"label":"List settlements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/settlements/get-settlement","routeSlug":"/pt/openapi/settlements/get-settlement","metadata":{"seo":{"title":"List settlements","description":"Returns your settlements, newest first. Each settlement groups the transactions paid out together in a single bank transfer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-settlement","name":"List settlements","isWebhook":false,"pointer":"/paths/~1settlement/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List settlements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns your settlements, newest first. Each settlement groups the transactions paid out together in a single bank transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Narrow the results with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Pagination is cursor-based: pass the previous response's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" back as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means there are no further pages."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_234","description":"The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100. "},{"name":"cursor","in":"query","schemaId":"schema_236","description":"The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results."},{"name":"created_at","in":"query","schemaId":"schema_213","description":"Filter records by creation datetime interval in UTC. Maximum allowed range is 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)."},{"name":"updated_at","in":"query","schemaId":"schema_213","description":"Filter records by update datetime interval. Maximum range of 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)"},{"name":"status[]","in":"query","schemaId":"schema_259","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by one or more statuses. Repeat the parameter for multiple values (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status[]=IN_TRANSIT&status[]=SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Case-insensitive."},"children":[]}]}]}]}],"pointer":"/paths/~1settlement/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settlement","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_234"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"created_at","in":"query","required":false,"example":"interval(2006-01-02 15:04,2006-01-02 15:04)","schemaId":"schema_213"},{"name":"updated_at","in":"query","required":false,"example":"interval(2006-01-02 15:04,2006-01-02 15:04)","schemaId":"schema_213"},{"name":"status[]","in":"query","required":false,"example":["SUCCEEDED","FAILED"],"schemaId":"schema_259","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","401","403","412","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/settlement","href":"settlements/get-settlement","openApiOperationId":"get-settlement","summary":"List settlements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with a list of settlements","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_260","exampleIds":["paths/~1settlement/get/responses/200/content/application~1json/examples/First page","paths/~1settlement/get/responses/200/content/application~1json/examples/Last page","paths/~1settlement/get/responses/200/content/application~1json/examples/No settlements"]}},"schemaId":"schema_260","exampleIds":["paths/~1settlement/get/responses/200/content/application~1json/examples/First page","paths/~1settlement/get/responses/200/content/application~1json/examples/Last page","paths/~1settlement/get/responses/200/content/application~1json/examples/No settlements"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1settlement/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_260","exampleIds":["paths/~1settlement/get/responses/200/content/application~1json/examples/First page","paths/~1settlement/get/responses/200/content/application~1json/examples/Last page","paths/~1settlement/get/responses/200/content/application~1json/examples/No settlements"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_260","exampleIds":["paths/~1settlement/get/responses/200/content/application~1json/examples/First page","paths/~1settlement/get/responses/200/content/application~1json/examples/Last page","paths/~1settlement/get/responses/200/content/application~1json/examples/No settlements"]}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/get-settlement"}],"panels":[]}]},"httpPath":"/settlement"},{"label":"Retrieve a settlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/settlements/get-settlement-id","routeSlug":"/pt/openapi/settlements/get-settlement-id","metadata":{"seo":{"title":"Retrieve a settlement","description":"Retrieve a single settlement by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-settlement-id","name":"Retrieve a settlement","isWebhook":false,"pointer":"/paths/~1settlement~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a settlement","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":"Retrieve a single settlement by its ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"The unique identifier of the settlement to retrieve.","required":true}],"pointer":"/paths/~1settlement~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settlement/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","401","403","404","412","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/settlement/{id}","href":"settlements/get-settlement-id","openApiOperationId":"get-settlement-id","summary":"Retrieve a settlement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with a settlement","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/settlement","exampleIds":["paths/~1settlement~1{id}/get/responses/200/content/application~1json/examples/Settlement"]}},"schemaId":"components/schemas/settlement","exampleIds":["paths/~1settlement~1{id}/get/responses/200/content/application~1json/examples/Settlement"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"412","description":"Pre condition failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1settlement~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/settlement","exampleIds":["paths/~1settlement~1{id}/get/responses/200/content/application~1json/examples/Settlement"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/settlement","exampleIds":["paths/~1settlement~1{id}/get/responses/200/content/application~1json/examples/Settlement"]}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"412","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1settlement~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/get-settlement-id"}],"panels":[]}]},"httpPath":"/settlement/{id}"}],"content":{"contentType":"group","meta":{"name":"Settlements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settlements","showPageActions":true},{"nodeType":"markdoc","content":"View settlement details and history"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settlement","summary":"List settlements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/get-settlement","deprecated":false},{"title":"/settlement/{id}","summary":"Retrieve a settlement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/get-settlement-id","deprecated":false}]}]}]}]}},{"type":"group","label":"Out Payment","link":"/pt/openapi/out-payment","routeSlug":"/pt/openapi/out-payment","items":[{"label":"Lists out payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/out-payment/get_out_payment","routeSlug":"/pt/openapi/out-payment/get_out_payment","metadata":{"seo":{"title":"Lists out payments","description":"Full report with all the out payments from your Account Id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_out_payment","name":"Lists out payments","isWebhook":false,"pointer":"/paths/~1out_payment/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists out payments","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":"Full report with all the out payments from your Account Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"out_payment:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_210","description":"Specifies the page number of the results to retrieve. This parameter is used for paginating through a collection of records, allowing the client to navigate to different pages of the dataset. The value must be a positive integer (e.g., \"1\" for the first page)."},{"name":"records_per_page","in":"query","schemaId":"schema_211","description":"Specifies the number of records to retrieve per page. This parameter is used for controlling the size of each page in a paginated collection of records. The value must be a positive integer, determining how many records are displayed on each page (e.g., \"20\" for 20 records per page)."},{"name":"method","in":"query","schemaId":"schema_261","description":"Filter by method used in the transaction."},{"name":"type","in":"query","schemaId":"schema_262","description":"Filter by type of out payment."},{"name":"id","in":"query","schemaId":"schema_216","description":"Filter by the unique identifier for the resource. Typically formatted as a UUID (Universally Unique Identifier)."},{"name":"key","in":"query","schemaId":"schema_217","description":"A user-defined identifier used to filter the results. This parameter allows the client to specify a key to retrieve records or transactions that match the provided key. The value is a string and may not be unique, as it is determined by the user."},{"name":"value","in":"query","schemaId":"schema_218","description":"Filter records by the exact transaction amount."},{"name":"created_at","in":"query","schemaId":"schema_213","description":"Filter records by creation datetime interval in UTC. Maximum allowed range is 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)."}],"pointer":"/paths/~1out_payment/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/out_payment","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_210"},{"name":"records_per_page","in":"query","required":false,"example":20,"schemaId":"schema_211"},{"name":"method","in":"query","required":false,"schemaId":"schema_261"},{"name":"type","in":"query","required":false,"schemaId":"schema_262"},{"name":"id","in":"query","required":false,"example":"bb3e7e60-20f3-4208-9b21-64c635a51f42","schemaId":"schema_216"},{"name":"key","in":"query","required":false,"example":"01J32EESEC1Z543P7J3PKSF1Q9","schemaId":"schema_217"},{"name":"value","in":"query","example":10.32,"schemaId":"schema_218"},{"name":"created_at","in":"query","required":false,"example":"interval(2006-01-02 15:04,2006-01-02 15:04)","schemaId":"schema_213"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","403","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/out_payment","href":"out-payment/get_out_payment","openApiOperationId":"get_out_payment","summary":"Lists out payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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_263","exampleIds":["paths/~1out_payment/get/responses/200/content/application~1json/examples/Response"]}},"schemaId":"schema_263","exampleIds":["paths/~1out_payment/get/responses/200/content/application~1json/examples/Response"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1out_payment/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_263","exampleIds":["paths/~1out_payment/get/responses/200/content/application~1json/examples/Response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263","exampleIds":["paths/~1out_payment/get/responses/200/content/application~1json/examples/Response"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/out-payment/get_out_payment"}],"panels":[]}]},"httpPath":"/out_payment"},{"label":"Create out payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/out-payment/post_out_payment","routeSlug":"/pt/openapi/out-payment/post_out_payment","metadata":{"seo":{"title":"Create out payment","description":"Get your strong authentication RSA private key from Easypay Backoffice on menu:Web Services->Configuration API 2.0->Keys."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post_out_payment","name":"Create out payment","isWebhook":false,"pointer":"/paths/~1out_payment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create out payment","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 your strong authentication RSA private key from Easypay Backoffice on menu:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web Services->Configuration API 2.0->Keys."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"out_payment:create"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"},{"name":"signatureAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Signature","description":"RSA signature Base64 generated with algorithm SHA256 using a account strong authentication private Key on the raw body or id."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_264","exampleIds":["paths/~1out_payment/post/requestBody/content/application~1json/examples/Create with new customer"]}},"schemaId":"schema_264","exampleIds":["paths/~1out_payment/post/requestBody/content/application~1json/examples/Create with new customer"],"pointer":"/paths/~1out_payment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/out_payment","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}},{"id":"signatureAuth","type":"apiKey","name":"Signature","in":"header","serverValues":{"https://api.test.easypay.pt/2.0":{}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_264","exampleIds":["paths/~1out_payment/post/requestBody/content/application~1json/examples/Create with new customer"]}},"responseCodes":["201","400","403","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/out_payment","href":"out-payment/post_out_payment","openApiOperationId":"post_out_payment","summary":"Create out payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_264","exampleIds":["paths/~1out_payment/post/requestBody/content/application~1json/examples/Create with new customer"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_264","exampleIds":["paths/~1out_payment/post/requestBody/content/application~1json/examples/Create with new customer"]}},"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":"schema_265","exampleIds":["paths/~1out_payment/post/responses/201/content/application~1json/examples/Example 1"]}},"schemaId":"schema_265","exampleIds":["paths/~1out_payment/post/responses/201/content/application~1json/examples/Example 1"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/post/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/post/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/post/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1out_payment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_265","exampleIds":["paths/~1out_payment/post/responses/201/content/application~1json/examples/Example 1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_265","exampleIds":["paths/~1out_payment/post/responses/201/content/application~1json/examples/Example 1"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/post/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/post/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/post/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment/post/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/out-payment/post_out_payment"}],"panels":[]}]},"httpPath":"/out_payment"},{"label":"Shows out payment details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/out-payment/get_out_payment_id","routeSlug":"/pt/openapi/out-payment/get_out_payment_id","metadata":{"seo":{"title":"Shows out payment details","description":"Required scope: out_payment:read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_out_payment_id","name":"Shows out payment details","isWebhook":false,"pointer":"/paths/~1out_payment~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shows out payment details","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"out_payment:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1out_payment~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/out_payment/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/out_payment/{id}","href":"out-payment/get_out_payment_id","openApiOperationId":"get_out_payment_id","summary":"Shows out payment details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/out-payment-response","exampleIds":["paths/~1out_payment~1{id}/get/responses/200/content/application~1json/examples/Response"]}},"schemaId":"components/schemas/out-payment-response","exampleIds":["paths/~1out_payment~1{id}/get/responses/200/content/application~1json/examples/Response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1out_payment~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/out-payment-response","exampleIds":["paths/~1out_payment~1{id}/get/responses/200/content/application~1json/examples/Response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/out-payment-response","exampleIds":["paths/~1out_payment~1{id}/get/responses/200/content/application~1json/examples/Response"]}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/out-payment/get_out_payment_id"}],"panels":[]}]},"httpPath":"/out_payment/{id}"},{"label":"Deletes out payment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/out-payment/delete_out_payment_id","routeSlug":"/pt/openapi/out-payment/delete_out_payment_id","metadata":{"seo":{"title":"Deletes out payment","description":"If the payment is not processed, it will be cancelled.  Get your strong authentication RSA private key from Easypay Backoffice on menu:  Web Services->Configuration API 2.0->Keys."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_out_payment_id","name":"Deletes out payment","isWebhook":false,"pointer":"/paths/~1out_payment~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes out payment","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":"If the payment is not processed, it will be cancelled. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Get your strong authentication RSA private key from Easypay Backoffice on menu: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Web Services->Configuration API 2.0->Keys."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"out_payment:delete"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1out_payment~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/out_payment/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/out_payment/{id}","href":"out-payment/delete_out_payment_id","openApiOperationId":"delete_out_payment_id","summary":"Deletes out payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1out_payment~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1out_payment~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/out-payment/delete_out_payment_id"}],"panels":[]}]},"httpPath":"/out_payment/{id}"}],"content":{"contentType":"group","meta":{"name":"Out Payment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Out Payment","showPageActions":true},{"nodeType":"markdoc","content":"Transfer funds from Easypay accounts to SEPA bank accounts"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/out_payment","summary":"Lists out payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/out-payment/get_out_payment","deprecated":false},{"title":"/out_payment","summary":"Create out payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/out-payment/post_out_payment","deprecated":false},{"title":"/out_payment/{id}","summary":"Shows out payment details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/out-payment/get_out_payment_id","deprecated":false},{"title":"/out_payment/{id}","summary":"Deletes out payment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/out-payment/delete_out_payment_id","deprecated":false}]}]}]}]}},{"type":"group","label":"Config","link":"/pt/openapi/config","routeSlug":"/pt/openapi/config","items":[{"label":"Get Account Config","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/config/get_config","routeSlug":"/pt/openapi/config/get_config","metadata":{"seo":{"title":"Get Account Config","description":"Required scope: config:read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_config","name":"Get Account Config","isWebhook":false,"pointer":"/paths/~1config/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Account Config","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"config:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","403","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/config","href":"config/get_config","openApiOperationId":"get_config","summary":"Get Account Config"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/config-details","exampleIds":["paths/~1config/get/responses/200/content/application~1json/examples/Response"]}},"schemaId":"components/schemas/config-details","exampleIds":["paths/~1config/get/responses/200/content/application~1json/examples/Response"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1config/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/config-details","exampleIds":["paths/~1config/get/responses/200/content/application~1json/examples/Response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/config-details","exampleIds":["paths/~1config/get/responses/200/content/application~1json/examples/Response"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/config/get_config"}],"panels":[]}]},"httpPath":"/config"},{"label":"Patch Account Config","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/config/patch_config","routeSlug":"/pt/openapi/config/patch_config","metadata":{"seo":{"title":"Patch Account Config","description":"This endpoint is useful for setting up the correct URLs for event notifications.For more details, see Notifications-Webhooks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch_config","name":"Patch Account Config","isWebhook":false,"pointer":"/paths/~1config/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Account Config","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 endpoint is useful for setting up the correct URLs for event notifications."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.easypay.pt/#tag/Notifications-Webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notifications-Webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"config:update"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_266","exampleIds":["paths/~1config/patch/requestBody/content/application~1json/examples/Example 1"]}},"schemaId":"schema_266","exampleIds":["paths/~1config/patch/requestBody/content/application~1json/examples/Example 1"],"pointer":"/paths/~1config/patch/requestBody","description":"Configuration object to edit an account."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/config","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_266","exampleIds":["paths/~1config/patch/requestBody/content/application~1json/examples/Example 1"]}},"responseCodes":["200","400","403","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/config","href":"config/patch_config","openApiOperationId":"patch_config","summary":"Patch Account Config"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_266","exampleIds":["paths/~1config/patch/requestBody/content/application~1json/examples/Example 1"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_266","exampleIds":["paths/~1config/patch/requestBody/content/application~1json/examples/Example 1"]}},"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/config-details","exampleIds":["paths/~1config/patch/responses/200/content/application~1json/examples/Response"]}},"schemaId":"components/schemas/config-details","exampleIds":["paths/~1config/patch/responses/200/content/application~1json/examples/Response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/patch/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/patch/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1config/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/config-details","exampleIds":["paths/~1config/patch/responses/200/content/application~1json/examples/Response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/config-details","exampleIds":["paths/~1config/patch/responses/200/content/application~1json/examples/Response"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/patch/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/patch/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/patch/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1config/patch/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/config/patch_config"}],"panels":[]}]},"httpPath":"/config"}],"content":{"contentType":"group","meta":{"name":"Config"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Config","showPageActions":true},{"nodeType":"markdoc","content":"Configure account URLs for notifications and credit card transactions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/config","summary":"Get Account Config","prefix":{"name":"get","color":"get"},"badges":[],"link":"/config/get_config","deprecated":false},{"title":"/config","summary":"Patch Account Config","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/config/patch_config","deprecated":false}]}]}]}]}},{"type":"group","label":"Checkout","link":"/pt/openapi/checkout","routeSlug":"/pt/openapi/checkout","items":[{"label":"Shows checkout details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/checkout/get_checkout_id","routeSlug":"/pt/openapi/checkout/get_checkout_id","metadata":{"seo":{"title":"Shows checkout details","description":"Required scope: checkout:read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_checkout_id","name":"Shows checkout details","isWebhook":false,"pointer":"/paths/~1checkout~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shows checkout details","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"checkout:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1checkout~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/checkout/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/checkout/{id}","href":"checkout/get_checkout_id","openApiOperationId":"get_checkout_id","summary":"Shows checkout details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/checkout-get-details-response"}},"schemaId":"components/schemas/checkout-get-details-response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1checkout~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/checkout-get-details-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/checkout-get-details-response"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkout/get_checkout_id"}],"panels":[]}]},"httpPath":"/checkout/{id}"},{"label":"Cancels a checkout","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/checkout/delete_checkout_id","routeSlug":"/pt/openapi/checkout/delete_checkout_id","metadata":{"seo":{"title":"Cancels a checkout","description":"This cancels the Checkout and deletes the payment associated with it if possible."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_checkout_id","name":"Cancels a checkout","isWebhook":false,"pointer":"/paths/~1checkout~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancels a checkout","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 cancels the Checkout and deletes the payment associated with it if possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"checkout:delete"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1checkout~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/checkout/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/checkout/{id}","href":"checkout/delete_checkout_id","openApiOperationId":"delete_checkout_id","summary":"Cancels a checkout"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1checkout~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkout/delete_checkout_id"}],"panels":[]}]},"httpPath":"/checkout/{id}"},{"label":"Create Checkout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/checkout/checkout-post","routeSlug":"/pt/openapi/checkout/checkout-post","metadata":{"seo":{"title":"Create Checkout","description":"Creates a Checkout Session."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkout-post","name":"Create Checkout","isWebhook":false,"pointer":"/paths/~1checkout/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Checkout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a Checkout Session."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"checkout:create"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/checkout-request","exampleIds":["paths/~1checkout/post/requestBody/content/application~1json/examples/Create Checkout","paths/~1checkout/post/requestBody/content/application~1json/examples/Alternative Example"]}},"schemaId":"components/schemas/checkout-request","exampleIds":["paths/~1checkout/post/requestBody/content/application~1json/examples/Create Checkout","paths/~1checkout/post/requestBody/content/application~1json/examples/Alternative Example"],"pointer":"/paths/~1checkout/post/requestBody","description":"Checkout request details"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/checkout","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/checkout-request","exampleIds":["paths/~1checkout/post/requestBody/content/application~1json/examples/Create Checkout","paths/~1checkout/post/requestBody/content/application~1json/examples/Alternative Example"]}},"responseCodes":["201","400","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/checkout","href":"checkout/checkout-post","openApiOperationId":"checkout-post","summary":"Create Checkout"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"components/schemas/checkout-request","exampleIds":["paths/~1checkout/post/requestBody/content/application~1json/examples/Create Checkout","paths/~1checkout/post/requestBody/content/application~1json/examples/Alternative Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/checkout-request","exampleIds":["paths/~1checkout/post/requestBody/content/application~1json/examples/Create Checkout","paths/~1checkout/post/requestBody/content/application~1json/examples/Alternative Example"]}},"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/checkout-post-response","exampleIds":["paths/~1checkout/post/responses/201/content/application~1json/examples/Create Checkout with Success"]}},"schemaId":"components/schemas/checkout-post-response","exampleIds":["paths/~1checkout/post/responses/201/content/application~1json/examples/Create Checkout with Success"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1checkout/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/checkout-post-response","exampleIds":["paths/~1checkout/post/responses/201/content/application~1json/examples/Create Checkout with Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/checkout-post-response","exampleIds":["paths/~1checkout/post/responses/201/content/application~1json/examples/Create Checkout with Success"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1checkout/post/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkout/checkout-post"}],"panels":[]}]},"httpPath":"/checkout"}],"content":{"contentType":"group","meta":{"name":"Checkout"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Checkout","showPageActions":true},{"nodeType":"markdoc","content":"Embedded payment form solution for websites"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/checkout/{id}","summary":"Shows checkout details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/checkout/get_checkout_id","deprecated":false},{"title":"/checkout/{id}","summary":"Cancels a checkout","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/checkout/delete_checkout_id","deprecated":false},{"title":"/checkout","summary":"Create Checkout","prefix":{"name":"post","color":"post"},"badges":[],"link":"/checkout/checkout-post","deprecated":false}]}]}]}]}},{"type":"group","label":"Pay By Link","link":"/pt/openapi/pay-by-link","routeSlug":"/pt/openapi/pay-by-link","items":[{"label":"Create a payment link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/pay-by-link/post-link","routeSlug":"/pt/openapi/pay-by-link/post-link","metadata":{"seo":{"title":"Create a payment link","description":"Generates a link that takes customers straight to a secure and ready-to-pay checkout."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-link","name":"Create a payment link","isWebhook":false,"pointer":"/paths/~1link/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payment link","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":"Generates a link that takes customers straight to a secure and ready-to-pay checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"link:create"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_267","exampleIds":["paths/~1link/post/requestBody/content/application~1json/examples/Create Single payment Pay-by-link with several payment methods and sms and email communication channel","paths/~1link/post/requestBody/content/application~1json/examples/Create Single payment Pay-by-link with one payment method and no communication channel"]}},"schemaId":"schema_267","exampleIds":["paths/~1link/post/requestBody/content/application~1json/examples/Create Single payment Pay-by-link with several payment methods and sms and email communication channel","paths/~1link/post/requestBody/content/application~1json/examples/Create Single payment Pay-by-link with one payment method and no communication channel"],"pointer":"/paths/~1link/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/link","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_267","exampleIds":["paths/~1link/post/requestBody/content/application~1json/examples/Create Single payment Pay-by-link with several payment methods and sms and email communication channel","paths/~1link/post/requestBody/content/application~1json/examples/Create Single payment Pay-by-link with one payment method and no communication channel"]}},"responseCodes":["201","400","403","500","501"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/link","href":"pay-by-link/post-link","openApiOperationId":"post-link","summary":"Create a payment link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_267","exampleIds":["paths/~1link/post/requestBody/content/application~1json/examples/Create Single payment Pay-by-link with several payment methods and sms and email communication channel","paths/~1link/post/requestBody/content/application~1json/examples/Create Single payment Pay-by-link with one payment method and no communication channel"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_267","exampleIds":["paths/~1link/post/requestBody/content/application~1json/examples/Create Single payment Pay-by-link with several payment methods and sms and email communication channel","paths/~1link/post/requestBody/content/application~1json/examples/Create Single payment Pay-by-link with one payment method and no communication channel"]}},"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/link-response-object"}},"schemaId":"components/schemas/link-response-object"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link/post/responses/400/content/application~1json/examples/Example 1"]}},"schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link/post/responses/400/content/application~1json/examples/Example 1"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/forbidden-response"}},"schemaId":"components/schemas/forbidden-response"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal-server-error-response"}},"schemaId":"components/schemas/internal-server-error-response"},{"code":"501","description":"Not Implemented","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not-implemented-response"}},"schemaId":"components/schemas/not-implemented-response"}],"pointer":"/paths/~1link/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/link-response-object","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/link-response-object"}}},{"code":"400","schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link/post/responses/400/content/application~1json/examples/Example 1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link/post/responses/400/content/application~1json/examples/Example 1"]}}},{"code":"403","schemaId":"components/schemas/forbidden-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/forbidden-response"}}},{"code":"500","schemaId":"components/schemas/internal-server-error-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal-server-error-response"}}},{"code":"501","schemaId":"components/schemas/not-implemented-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not-implemented-response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pay-by-link/post-link"}],"panels":[]}]},"httpPath":"/link"},{"label":"List all payment links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/pay-by-link/get-link","routeSlug":"/pt/openapi/pay-by-link/get-link","metadata":{"seo":{"title":"List all payment links","description":"List all the payment links."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-link","name":"List all payment links","isWebhook":false,"pointer":"/paths/~1link/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all payment links","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":"List all the payment links."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"link:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_236","description":"The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results."},{"name":"limit","in":"query","schemaId":"schema_234","description":"The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100. "},{"name":"id","in":"query","schemaId":"schema_236","description":"UUID from a created Pay By Link."},{"name":"amount","in":"query","schemaId":"schema_236","description":"Filter Pay By Links by a certain amount."},{"name":"customer_name","in":"query","schemaId":"schema_236","description":"Filter Pay By Links by customer name."},{"name":"email","in":"query","schemaId":"schema_236","description":"Filter Pay By Links by customer email."},{"name":"phone_number","in":"query","schemaId":"schema_236","description":"Filter Pay By Links by customer phone number."},{"name":"created_at","in":"query","schemaId":"schema_236","description":"Filter Pay By Links by creation date."},{"name":"modified_at","in":"query","schemaId":"schema_236","description":"Filter Pay By Links by modification date."},{"name":"expiration_time","in":"query","schemaId":"schema_236","description":"Filter Pay By Links by expiration date."},{"name":"payment_method[]","in":"query","schemaId":"schema_236","description":"Filter Pay By Links by payment methods."},{"name":"status[]","in":"query","schemaId":"schema_236","description":"Filter Pay By Links by payment status."}],"pointer":"/paths/~1link/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/link","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_234"},{"name":"id","in":"query","schemaId":"schema_236"},{"name":"amount","in":"query","schemaId":"schema_236"},{"name":"customer_name","in":"query","schemaId":"schema_236"},{"name":"email","in":"query","schemaId":"schema_236"},{"name":"phone_number","in":"query","schemaId":"schema_236"},{"name":"created_at","in":"query","schemaId":"schema_236"},{"name":"modified_at","in":"query","schemaId":"schema_236"},{"name":"expiration_time","in":"query","schemaId":"schema_236"},{"name":"payment_method[]","in":"query","schemaId":"schema_236"},{"name":"status[]","in":"query","schemaId":"schema_236"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","400","403","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/link","href":"pay-by-link/get-link","openApiOperationId":"get-link","summary":"List all payment links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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_268"}},"schemaId":"schema_268"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link/get/responses/400/content/application~1json/examples/Example 1"]}},"schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link/get/responses/400/content/application~1json/examples/Example 1"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/forbidden-response"}},"schemaId":"components/schemas/forbidden-response"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal-server-error-response"}},"schemaId":"components/schemas/internal-server-error-response"}],"pointer":"/paths/~1link/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_268","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_268"}}},{"code":"400","schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link/get/responses/400/content/application~1json/examples/Example 1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link/get/responses/400/content/application~1json/examples/Example 1"]}}},{"code":"403","schemaId":"components/schemas/forbidden-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/forbidden-response"}}},{"code":"500","schemaId":"components/schemas/internal-server-error-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal-server-error-response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pay-by-link/get-link"}],"panels":[]}]},"httpPath":"/link"},{"label":"List payment link details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/pay-by-link/get-link-id","routeSlug":"/pt/openapi/pay-by-link/get-link-id","metadata":{"seo":{"title":"List payment link details","description":"Lists a payment link with all the details identified by its unique ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-link-id","name":"List payment link details","isWebhook":false,"pointer":"/paths/~1link~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment link details","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":"Lists a payment link with all the details identified by its unique ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"link:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_236","required":true}],"pointer":"/paths/~1link~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/link/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_236"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","400","403","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/link/{id}","href":"pay-by-link/get-link-id","openApiOperationId":"get-link-id","summary":"List payment link details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/link-get-response-object"}},"schemaId":"components/schemas/link-get-response-object"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link~1{id}/get/responses/400/content/application~1json/examples/Example 1"]}},"schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link~1{id}/get/responses/400/content/application~1json/examples/Example 1"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/forbidden-response"}},"schemaId":"components/schemas/forbidden-response"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal-server-error-response"}},"schemaId":"components/schemas/internal-server-error-response"}],"pointer":"/paths/~1link~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/link-get-response-object","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/link-get-response-object"}}},{"code":"400","schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link~1{id}/get/responses/400/content/application~1json/examples/Example 1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link~1{id}/get/responses/400/content/application~1json/examples/Example 1"]}}},{"code":"403","schemaId":"components/schemas/forbidden-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/forbidden-response"}}},{"code":"500","schemaId":"components/schemas/internal-server-error-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal-server-error-response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pay-by-link/get-link-id"}],"panels":[]}]},"httpPath":"/link/{id}"},{"label":"Delete Link","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/pay-by-link/delete-link-id","routeSlug":"/pt/openapi/pay-by-link/delete-link-id","metadata":{"seo":{"title":"Delete Link","description":"Deletes a payment link identified by its unique ID. Once deleted, the link becomes invalid and can no longer be used. This action is irreversible."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-link-id","name":"Delete Link","isWebhook":false,"pointer":"/paths/~1link~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Link","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":"Deletes a payment link identified by its unique ID. Once deleted, the link becomes invalid and can no longer be used. This action is irreversible."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"link:delete"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_236","required":true}],"pointer":"/paths/~1link~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/link/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_236"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["204","400","403","404","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/link/{id}","href":"pay-by-link/delete-link-id","openApiOperationId":"delete-link-id","summary":"Delete Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/forbidden-response"}},"schemaId":"components/schemas/forbidden-response"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1link~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1link~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1link~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1link~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1link~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/forbidden-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/forbidden-response"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1link~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1link~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1link~1{id}/delete/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1link~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pay-by-link/delete-link-id"}],"panels":[]}]},"httpPath":"/link/{id}"},{"label":"Update Link","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/pay-by-link/patch-link","routeSlug":"/pt/openapi/pay-by-link/patch-link","metadata":{"seo":{"title":"Update Link","description":"Updates a payment link identified by its unique ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch-link","name":"Update Link","isWebhook":false,"pointer":"/paths/~1link~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Link","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":"Updates a payment link identified by its unique ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"link:update"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_236","required":true}],"pointer":"/paths/~1link~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_269"}},"schemaId":"schema_269","pointer":"/paths/~1link~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/link/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_236"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_269"}},"responseCodes":["200","400","403","404","409","500","501"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/link/{id}","href":"pay-by-link/patch-link","openApiOperationId":"patch-link","summary":"Update Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_269","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_269"}},"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/link-get-response-object"}},"schemaId":"components/schemas/link-get-response-object"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link~1{id}/patch/responses/400/content/application~1json/examples/Example 1"]}},"schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link~1{id}/patch/responses/400/content/application~1json/examples/Example 1"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/forbidden-response"}},"schemaId":"components/schemas/forbidden-response"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not-found-response"}},"schemaId":"components/schemas/not-found-response"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conflict-response"}},"schemaId":"components/schemas/conflict-response"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal-server-error-response"}},"schemaId":"components/schemas/internal-server-error-response"},{"code":"501","description":"Not Implemented"}],"pointer":"/paths/~1link~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/link-get-response-object","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/link-get-response-object"}}},{"code":"400","schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link~1{id}/patch/responses/400/content/application~1json/examples/Example 1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bad-request-response","exampleIds":["paths/~1link~1{id}/patch/responses/400/content/application~1json/examples/Example 1"]}}},{"code":"403","schemaId":"components/schemas/forbidden-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/forbidden-response"}}},{"code":"404","schemaId":"components/schemas/not-found-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not-found-response"}}},{"code":"409","schemaId":"components/schemas/conflict-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conflict-response"}}},{"code":"500","schemaId":"components/schemas/internal-server-error-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal-server-error-response"}}},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pay-by-link/patch-link"}],"panels":[]}]},"httpPath":"/link/{id}"}],"content":{"contentType":"group","meta":{"name":"Pay By Link"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pay By Link","showPageActions":true},{"nodeType":"markdoc","content":"Generate and manage shareable payment links"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/link","summary":"Create a payment link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pay-by-link/post-link","deprecated":false},{"title":"/link","summary":"List all payment links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pay-by-link/get-link","deprecated":false},{"title":"/link/{id}","summary":"List payment link details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pay-by-link/get-link-id","deprecated":false},{"title":"/link/{id}","summary":"Delete Link","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pay-by-link/delete-link-id","deprecated":false},{"title":"/link/{id}","summary":"Update Link","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/pay-by-link/patch-link","deprecated":false}]}]}]}]}},{"type":"group","label":"Customer","link":"/pt/openapi/customer","routeSlug":"/pt/openapi/customer","items":[{"label":"Show customer details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/customer/get_customer_id","routeSlug":"/pt/openapi/customer/get_customer_id","metadata":{"seo":{"title":"Show customer details","description":"Retrieves the customer details, including reward balances."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_customer_id","name":"Show customer details","isWebhook":false,"pointer":"/paths/~1customer~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Show customer details","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":"Retrieves the customer details, including reward balances."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1customer~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customer/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/customer/{id}","href":"customer/get_customer_id","openApiOperationId":"get_customer_id","summary":"Show customer details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/customer-detail","exampleIds":["paths/~1customer~1{id}/get/responses/200/content/application~1json/examples/Success"]}},"schemaId":"components/schemas/customer-detail","exampleIds":["paths/~1customer~1{id}/get/responses/200/content/application~1json/examples/Success"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1customer~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/customer-detail","exampleIds":["paths/~1customer~1{id}/get/responses/200/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/customer-detail","exampleIds":["paths/~1customer~1{id}/get/responses/200/content/application~1json/examples/Success"]}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer/get_customer_id"}],"panels":[]}]},"httpPath":"/customer/{id}"},{"label":"List customer reward ledger entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/customer/get_customer_id_rewards","routeSlug":"/pt/openapi/customer/get_customer_id_rewards","metadata":{"seo":{"title":"List customer reward ledger entries","description":"Lists reward ledger entries for a customer. Each entry is a single movement — a reward earned (type: REWARD), a redemption against a reward (type: REDEMPTION), an unused reward swept at its expiry date (type: REWARD_EXPIRATION), a reward taken back after the earning capture was refunded or charged back (type: REWARD_REVERSAL), or a redemption given back as fresh credit after a refund or chargeback (type: REWARD_RESTORATION). Supports filtering by account, type, expiry date, and creation date. Results are sorted by creation date descending (newest first). See the Rewards & Redemptions guide for the full flow."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_customer_id_rewards","name":"List customer reward ledger entries","isWebhook":false,"pointer":"/paths/~1customer~1{id}~1rewards/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List customer reward ledger entries","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":"Lists reward ledger entries for a customer. Each entry is a single movement — a reward earned ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REWARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), a redemption against a reward ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REDEMPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), an unused reward swept at its expiry date ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REWARD_EXPIRATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), a reward taken back after the earning capture was refunded or charged back ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REWARD_REVERSAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or a redemption given back as fresh credit after a refund or chargeback ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REWARD_RESTORATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Supports filtering by account, type, expiry date, and creation date. Results are sorted by creation date descending (newest first). See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/guides/rewards-and-redemptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rewards & Redemptions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1customer~1{id}~1rewards/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_236","description":"The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results."},{"name":"limit","in":"query","schemaId":"schema_234","description":"The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100. "},{"name":"account_id[]","in":"query","schemaId":"schema_270","description":"Filter by reward account identifier. Repeat the parameter to filter by multiple accounts."},{"name":"type[]","in":"query","schemaId":"schema_271","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by ledger entry type. Repeat the parameter to filter by multiple types. Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REWARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only matches earned rewards — credits given back after a refund or chargeback are matched by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REWARD_RESTORATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"expiration_date","in":"query","schemaId":"schema_272","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by expiry date. Accepts a single date "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (matches that whole day) or an interval "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval(YYYY-MM-DD,YYYY-MM-DD)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Maximum interval span is 1 year."},"children":[]}]}]}]},{"name":"created_at","in":"query","schemaId":"schema_273","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by creation datetime in UTC. Accepts a single datetime "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD HH:MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (matches that whole minute) or an interval "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Maximum interval span is 1 year."},"children":[]}]}]}]}],"pointer":"/paths/~1customer~1{id}~1rewards/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customer/{id}/rewards","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_234"},{"name":"account_id[]","in":"query","required":false,"example":"458b2fc4-3092-4de3-abd4-fe1600c09420","schemaId":"schema_270"},{"name":"type[]","in":"query","required":false,"example":"REWARD","schemaId":"schema_271"},{"name":"expiration_date","in":"query","required":false,"example":"interval(2026-01-01,2027-12-31)","schemaId":"schema_272"},{"name":"created_at","in":"query","required":false,"example":"interval(2026-01-01 00:00,2026-01-31 23:59)","schemaId":"schema_273"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/customer/{id}/rewards","href":"customer/get_customer_id_rewards","openApiOperationId":"get_customer_id_rewards","summary":"List customer reward ledger entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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_274","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/200/content/application~1json/examples/Success"]}},"schemaId":"schema_274","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/200/content/application~1json/examples/Success"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1customer~1{id}~1rewards/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_274","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/200/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_274","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/200/content/application~1json/examples/Success"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1customer~1{id}~1rewards/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer/get_customer_id_rewards"}],"panels":[]}]},"httpPath":"/customer/{id}/rewards"}],"content":{"contentType":"group","meta":{"name":"Customer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve customer details and reward credit history"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customer/{id}","summary":"Show customer details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer/get_customer_id","deprecated":false},{"title":"/customer/{id}/rewards","summary":"List customer reward ledger entries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer/get_customer_id_rewards","deprecated":false}]}]}]}]}},{"type":"group","label":"Terminals","link":"/pt/openapi/terminals","routeSlug":"/pt/openapi/terminals","items":[{"label":"List terminals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/terminals/get_terminal","routeSlug":"/pt/openapi/terminals/get_terminal","metadata":{"seo":{"title":"List terminals","description":"List all terminals (POS devices) from your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_terminal","name":"List terminals","isWebhook":false,"pointer":"/paths/~1terminal/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List terminals","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":"List all terminals (POS devices) from your account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminal:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_236","description":"The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results."},{"name":"limit","in":"query","schemaId":"schema_234","description":"The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100. "},{"name":"name","in":"query","schemaId":"schema_236","description":"Filter by terminal name"},{"name":"status","in":"query","schemaId":"schema_275","description":"Filter by terminal status"},{"name":"model","in":"query","schemaId":"schema_236","description":"Filter by terminal model"}],"pointer":"/paths/~1terminal/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/terminal","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_234"},{"name":"name","in":"query","schemaId":"schema_236"},{"name":"status","in":"query","schemaId":"schema_275"},{"name":"model","in":"query","schemaId":"schema_236"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","403","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/terminal","href":"terminals/get_terminal","openApiOperationId":"get_terminal","summary":"List terminals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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_276","exampleIds":["paths/~1terminal/get/responses/200/content/application~1json/examples/Success"]}},"schemaId":"schema_276","exampleIds":["paths/~1terminal/get/responses/200/content/application~1json/examples/Success"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1terminal/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_276","exampleIds":["paths/~1terminal/get/responses/200/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_276","exampleIds":["paths/~1terminal/get/responses/200/content/application~1json/examples/Success"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/terminals/get_terminal"}],"panels":[]}]},"httpPath":"/terminal"},{"label":"Create terminal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/terminals/post_terminal","routeSlug":"/pt/openapi/terminals/post_terminal","metadata":{"seo":{"title":"Create terminal","description":"Creates a new terminal (POS device)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post_terminal","name":"Create terminal","isWebhook":false,"pointer":"/paths/~1terminal/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create terminal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new terminal (POS device)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminal:create"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_277","exampleIds":["paths/~1terminal/post/requestBody/content/application~1json/examples/Create a Terminal"]}},"schemaId":"schema_277","exampleIds":["paths/~1terminal/post/requestBody/content/application~1json/examples/Create a Terminal"],"pointer":"/paths/~1terminal/post/requestBody","description":"Terminal object to create a new terminal"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/terminal","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_277","exampleIds":["paths/~1terminal/post/requestBody/content/application~1json/examples/Create a Terminal"]}},"responseCodes":["201","400","403","409","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/terminal","href":"terminals/post_terminal","openApiOperationId":"post_terminal","summary":"Create terminal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_277","exampleIds":["paths/~1terminal/post/requestBody/content/application~1json/examples/Create a Terminal"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_277","exampleIds":["paths/~1terminal/post/requestBody/content/application~1json/examples/Create a Terminal"]}},"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/terminal","exampleIds":["paths/~1terminal/post/responses/201/content/application~1json/examples/Success"]}},"schemaId":"components/schemas/terminal","exampleIds":["paths/~1terminal/post/responses/201/content/application~1json/examples/Success"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1terminal/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/terminal","exampleIds":["paths/~1terminal/post/responses/201/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/terminal","exampleIds":["paths/~1terminal/post/responses/201/content/application~1json/examples/Success"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"409","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal/post/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/terminals/post_terminal"}],"panels":[]}]},"httpPath":"/terminal"},{"label":"Show terminal details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/terminals/get_terminal_id","routeSlug":"/pt/openapi/terminals/get_terminal_id","metadata":{"seo":{"title":"Show terminal details","description":"Retrieves the terminal details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_terminal_id","name":"Show terminal details","isWebhook":false,"pointer":"/paths/~1terminal~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Show terminal details","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":"Retrieves the terminal details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminal:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1terminal~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/terminal/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/terminal/{id}","href":"terminals/get_terminal_id","openApiOperationId":"get_terminal_id","summary":"Show terminal details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"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/terminal","exampleIds":["paths/~1terminal~1{id}/get/responses/200/content/application~1json/examples/Success"]}},"schemaId":"components/schemas/terminal","exampleIds":["paths/~1terminal~1{id}/get/responses/200/content/application~1json/examples/Success"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1terminal~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/terminal","exampleIds":["paths/~1terminal~1{id}/get/responses/200/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/terminal","exampleIds":["paths/~1terminal~1{id}/get/responses/200/content/application~1json/examples/Success"]}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/terminals/get_terminal_id"}],"panels":[]}]},"httpPath":"/terminal/{id}"},{"label":"Delete terminal","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/terminals/delete_terminal_id","routeSlug":"/pt/openapi/terminals/delete_terminal_id","metadata":{"seo":{"title":"Delete terminal","description":"Deletes the terminal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_terminal_id","name":"Delete terminal","isWebhook":false,"pointer":"/paths/~1terminal~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete terminal","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":"Deletes the terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminal:delete"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1terminal~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/terminal/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","404","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/terminal/{id}","href":"terminals/delete_terminal_id","openApiOperationId":"delete_terminal_id","summary":"Delete terminal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1terminal~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/delete/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/terminals/delete_terminal_id"}],"panels":[]}]},"httpPath":"/terminal/{id}"},{"label":"Update terminal","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/terminals/patch_terminal_id","routeSlug":"/pt/openapi/terminals/patch_terminal_id","metadata":{"seo":{"title":"Update terminal","description":"Updates the terminal details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch_terminal_id","name":"Update terminal","isWebhook":false,"pointer":"/paths/~1terminal~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update terminal","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":"Updates the terminal details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminal:update"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"Resource Identification","required":true}],"pointer":"/paths/~1terminal~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_278","exampleIds":["paths/~1terminal~1{id}/patch/requestBody/content/application~1json/examples/Update Terminal name"]}},"schemaId":"schema_278","exampleIds":["paths/~1terminal~1{id}/patch/requestBody/content/application~1json/examples/Update Terminal name"],"pointer":"/paths/~1terminal~1{id}/patch/requestBody","description":"Terminal object to update an existing terminal"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/terminal/{id}","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_278","exampleIds":["paths/~1terminal~1{id}/patch/requestBody/content/application~1json/examples/Update Terminal name"]}},"responseCodes":["200","400","401","403","404","409","429","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/terminal/{id}","href":"terminals/patch_terminal_id","openApiOperationId":"patch_terminal_id","summary":"Update terminal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"schemaId":"schema_278","exampleIds":["paths/~1terminal~1{id}/patch/requestBody/content/application~1json/examples/Update Terminal name"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_278","exampleIds":["paths/~1terminal~1{id}/patch/requestBody/content/application~1json/examples/Update Terminal name"]}},"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/terminal","exampleIds":["paths/~1terminal~1{id}/patch/responses/200/content/application~1json/examples/Success"]}},"schemaId":"components/schemas/terminal","exampleIds":["paths/~1terminal~1{id}/patch/responses/200/content/application~1json/examples/Success"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}},"schemaId":"components/schemas/error-response-4xx"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1terminal~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/terminal","exampleIds":["paths/~1terminal~1{id}/patch/responses/200/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/terminal","exampleIds":["paths/~1terminal~1{id}/patch/responses/200/content/application~1json/examples/Success"]}}},{"code":"400","schemaId":"components/schemas/error-response-4xx","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx"}}},{"code":"401","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"]}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"404","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"]}}},{"code":"409","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"]}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1terminal~1{id}/patch/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/terminals/patch_terminal_id"}],"panels":[]}]},"httpPath":"/terminal/{id}"}],"content":{"contentType":"group","meta":{"name":"Terminals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Terminals","showPageActions":true},{"nodeType":"markdoc","content":"Manage terminals (POS devices)"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/terminal","summary":"List terminals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/terminals/get_terminal","deprecated":false},{"title":"/terminal","summary":"Create terminal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/terminals/post_terminal","deprecated":false},{"title":"/terminal/{id}","summary":"Show terminal details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/terminals/get_terminal_id","deprecated":false},{"title":"/terminal/{id}","summary":"Delete terminal","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/terminals/delete_terminal_id","deprecated":false},{"title":"/terminal/{id}","summary":"Update terminal","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/terminals/patch_terminal_id","deprecated":false}]}]}]}]}},{"type":"group","label":"System","link":"/pt/openapi/system","routeSlug":"/pt/openapi/system","items":[{"label":"Check connectivity and authentication","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt/openapi/system/ping","routeSlug":"/pt/openapi/system/ping","metadata":{"seo":{"title":"Check connectivity and authentication","description":"This endpoint allows you to verify connectivity to the API and validate your authentication credentials.A successful response indicates that the API is reachable and your credentials are valid."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ping","name":"Check connectivity and authentication","isWebhook":false,"pointer":"/paths/~1system~1ping/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check connectivity and authentication","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 endpoint allows you to verify connectivity to the API and validate your authentication credentials."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response indicates that the API is reachable and your credentials are valid."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{"style":{"background":"#e8f0fe","color":"#1a73e8","padding":"2px 8px","borderRadius":"12px","fontSize":"0.85em"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"system:read"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"accountId","scopes":[],"type":"apiKey","in":"header","paramName":"AccountId","description":"This is the identification for the Easypay Client Account"},{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey","description":"This is the counter key for the used Account Id"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/system/ping","servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accountId","type":"apiKey","name":"AccountId","in":"header","x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6","x-defaultTokenType":"string"}}},{"id":"apiKey","type":"apiKey","name":"ApiKey","in":"header","x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string","serverValues":{"https://api.test.easypay.pt/2.0":{"x-defaultAccessToken":"eae4aa59-8e5b-4ec2-887d-b02768481a92","x-defaultTokenType":"string"}}}],"scopes":[]}],"responseCodes":["200","403","500"],"requestValues":{"security":{"accountId":{"token":{"token_type":"string","access_token":"2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6"}},"apiKey":{"token":{"token_type":"string","access_token":"eae4aa59-8e5b-4ec2-887d-b02768481a92"}}}},"pointer":"/system/ping","href":"system/ping","openApiOperationId":"ping","summary":"Check connectivity and authentication"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279"}},"schemaId":"schema_279"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1system~1ping/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1system~1ping/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1system~1ping/get/responses/500/content/application~1json/examples/Internal error"]}},"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1system~1ping/get/responses/500/content/application~1json/examples/Internal error"]}],"pointer":"/paths/~1system~1ping/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_279","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279"}}},{"code":"403","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1system~1ping/get/responses/403/content/application~1json/examples/Wrong credentials provided"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1system~1ping/get/responses/403/content/application~1json/examples/Wrong credentials provided"]},"application/xml":{"schemaId":"schema_220"}}},{"code":"500","schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1system~1ping/get/responses/500/content/application~1json/examples/Internal error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response-4xx","exampleIds":["paths/~1system~1ping/get/responses/500/content/application~1json/examples/Internal error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/system/ping"}],"panels":[]}]},"httpPath":"/system/ping"}],"content":{"contentType":"group","meta":{"name":"System"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"System","showPageActions":true},{"nodeType":"markdoc","content":"System health check endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/system/ping","summary":"Check connectivity and authentication","prefix":{"name":"get","color":"get"},"badges":[],"link":"/system/ping","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/meta":{"id":"components/schemas/meta","kind":"json-schema","title":"Meta","data":{"title":"Meta","type":"object","description":"Metadata object containing pagination and result information for list responses.","properties":{"page":{"type":"object","description":"Pagination details","properties":{"current":{"type":"integer","description":"Current page number"},"total":{"type":"integer","description":"Total number of pages"}},"example":1},"records":{"type":"object","description":"Record details","properties":{"per_page":{"type":"integer","description":"Number of records per page"},"total":{"type":"integer","description":"Total number of records"}},"example":20},"links":{"type":"object","description":"Navigation links for pagination","properties":{"first":{"type":"string","description":"Link to the first page","example":"?page=1"},"prev":{"type":"string","description":"Link to the previous page","example":""},"next":{"type":"string","description":"Link to the next page","example":"?page=2"},"last":{"type":"string","description":"Link to the last page","example":"?page=826"}}}}}},"components/schemas/identifier":{"id":"components/schemas/identifier","kind":"json-schema","title":"identifier","data":{"type":"string","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"}},"components/schemas/customer-response-on-list":{"id":"components/schemas/customer-response-on-list","kind":"json-schema","title":"customer-response-on-list","data":{"type":"object","description":"Customer information as returned in list responses (may contain masked/partial data for privacy)","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/identifier"}]},"name":{"type":"string","description":"Customer name (may be partially masked for privacy)","example":"Jos*** Gom***"},"email":{"type":"string","description":"Customer email (may be partially masked for privacy)","example":"cus***@example.com"},"phone":{"type":"string","description":"Customer phone (may be partially masked for privacy)","example":"911***567"},"phone_indicative":{"type":"string","description":"Phone country code","example":"+351"},"fiscal_number":{"type":"string","description":"Fiscal number (may be partially masked for privacy)","example":"PT123***89"},"key":{"type":"string","description":"Customer key","example":"Key Example"},"language":{"type":"string","description":"Customer preferred language","example":"PT"}}}},"components/schemas/sdd-mandate-response-on-list":{"id":"components/schemas/sdd-mandate-response-on-list","kind":"json-schema","title":"sdd-mandate-response-on-list","data":{"type":"object","description":"SDD Mandate information as returned in list responses (contains masked data for privacy)","properties":{"id":{"type":"string","description":"Mandate ID","example":"50389142122"},"iban":{"type":"string","description":"IBAN (partially hidden for data security reasons)","example":"PT500027**XX7833"},"key":{"type":"string","description":"Mandate key","example":"SDD Mandate key"},"name":{"type":"string","description":"Account holder name (partially hidden for data security reasons)","example":"Fre*** DD***"},"email":{"type":"string","description":"Account holder email (partially hidden for data security reasons)","example":"Cam***@yahoo.com"},"phone":{"type":"string","description":"Account holder phone (partially hidden for data security reasons)","example":"911***567"},"account_holder":{"type":"string","description":"Account holder name (partially hidden for data security reasons)","example":"Acc*** Exa***"},"country_code":{"type":"string","description":"Country code","example":"PT"},"max_num_debits":{"type":"string","description":"Maximum number of debits allowed","example":"12"},"billing_entity":{"type":"string","description":"Billing entity identifier","example":"PT16103627"}}}},"components/schemas/response-mbway":{"id":"components/schemas/response-mbway","kind":"json-schema","title":"ResponseMbway","data":{"title":"ResponseMbway","type":"object","description":"An object that holds the details specific to an MB WAY payment.","properties":{"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The phone number charged for the MB WAY payment, in full E.164 format (leading "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and country code)."},"children":[]}]}]}],"example":"+351911234567"}}}},"components/schemas/single-all-method-response":{"id":"components/schemas/single-all-method-response","kind":"json-schema","title":"SingleAllMethodResponse","data":{"title":"SingleAllMethodResponse","type":"object","properties":{"type":{"enum":["CC","DD","VI","MBW","MB","AP","GP","SW","IPP"]},"status":{"enum":["active","deleted","pending"]},"sdd_mandate":{"$ref":"#/components/schemas/sdd-mandate-response-on-list"},"mbway":{"allOf":[{"$ref":"#/components/schemas/response-mbway"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"method.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MBW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mbway.phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was supplied when creating the payment."},"children":[]}]}]}]},"card_type":{"type":"string","description":"Indicates the type of credit card used for the payment (e.g., \"Visa\", \"MasterCard\"). This field is only applicable for credit card transactions.","enum":["VISA","MasterCard"]},"last_four":{"type":"string","description":"The last four digits of the credit card number used for the payment. This field is only applicable for credit card transactions.","example":"1234"},"expiration_date":{"type":"string"},"url":{"type":"string","format":"uri","description":"The URL where the merchant should redirect the user to complete Credit Card Payments. This field is only applicable and available for credit card payment transactions.","example":"https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a"},"alias":{"deprecated":true,"type":"string","description":"A unique identifier for the user within the MB WAY system, used to identify the user in the MB WAY SDK. This field is only applicable and available for MB WAY transactions."},"entity":{"type":"string","description":"The identifier for the Multibanco entity to which the payment should be routed. This field specifies the entity code required for processing the payment through the Multibanco network, ensuring that the payment is directed to the correct recipient.","minLength":5,"maxLength":5,"example":"11683"},"reference":{"type":"string","minLength":9,"maxLength":9,"example":"665876931","description":"The unique payment reference number issued for the specific Multibanco entity. This field is used by the end user to make a payment at an ATM or through home banking. It ensures that the payment is correctly attributed to the intended transaction and recipient."},"iban":{"type":"string","description":"International Bank Account Number (IBAN) in standard format","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]+$","example":"PT50002700000001234567833"}}}},"components/schemas/response-multibanco":{"id":"components/schemas/response-multibanco","kind":"json-schema","title":"ResponseMultibanco","data":{"title":"ResponseMultibanco","type":"object","description":"An object that holds the details specific to a Multibanco transaction response.","properties":{"expiration_time":{"type":["string","null"],"format":"date-time","description":"When the Multibanco reference expires","example":"2025-09-28T12:41:08Z"},"start_time":{"type":"string","format":"date-time","description":"When the Multibanco reference becomes valid","example":"2025-08-26T12:41:09Z"},"product":{"type":"string","enum":["SPG","CHECKDIGIT","FILE"],"description":"The Multibanco product type used"}}}},"components/schemas/response-terminal":{"id":"components/schemas/response-terminal","kind":"json-schema","title":"ResponseTerminal","data":{"title":"ResponseTerminal","type":"object","description":"An object that holds the details specific to an IPP terminal response.","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the terminal.","example":"458b2fc4-3092-4de3-abd4-fe1600c09420"}}}},"components/schemas/notification":{"id":"components/schemas/notification","kind":"json-schema","title":"Notification","data":{"title":"Notification","description":"Notification settings for payment methods.","type":"object","properties":{"customer_method_instructions_email":{"type":"boolean","description":"Specifies whether an email containing the payment instructions (e.g., Multibanco reference or Virtual IBAN details) should be sent to the customer's email address when the selected payment method is Multibanco or Virtual IBAN.","example":true}}}},"components/schemas/single":{"id":"components/schemas/single","kind":"json-schema","title":"single","data":{"type":"object","x-examples":{"Example 1":{"id":"f5d7148b-aab5-47c6-8cfa-557b0d58ef7b","type":"sale","key":"Example Key","expiration_time":"2024-07-01T21:38:00Z","customer":{"id":"649e88cf-0b78-4c36-8f99-33f5ebb812a1","name":"Jos*** Gom***","email":"cus***@example.com","phone":"911***567","fiscal_number":"***","language":""},"method":{"type":"MBW","status":"active"},"currency":"EUR","value":200,"created_at":"2024-06-30 21:38:31","payment_status":"pending"}},"properties":{"id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"type":{"type":"string","enum":["sale","authorisation"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of financial operation being performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TYPE"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESCRIPTION"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sale"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a complete transaction where funds are immediately captured."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorisation"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a temporary hold on funds pending a future capture."},"children":[]}]}]}]}]}]}]},"key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system.","example":"Payment of Invoice Nº 1982652"},"descriptive":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as \"Payment of Invoice Nº 1982652\" or \"Ticket for Queen\"."},"children":[]}]}]}],"maxLength":255,"example":"Payment of Invoice Nº 1982652"},"expiration_time":{"type":"string","example":"2024-06-30 21:38:31"},"customer":{"$ref":"#/components/schemas/customer-response-on-list"},"method":{"$ref":"#/components/schemas/single-all-method-response"},"currency":{"type":"string","description":"ISO 4217 currency code. If not specified, the default currency is set to EUR.","example":"EUR"},"value":{"type":"number","format":"double","description":"The monetary amount for the transaction. This field specifies the value of the payment in the designated currency. It must be a positive decimal number representing the exact amount to be processed.","example":17.5,"minimum":0.5,"maximum":999999.99},"created_at":{"type":"string","example":"2024-06-30 21:38:31"},"payment_status":{"type":"string","enum":["pending","paid","authorised","error","deleted","failed","active"],"description":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment is awaiting processing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment has been completed successfully."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorised"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment has been authorized but not yet captured."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An error occurred during the payment process."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment has been deleted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment attempt failed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment is currently active."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment has been voided."},"children":[]}]}]}]}]}]}]},"multibanco":{"$ref":"#/components/schemas/response-multibanco"},"terminal":{"allOf":[{"$ref":"#/components/schemas/response-terminal"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"method.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IPP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"notification":{"$ref":"#/components/schemas/notification"}}}},"components/schemas/error-response-4xx":{"id":"components/schemas/error-response-4xx","kind":"json-schema","title":"ErrorResponse4xx","data":{"title":"ErrorResponse4xx","type":"object","properties":{"status":{"type":"string"},"message":{"type":"array","items":{"type":"string"},"description":"An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request."}},"required":["status","message"]}},"components/schemas/capture-account":{"id":"components/schemas/capture-account","kind":"json-schema","title":"CaptureAccount","data":{"title":"CaptureAccount","type":"object","description":"An object within the capture request that specifies the details of the account to which the funds should be routed, different from the initially requested account. This ensures that the captured funds are directed to the correct destination as per the specific routing requirements.","properties":{"id":{"type":"string","description":"The unique identifier of the account where the captured funds will be routed. This ID corresponds to an existing account in the system and is used to specify the destination for the capture transaction."}},"required":["id"]}},"components/schemas/capture-split-create":{"id":"components/schemas/capture-split-create","kind":"json-schema","title":"capture-split-create","data":{"type":"object","description":"Represents a split configuration for dividing transaction funds across multiple accounts. This is useful for marketplace or multi-vendor scenarios where transaction proceeds need to be distributed.","required":["value"],"properties":{"split_key":{"type":"string","description":"A customizable text field for users to input their own identifier for the split.","maxLength":50,"example":"Payment of Invoice Nº 1982652"},"split_descriptive":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as \"Payment of Invoice Nº 1982652\" or \"Ticket for Queen\"."},"children":[]}]}]}],"maxLength":255,"example":"Payment of Invoice Nº 1982652"},"account":{"type":"object","description":"The account to receive the split funds","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/identifier"}]}},"required":["id"]},"value":{"type":"number","format":"double","example":17.5,"minimum":0.5,"maximum":999999.99,"description":"The monetary amount for the transaction. This field specifies the value of the payment in the designated currency. It must be a positive decimal number representing the exact amount to be processed."},"clearing_period":{"type":"string","description":"The clearing period must follow the format 1Y, 10W or 30D. Y for Years, W for weeks, D for days. Minimum is 7 days, maximum is 1 year.","example":"30D"},"margin_account":{"type":"object","description":"The account to which the margin value should be routed. This field specifies the destination account for the margin portion of the funds, ensuring that the correct recipient receives the designated margin value.","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/identifier"}]}},"required":["id"]},"margin_value":{"type":"number","format":"double","description":"The margin amount to be deducted from this split","example":0.25},"reward":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reward credits to generate from this split. The credits are associated with the customer provided at the top level of the payment request and can only be redeemed by that customer. Reward funds expire after the specified period. Only available on the payment methods "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MBW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IPP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/guides/rewards-and-redemptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rewards & Redemptions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full flow."},"children":[]}]}]}],"required":["account","value"],"properties":{"account":{"type":"object","description":"The account to which the reward credits should be routed.","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/identifier"}]}},"required":["id"]},"value":{"type":"number","format":"double","description":"The reward amount to be generated from this split.","example":1},"expiration_date":{"type":"string","format":"date","description":"The date until which the reward credits are valid. Defaults to 12 months from the transaction date if not specified.","example":"2027-04-02"}}}}}},"components/schemas/reward-redemption":{"id":"components/schemas/reward-redemption","kind":"json-schema","title":"reward-redemption","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply accumulated reward credits to reduce the payment value. Supports full or partial redemption of available reward balance. Only available on the payment methods "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MBW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IPP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/guides/rewards-and-redemptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rewards & Redemptions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full flow."},"children":[]}]}]}],"required":["account","value"],"properties":{"account":{"type":"object","description":"The reward account to debit credits from.","required":["id"],"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/identifier"}]}}},"value":{"type":"number","format":"double","description":"The reward amount to apply. Must not exceed the available reward balance or the payment value.","example":2.5,"minimum":0.01,"maximum":999999.99}}}},"components/schemas/create-capture":{"id":"components/schemas/create-capture","kind":"json-schema","title":"CreateCapture","data":{"title":"CreateCapture","type":"object","description":"The Capture object contains all the necessary information for executing a fund capture action. It defines how and where the funds should be routed upon capturing a transaction. This object is essential for finalizing transactions and ensuring the correct allocation of funds. Object required when the operation type is Sale.","required":["descriptive"],"properties":{"descriptive":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as \"Payment of Invoice Nº 1982652\" or \"Ticket for Queen\"."},"children":[]}]}]}],"maxLength":255,"example":"Payment of Invoice Nº 1982652"},"transaction_key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system.","maxLength":50,"example":"231d0464-6382-4e39-9a1f-af82ea166868"},"account":{"$ref":"#/components/schemas/capture-account"},"capture_date":{"type":"string","format":"date","description":"The date when the action should be executed. This field specifies the exact day for capturing the transaction, formatted as \"YYYY-MM-DD\" (e.g., \"2024-06-30\"). It is optional and defaults to the current date if not specified.","example":"2024-06-30"},"splits":{"type":"array","description":"An array of split objects defining how funds should be divided among multiple accounts. Each split specifies an account, an amount, and optional margin details. This is useful for marketplace or multi-vendor scenarios where transaction proceeds need to be distributed across different parties.","items":{"$ref":"#/components/schemas/capture-split-create"}},"reward_redemption":{"$ref":"#/components/schemas/reward-redemption"}}}},"components/schemas/customer":{"id":"components/schemas/customer","kind":"json-schema","title":"Customer","data":{"title":"Customer","type":"object","description":"The Customer object contains the necessary details about the customer involved in the transaction. This includes identification information, contact details, and preferences. All fields are optional unless specified otherwise.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the customer. When provided, it links the transaction to an existing customer record.","example":"649e88cf-0b78-4c36-8f99-33f5ebb812a1"},"name":{"type":"string","description":"Full name of the customer. This is typically displayed on receipts and statements.","maxLength":255,"example":"John Doe"},"email":{"type":"string","format":"email","description":"Customer's email address. Used for sending receipts, notifications, and payment confirmations.","maxLength":70,"example":"john.doe@example.com"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact phone number of the customer, excluding the country code indicator (e.g., \"+351\"). This field is used for communication purposes. If the payment method is MB WAY, the phone_number is required and is used to send the MB WAY push notification."},"children":[]}]}]}],"maxLength":15,"example":"911234567"},"phone_indicative":{"type":"string","description":"The country code indicator for the customer's phone number (e.g., \"351\" for Portugal). This field is used in conjunction with the phone number to ensure proper international dialing and communication.","maxLength":5,"example":"+351"},"fiscal_number":{"type":"string","description":"Customer's tax identification number or fiscal number. Format may vary by country.","maxLength":20,"example":"PT123456789"},"key":{"type":"string","description":"A customizable text field for users to input their own identifier for the customer. This can be any string that helps the user uniquely identify the customer in their own system.","maxLength":255,"example":"customer Key Example"},"language":{"type":"string","description":"Preferred language for customer communications. Uses ISO 639-1 language codes.","maxLength":2,"minLength":2,"enum":["PT","EN","ES"],"example":"PT"}}}},"components/schemas/sdd-mandate":{"id":"components/schemas/sdd-mandate","kind":"json-schema","title":"SddMandate","data":{"title":"SddMandate","type":"object","description":"The SDD Mandate object contains the necessary fields to create a SEPA Direct Debit mandate. This object ensures that all required information is provided to authorize and process SEPA Direct Debit transactions. Object required when method is Direct Debit.","required":["iban","name","email","phone","account_holder"],"properties":{"iban":{"type":"string","description":"The International Bank Account Number (IBAN) of the debtor's account. This field is used to uniquely identify the debtor's bank account across international borders, ensuring accurate and efficient processing of SEPA Direct Debit transactions. The IBAN is a standardized format that includes the country code, check digits, bank code, and account number.","maxLength":34,"example":"PT50002700000001234567833"},"key":{"type":"string","description":"A customizable text field for users to input their own identifier for the SDD mandate.","maxLength":255,"example":"Sdd mandate Key Example"},"name":{"type":"string","description":"Full name of the account holder as it appears on the bank account.","maxLength":100,"example":"John Doe"},"email":{"type":"string","format":"email","description":"Email address of the account holder for mandate-related communications.","maxLength":50,"example":"john.doe@example.com"},"phone":{"type":"string","description":"Phone number of the account holder without country code.","maxLength":20,"example":"911234567"},"account_holder":{"type":"string","description":"The name of the person or entity that holds the bank account. This field is used to identify the owner of the bank account involved in the transaction, ensuring that the correct account is credited or debited.","maxLength":100,"example":"John Doe"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code of the customer's country.","pattern":"^[A-Z]{2}$","example":"PT"},"max_num_debits":{"type":"string","description":"Maximum number of debits allowed under this mandate.","example":"12"},"billing_entity":{"type":"string","description":"The entity responsible for billing in the context of the SEPA Direct Debit (SDD) mandate.","example":"PT16103627"}}}},"components/schemas/response-status":{"id":"components/schemas/response-status","kind":"json-schema","title":"ResponseStatus","data":{"title":"ResponseStatus","type":"string","enum":["ok","error"],"example":"ok","description":"Indicates the overall status of the API response. 'ok' means the request was successful, 'error' indicates there was a problem."}},"components/schemas/response-message":{"id":"components/schemas/response-message","kind":"json-schema","title":"ResponseMessage","data":{"title":"ResponseMessage","type":"array","items":{"type":"string"},"example":["Your request was successfully created"],"description":"An array of messages providing details about the response status. These messages give additional context about the operation result."}},"components/schemas/iban":{"id":"components/schemas/iban","kind":"json-schema","title":"IBAN","data":{"title":"IBAN","type":"string","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]+$","description":"International Bank Account Number (IBAN) in standard format","example":"PT50002700000001234567833"}},"components/schemas/sdd-mandate-response-on-detail":{"id":"components/schemas/sdd-mandate-response-on-detail","kind":"json-schema","title":"sdd-mandate-response-on-detail","data":{"type":"object","description":"SDD Mandate information as returned in detail responses","properties":{"id":{"type":"string","description":"Mandate ID","example":"50389142122"},"iban":{"$ref":"#/components/schemas/iban"},"key":{"type":"string","description":"Mandate key","example":"Sdd mandate Key Example"},"name":{"type":"string","description":"Account holder name","example":"John Doe"},"email":{"type":"string","format":"email","description":"Account holder email","example":"john.doe@easypay.pt"},"phone":{"type":"string","description":"Account holder phone","example":"911345678"},"account_holder":{"type":"string","description":"Account holder name as registered with bank","example":"John Doe"},"country_code":{"type":"string","description":"Country code","example":"PT"},"max_num_debits":{"type":"string","description":"Maximum number of debits allowed","example":"12"},"billing_entity":{"type":"string","description":"Billing entity identifier","example":"PT16103627"},"reference_adc":{"type":"string","example":"987654321123"}}}},"components/schemas/method-on-post-response":{"id":"components/schemas/method-on-post-response","kind":"json-schema","title":"method-on-post-response","data":{"type":"object","description":"Method information returned in POST responses after creating a payment","properties":{"type":{"type":"string","description":"The payment method type","enum":["MB","CC","DD","MBW","VI","AP","GP","SW"]},"status":{"type":"string","description":"The current status of the payment method","enum":["waiting","pending","active","deleted","success"]},"entity":{"type":"string","description":"Multibanco entity (for Multibanco payments)","example":"59126"},"reference":{"type":"string","description":"Multibanco reference (for Multibanco payments)","example":"810000618"},"expiration_date":{"type":"string","description":"Expiration date of the payment method formatted as MM/DD","example":"11/28"},"url":{"type":"string","description":"Payment URL (for certain payment methods)","format":"uri"},"sdd_mandate":{"$ref":"#/components/schemas/sdd-mandate-response-on-detail"},"mbway":{"allOf":[{"$ref":"#/components/schemas/response-mbway"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"method.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MBW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mbway.phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was supplied when creating the payment."},"children":[]}]}]}]}}}},"components/schemas/split-reverts":{"id":"components/schemas/split-reverts","kind":"json-schema","title":"split-reverts","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb","description":"The unique identifier for the split associated with the capture."},"value":{"type":"number","format":"double","example":17.5,"minimum":0.5,"maximum":999999.99,"description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places (e.g., \"100.00\"). The value must be greater than or equal to 0.5."},"margin_value":{"type":"number","format":"double","example":0.25,"description":"The monetary amount designated as the margin in a split payment. This field is formatted as a double, and will be rounded to two decimal places (e.g., \"10.00\"). The value must be less than the total value of the split. This specifies the portion of the funds that should be routed to the margin account."}}}},"components/schemas/capture-split-response":{"id":"components/schemas/capture-split-response","kind":"json-schema","title":"capture-split-response","data":{"type":"object","description":"Represents a split configuration for dividing transaction funds across multiple accounts. This is useful for marketplace or multi-vendor scenarios where transaction proceeds need to be distributed.","required":["id","value","status"],"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/identifier"}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current state of this split. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waiting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while the split is queued for processing, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the funds have been routed, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if processing errored, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reverted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the split has been reverted after a refund or chargeback."},"children":[]}]}]}],"enum":["waiting","success","failed","reverted"],"example":"success"},"split_key":{"type":"string","description":"A customizable text field for users to input their own identifier for the split.","maxLength":50,"example":"Payment of Invoice Nº 1982652"},"split_descriptive":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as \"Payment of Invoice Nº 1982652\" or \"Ticket for Queen\"."},"children":[]}]}]}],"maxLength":255,"example":"Payment of Invoice Nº 1982652"},"account":{"type":"object","description":"The account to receive the split funds","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/identifier"}]}},"required":["id"]},"value":{"type":"number","format":"double","example":17.5,"minimum":0.5,"maximum":999999.99,"description":"The monetary amount for the transaction. This field specifies the value of the payment in the designated currency. It must be a positive decimal number representing the exact amount to be processed."},"clearing_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The clearing date refers to the specific date when a financial transaction is finalized and the funds are transferred from one account to another. This is the point at which the payment is officially completed and the amount is debited from the payer’s account and credited to the payee’s account."},"children":[]}]}]}],"example":"2024-06-30"},"margin_account":{"type":"object","description":"The account to which the margin value should be routed. This field specifies the destination account for the margin portion of the funds, ensuring that the correct recipient receives the designated margin value.","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/identifier"}]}},"required":["id"]},"margin_value":{"type":"number","format":"double","description":"The margin amount to be deducted from this split","example":0.25},"reward":{"type":"object","description":"Reward credits generated from this split. The credits are associated with the customer provided at the top level of the payment request and can only be redeemed by that customer. Reward funds expire after the specified period.","required":["account","value","expiration_date"],"properties":{"account":{"type":"object","description":"The account to which the reward credits are routed.","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/identifier"}]}},"required":["id"]},"value":{"type":"number","format":"double","description":"The reward amount generated from this split.","example":1},"expiration_date":{"type":"string","format":"date","description":"The date until which the reward credits are valid.","example":"2027-04-02"}}},"reverts":{"$ref":"#/components/schemas/split-reverts"}}}},"components/schemas/single-capture-full":{"id":"components/schemas/single-capture-full","kind":"json-schema","title":"SingleCaptureFull","data":{"title":"SingleCaptureFull","type":"object","description":"The Capture object contains all the necessary information for executing a fund capture action. It defines how and where the funds should be routed upon capturing a transaction. This object is essential for finalizing transactions and ensuring the correct allocation of funds.","required":["id","status","descriptive"],"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/identifier"}]},"status":{"type":"string","enum":["delayed","waiting","success","pending","failed","refunded"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the current state of a payment capture operation. This field provides clear visibility into the capture's progress and outcome:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delayed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The capture has been scheduled for a later time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The capture is queued for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The capture has been completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The capture is currently being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The capture could not be completed due to an error or issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refunded"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The capture has been refunded."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field provides a clear indication of the current state of the capture, helping users understand its progress and outcome."},"children":[]}]}]}]},"descriptive":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as \"Payment of Invoice Nº 1982652\" or \"Ticket for Queen\"."},"children":[]}]}]}],"maxLength":255,"example":"Payment of Invoice Nº 1982652"},"transaction_key":{"type":"string","example":"Payment of Invoice Nº 1982652"},"capture_date":{"type":"string","format":"date","description":"The date when the action should be executed. This field specifies the exact day for capturing the transaction, formatted as \"YYYY-MM-DD\" (e.g., \"2024-06-30\"). It is optional and defaults to the current date if not specified.","example":"2024-06-30"},"account":{"$ref":"#/components/schemas/capture-account"},"splits":{"type":"array","items":{"$ref":"#/components/schemas/capture-split-response"}},"reward_redemption":{"type":"object","description":"Reward credits redeemed in this payment.","properties":{"account":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/identifier"}]}},"required":["id"]},"value":{"type":"number","format":"double","description":"The redeemed reward amount.","example":5}}}}}},"components/schemas/descriptive":{"id":"components/schemas/descriptive","kind":"json-schema","title":"Descriptive","data":{"title":"Descriptive","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as \"Payment of Invoice Nº 1982652\" or \"Ticket for Queen\"."},"children":[]}]}]}],"maxLength":255,"example":"Payment of Invoice Nº 1982652"}},"components/schemas/value":{"id":"components/schemas/value","kind":"json-schema","title":"Value","data":{"title":"Value","type":"number","format":"double","example":17.5,"minimum":0.5,"maximum":999999.99,"description":"The monetary amount for the transaction. This field specifies the value of the payment in the designated currency. It must be a positive decimal number representing the exact amount to be processed."}},"components/schemas/currency":{"id":"components/schemas/currency","kind":"json-schema","title":"Currency","data":{"title":"Currency","description":"ISO 4217 currency code. If not specified, the default currency is set to EUR.","type":"string","enum":["EUR"],"example":"EUR"}},"components/schemas/single-detail-method-response":{"id":"components/schemas/single-detail-method-response","kind":"json-schema","title":"SingleDetailMethodResponse","data":{"title":"SingleDetailMethodResponse","type":"object","properties":{"type":{"enum":["CC","DD","VI","MBW","MB","AP","GP","SW","IPP"]},"status":{"enum":["active","deleted","pending"]},"sdd_mandate":{"$ref":"#/components/schemas/sdd-mandate-response-on-detail"},"mbway":{"allOf":[{"$ref":"#/components/schemas/response-mbway"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"method.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MBW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mbway.phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was supplied when creating the payment."},"children":[]}]}]}]},"card_type":{"type":"string","description":"Indicates the type of credit card used for the payment (e.g., \"Visa\", \"MasterCard\"). This field is only applicable for credit card transactions.","enum":["VISA","MasterCard"]},"last_four":{"type":"string","description":"The last four digits of the credit card number used for the payment. This field is only applicable for credit card transactions.","example":"1234"},"expiration_date":{"type":"string"},"url":{"type":"string","format":"uri","description":"The URL where the merchant should redirect the user to complete Credit Card Payments. This field is only applicable and available for credit card payment transactions.","example":"https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a"},"alias":{"deprecated":true,"type":"string","description":"A unique identifier for the user within the MB WAY system, used to identify the user in the MB WAY SDK. This field is only applicable and available for MB WAY transactions."},"entity":{"type":"string","description":"The identifier for the Multibanco entity to which the payment should be routed. This field specifies the entity code required for processing the payment through the Multibanco network, ensuring that the payment is directed to the correct recipient.","minLength":5,"maxLength":5,"example":"11683"},"reference":{"type":"string","minLength":9,"maxLength":9,"example":"665876931","description":"The unique payment reference number issued for the specific Multibanco entity. This field is used by the end user to make a payment at an ATM or through home banking. It ensures that the payment is correctly attributed to the intended transaction and recipient."},"iban":{"$ref":"#/components/schemas/iban"}}}},"components/schemas/payment-transactions":{"id":"components/schemas/payment-transactions","kind":"json-schema","title":"payment-transactions","data":{"type":"object","description":"Transaction details for a payment, including values and transfer information","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the transaction","example":"4fb3ac57-c7fe-4157-aeb7-4362ae24deec"},"key":{"type":"string","description":"Merchant identification key","example":"Merchant identification key"},"created_at":{"type":"string","format":"date-time","description":"When the transaction was created","example":"2025-05-30T17:21:46Z"},"date":{"type":"string","format":"date-time","description":"Transaction date","example":"2025-05-30T17:21:47Z"},"values":{"type":"object","description":"Transaction value breakdown","properties":{"requested":{"type":"number","format":"double","description":"Requested amount","example":12.55},"paid":{"type":"number","format":"double","description":"Amount actually paid","example":12.55},"fixed_fee":{"type":"number","format":"double","description":"Fixed fee charged","example":0.07},"variable_fee":{"type":"number","format":"double","description":"Variable fee charged","example":0.09},"tax":{"type":"number","format":"double","description":"Tax amount","example":0.04},"transfer":{"type":"number","format":"double","description":"Amount transferred to merchant","example":12.35}}},"transfer_date":{"type":"string","format":"date-time","description":"When the transfer occurred","example":"2025-06-02T00:00:00Z"},"transfer_batch":{"type":"string","description":"Transfer batch identifier"},"method":{"type":"string","description":"Payment method used","example":"mbw"},"document_number":{"type":"string","description":"Document number for the transaction","example":"MARCEL0208220628294020250530172147"},"descriptive":{"type":"string","description":"Transaction description","example":"Descriptive Josefa"}}}},"components/schemas/single-payment-status":{"id":"components/schemas/single-payment-status","kind":"json-schema","title":"SinglePaymentStatus","data":{"title":"SinglePaymentStatus","type":"string","enum":["pending","paid","authorised","error","deleted","failed","active"],"description":"Indicates the current status of the payment. Possible values include:\n\n    \"pending\": The payment is awaiting processing.\n    \"paid\": The payment has been completed successfully.\n    \"authorised\": The payment has been authorized but not yet captured.\n    \"error\": An error occurred during the payment process.\n    \"deleted\": The payment has been deleted.\n    \"failed\": The payment attempt failed.\n    \"active\": The payment is currently active.\n    \"voided\": The payment has been voided.","example":"paid"}},"components/schemas/key":{"id":"components/schemas/key","kind":"json-schema","title":"Key","data":{"title":"Key","type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system.","example":"01J1PKR2RPHJNJQGFWGDYXY0KM","maxLength":255}},"components/schemas/updatable-customer":{"id":"components/schemas/updatable-customer","kind":"json-schema","title":"updatable-customer","data":{"type":"object","description":"The Customer object contains detailed information about the customer involved in the transaction. Used for update operations where all fields are optional.","properties":{"name":{"type":"string","maxLength":255,"description":"The full name of the customer. This field is used to identify the customer and personalize interactions.","example":"Jonh Doe"},"email":{"type":"string","format":"email","description":"The email address of the customer. Used for communication purposes, including sending transaction confirmations and receipts.","maxLength":70,"example":"customer@example.com"},"phone":{"type":"string","description":"The contact phone number of the customer, excluding the country code indicator. Used for communication purposes.","maxLength":15,"example":"962496235"},"phone_indicative":{"type":"string","description":"The country code indicator for the customer's phone number (e.g., \"351\" for Portugal).","maxLength":5,"example":"351","default":351},"fiscal_number":{"type":"string","description":"The customer's fiscal number (prefixed by the country code).","maxLength":20,"example":"PT277712580"},"key":{"$ref":"#/components/schemas/key"},"language":{"type":"string","default":"PT","example":"PT","minLength":2,"maxLength":2,"description":"The language preference of the customer, specified in the ISO 639-1 Alpha-2 format (e.g., \"EN\" for English, \"PT\" for Portuguese)."}}}},"components/schemas/updatable-sdd-mandate":{"id":"components/schemas/updatable-sdd-mandate","kind":"json-schema","title":"updatable-sdd-mandate","data":{"description":"The SDD Mandate object contains the necessary fields to update a SEPA Direct Debit mandate. All fields are optional for update operations.","type":"object","properties":{"iban":{"type":"string","description":"The International Bank Account Number (IBAN) of the debtor's account. This field is used to uniquely identify the debtor's bank account across international borders, ensuring accurate and efficient processing of SEPA Direct Debit transactions. The IBAN is a standardized format that includes the country code, check digits, bank code, and account number.","maxLength":34,"example":"PT50002700000001234567833"},"key":{"type":"string","description":"A customizable text field for users to input their own identifier for the SDD mandate.","maxLength":255,"example":"Sdd mandate Key Example"},"name":{"type":"string","description":"Full name of the account holder as it appears on the bank account.","maxLength":100,"example":"John Doe"},"email":{"type":"string","format":"email","description":"Email address of the account holder for mandate-related communications.","maxLength":50,"example":"john.doe@example.com"},"phone":{"type":"string","description":"Phone number of the account holder without country code.","maxLength":20,"example":"911234567"},"account_holder":{"type":"string","description":"The name of the person or entity that holds the bank account. This field is used to identify the owner of the bank account involved in the transaction, ensuring that the correct account is credited or debited.","maxLength":100,"example":"John Doe"}}}},"components/schemas/single-edit-method-response":{"id":"components/schemas/single-edit-method-response","kind":"json-schema","title":"SingleEditMethodResponse","data":{"title":"SingleEditMethodResponse","type":"object","properties":{"type":{"enum":["CC","DD","VI","MBW","MB","AP","GP","SW"]},"status":{"enum":["active","deleted","pending"]},"entity":{"type":"string","description":"The identifier for the Multibanco entity to which the payment should be routed. This field specifies the entity code required for processing the payment through the Multibanco network, ensuring that the payment is directed to the correct recipient.","example":"11683"},"reference":{"type":"string","example":"665876931","description":"The unique payment reference number issued for the specific Multibanco entity. This field is used by the end user to make a payment at an ATM or through home banking. It ensures that the payment is correctly attributed to the intended transaction and recipient."},"url":{"type":"string","format":"uri","description":"The URL where the merchant should redirect the user to complete Credit Card Payments. This field is only applicable and available for credit card payment transactions.","example":"https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a"}}}},"components/schemas/frequent-method-response":{"id":"components/schemas/frequent-method-response","kind":"json-schema","title":"Frequent Payment Method Response","data":{"title":"Frequent Payment Method Response","description":"Method details for frequent payment responses","type":"object","properties":{"type":{"type":"string","enum":["CC","DD","MBW","MB","VI"],"description":"Payment method type","example":"MBW"},"status":{"type":"string","enum":["active","inactive","waiting","pending","deleted","success"],"description":"Current status of the payment method","example":"active"},"sdd_mandate":{"$ref":"#/components/schemas/sdd-mandate"},"card_type":{"type":"string","description":"Indicates the type of credit card used for the payment (e.g., \"Visa\", \"MasterCard\"). This field is only applicable for credit card transactions.","enum":["VISA","MasterCard"],"example":"VISA"},"last_four":{"type":"string","description":"The last four digits of the credit card number used for the payment. This field is only applicable for credit card transactions.","example":"0000"},"expiration_date":{"type":"string","description":"Credit card expiration date in MM/YY format","example":"04/25"},"url":{"type":"string","format":"uri","description":"The URL where the merchant should redirect the user to complete Credit Card Payments. This field is only applicable and available for credit card payment transactions.","example":"https://cc.test.easypay.pt/start/ac1913a3-fd78-4822-8394-0a14f4169247"},"alias":{"type":"string","description":"A unique identifier for the user within the MB WAY system, used to identify the user in the MB WAY SDK. This field is only applicable and available for MB WAY transactions.","example":"79cb81f626924c71926cdb36a03a0590","deprecated":true},"entity":{"type":"string","description":"The identifier for the Multibanco entity to which the payment should be routed. This field specifies the entity code required for processing the payment through the Multibanco network, ensuring that the payment is directed to the correct recipient.","minLength":5,"maxLength":5,"example":"11683"},"reference":{"type":"string","minLength":9,"maxLength":9,"example":"665876931","description":"The unique payment reference number issued for the specific Multibanco entity. This field is used by the end user to make a payment at an ATM or through home banking. It ensures that the payment is correctly attributed to the intended transaction and recipient."},"iban":{"type":"string","description":"International Bank Account Number (IBAN) in standard format","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]+$","example":"PT50002700000001234567833"}}}},"components/schemas/frequent":{"id":"components/schemas/frequent","kind":"json-schema","title":"Frequent","data":{"title":"Frequent","type":"object","examples":[{"id":"ef66f227-2318-4079-8793-ce0fbf651d5c","key":"Default Key","expiration_time":"2024-07-01T15:15:00Z","customer":{"id":"df0eac33-a487-4338-96cb-5dea17bdb469","name":"Cus*** Exa***","email":"cus***@example.com","phone":"911***567","phone_indicative":"351","fiscal_number":"PT123***89","key":"Key Example","language":"PT"},"method":{"type":"MBW","status":"active","alias":"79cb81f626924c71926cdb36a03a0590"},"currency":"EUR","max_value":20,"min_value":2,"unlimited_payments":false,"created_at":"2024-06-30 15:15:05"},{"id":"545eaf84-2644-4bc1-83d5-a1a6845b85d2","key":"Default Key","expiration_time":"2024-07-01T15:15:00Z","customer":{"id":"74fdaf37-e045-4d01-a3aa-71eb198bf3db","name":"Cus*** Exa***","email":"cus***@example.com","phone":"911***567","phone_indicative":"351","fiscal_number":"PT123***89","key":"Key Example","language":"PT"},"method":{"type":"DD","status":"active","sdd_mandate":{"id":"50355335333","billing_entity":"PT16103627","iban":"PT500027**XX7833","key":"Sdd Mandate key","name":"Fre*** DD***","email":"cus***@example.com","phone":"911***567","account_holder":"Acc*** Exa***","country_code":"PT","max_num_debits":"0"}},"currency":"EUR","max_value":10,"min_value":2,"unlimited_payments":false,"created_at":"2024-06-30 15:15:06"}],"required":["id","max_value","min_value","created_at"],"properties":{"id":{"type":"string","format":"uuid","title":"Identifier","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system.","example":"Default Key"},"expiration_time":{"type":"string","description":"Expiration date and time for the frequent payment in ISO 8601 format","example":"2024-07-01T15:15:00Z"},"customer":{"$ref":"#/components/schemas/customer"},"method":{"$ref":"#/components/schemas/frequent-method-response"},"currency":{"type":"string","enum":["EUR"],"description":"The currency code in ISO 4217 format (e.g., \"EUR\" for Euro). This field specifies the type of currency used in financial operation.","example":"EUR"},"max_value":{"type":"number","description":"Maximum value allowed for transactions","example":20.55},"min_value":{"type":"number","description":"Minimum value allowed for transactions","example":2.55},"unlimited_payments":{"type":"boolean","description":"Whether transactions are unlimited, max or min value will be refreshed on each payment","example":false},"created_at":{"type":"string","description":"Date when payment was created.","example":"2017-12-12 16:05:02"}}}},"components/schemas/frequent-with-transactions":{"id":"components/schemas/frequent-with-transactions","kind":"json-schema","title":"Frequent Payment with Transactions","data":{"title":"Frequent Payment with Transactions","description":"Frequent payment schema that includes transaction history","allOf":[{"$ref":"#/components/schemas/frequent","properties":{"transactions":{"type":"array","description":"Array of payment transactions associated with this frequent payment","items":{"type":"object","description":"Transaction details for a payment, including values and transfer information","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the transaction","example":"4fb3ac57-c7fe-4157-aeb7-4362ae24deec"},"key":{"type":"string","description":"Merchant identification key","example":"Merchant identification key"},"created_at":{"type":"string","format":"date-time","description":"When the transaction was created","example":"2025-05-30T17:21:46Z"},"date":{"type":"string","format":"date-time","description":"Transaction date","example":"2025-05-30T17:21:47Z"},"values":{"type":"object","description":"Transaction value breakdown","properties":{"requested":{"type":"number","format":"double","description":"Requested amount","example":12.55},"paid":{"type":"number","format":"double","description":"Amount actually paid","example":12.55},"fixed_fee":{"type":"number","format":"double","description":"Fixed fee charged","example":0.07},"variable_fee":{"type":"number","format":"double","description":"Variable fee charged","example":0.09},"tax":{"type":"number","format":"double","description":"Tax amount","example":0.04},"transfer":{"type":"number","format":"double","description":"Amount transferred to merchant","example":12.35}}},"transfer_date":{"type":"string","format":"date-time","description":"When the transfer occurred","example":"2025-06-02T00:00:00Z"},"transfer_batch":{"type":"string","description":"Transfer batch identifier"},"method":{"type":"string","description":"The payment method used to identify the payment in legacy.","example":"MBW","deprecated":true},"document_number":{"type":"string","description":"Document number for the transaction","example":"MARCEL0208220628294020250530172147"},"descriptive":{"type":"string","description":"Transaction description","example":"Descriptive Josefa"}}}}}}]}},"components/schemas/config-details":{"id":"components/schemas/config-details","kind":"json-schema","title":"config-details","data":{"type":"object","x-examples":{"Default Config":{"generic":"https://www.easypay.pt/generic","authorisation":"https://www.easypay.pt/authorisation","transaction":"https://www.easypay.pt/transaction","visa_fwd":"https://www.easypay.pt/visa_fwd","visa_detail":"https://www.easypay.pt/visa_detail","account":"b2080452-bad1-4455-8ae7-9f5ea552a274","client_id":"EASYP030002","payment_methods":["MB"]}},"properties":{"generic":{"type":"string","description":"URL for generic notification."},"authorisation":{"type":"string","description":"URL for authorisation notification."},"transaction":{"type":"string","description":"URL for transaction notification."},"visa_fwd":{"type":"string","description":"URL for redirect clients on credit card forward."},"visa_detail":{"type":"string","description":"URL for credit card payment detail."},"account":{"type":"string","format":"uuid","description":"The UUID of the related account.","example":"b2080452-bad1-4455-8ae7-9f5ea552a274"},"client_id":{"type":"string","description":"The id of the related client.","example":"EASYP030002"},"payment_methods":{"type":"array","description":"The available payments for the related account.","items":{"type":"string"}}}}},"components/schemas/metadata-cursor":{"id":"components/schemas/metadata-cursor","kind":"json-schema","title":"Metadata","data":{"title":"Metadata","type":"object","required":["next_cursor","count"],"description":"An object containing additional information about the response. It includes details that help manage and navigate the retrieved data.","properties":{"next_cursor":{"type":"string","example":"lL_j7ilk7rc","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides the cursor for the next set of records. This value should be used as the cursor parameter in subsequent requests to continue paginating through the data. If the cursor is an empty string or null, it indicates that there are no more results. To retrieve all available results, continue making subsequent requests until next_cursor is empty or null."},"children":[]}]}]}]},"count":{"type":"number","example":10,"description":"The total number of records in the current response. This field indicates the number of items returned in the current set of results."}}}},"components/schemas/capture-get-list-response":{"id":"components/schemas/capture-get-list-response","kind":"json-schema","title":"CaptureGetListResponse","data":{"title":"CaptureGetListResponse","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/metadata-cursor"},"data":{"type":"array","description":"The Capture object contains all the necessary information for executing a fund capture action. It defines how and where the funds should be routed upon capturing a transaction. This object is essential for finalizing transactions and ensuring the correct allocation of funds.","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the current status of the capture. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delayed: The capture attempt is scheduled for a future date and does not require further user interaction due to prior consent (e.g., authorization or frequent)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting: The payment instruction has been given, but the chosen payment method requires confirmation from an external entity before the status of the operation is finalized."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending: The capture is pending user completion."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"success: The capture has been completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed: The capture could not be completed due to an error or issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refunded: The capture has been refunded."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field provides a clear indication of the current state of the capture, helping users understand its progress and outcome."},"children":[]}]}]}],"enum":["delayed","waiting","success","pending","failed","refunded"]},"descriptive":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as \"Payment of Invoice Nº 1982652\" or \"Ticket for Queen\"."},"children":[]}]}]}]},"transaction_key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system."},"capture_date":{"type":"string","format":"date","description":"The date when the action should be executed. This field specifies the exact day for capturing the transaction, formatted as \"YYYY-MM-DD\" (e.g., \"2024-06-30\"). It is optional and defaults to the current date if not specified."},"account":{"type":"object","description":"An object within the capture request that specifies the details of the account to which the funds should be routed, different from the initially requested account. This ensures that the captured funds are directed to the correct destination as per the specific routing requirements.","properties":{"id":{"type":"string","format":"uuid","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."}}},"splits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"split_key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system."},"split_descriptive":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as \"Payment of Invoice Nº 1982652\" or \"Ticket for Queen\""},"children":[]}]}]}]},"account":{"type":"object","description":"The account to which the funds should be routed. This field is used to specify the destination account for the split payment, ensuring that the correct recipient receives their designated portion of the funds.","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced. "}}},"value":{"type":"number","format":"double","example":10.49,"description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places (e.g., \"100.00\"). The value must be greater than or equal to 0.5"},"clearing_date":{"type":"string","format":"date","description":"The clearing date refers to the specific date when a financial transaction is finalized and the funds are transferred from one account to another. This is the point at which the payment is officially completed and the amount is debited from the payer's account and credited to the payee's account."},"clearing_period":{"type":"string","description":"The clearing period must follow the format 1Y, 10W or 30D. Y for Years, W for weeks, D for days. Minimum is 7 days, maximum is 1 year."},"margin_account":{"type":"object","description":"The account to which the margin value should be routed. This field specifies the destination account for the margin portion of the funds, ensuring that the correct recipient receives the designated margin value. ","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced. ","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"}}},"margin_value":{"type":"number","description":"The monetary amount designated as the margin in a split payment. This field is formatted as a double, and will be rounded to two decimal places (e.g., \"10.00\"). The value must be less than the total value of the split. This specifies the portion of the funds that should be routed to the margin account. ","format":"double","example":12.6},"status":{"enum":["waiting","success","failed","reverted"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the Split. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waiting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while the split is queued for processing, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the funds have been routed, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if processing errored, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reverted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the split has been reverted after a refund or chargeback."},"children":[]}]}]}]},"reverts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced. ","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"value":{"type":"number","format":"double","description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places (e.g., \"100.00\"). The value must be greater than or equal to 0.5. "},"margin_value":{"type":"string","description":"The monetary amount designated as the margin in a split payment. This field is formatted as a double, and will be rounded to two decimal places (e.g., \"10.00\"). The value must be less than the total value of the split. This specifies the portion of the funds that should be routed to the margin account."}}}}}}},"payment_id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced. ","format":"uuid"},"payment_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of payment processed. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single: A one-time payment transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frequent: A payment that occurs regularly but is not part of a subscription (e.g., recurring manual payments)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription: A recurring payment that is part of a subscription plan, automatically processed at regular intervals. This field helps to categorize and manage different payment methods based on their frequency and nature."},"children":[]}]}]}]}],"enum":["single","frequent","subscription"]},"value":{"type":"number","format":"double","description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places (e.g., \"100.00\"). The value must be greater than or equal to 0.5. ","example":15.32},"force_3ds":{"type":"boolean","description":"A boolean field indicating whether to enforce 3D Secure (3DS) authentication for the transaction. If set to true, 3DS authentication will be required, adding an additional layer of security by verifying the cardholder's identity during the transaction process. If set to false, 3DS authentication will not be enforced. This field helps enhance security and reduce fraud in online payments. "},"created_at":{"type":"string","format":"date","description":"The timestamp indicating when the resource was created. It is formatted as \"YYYY-MM-DD HH:MM\". "},"updated_at":{"type":"string","format":"date","description":"The timestamp indicating when the resource was created. It is formatted as \"YYYY-MM-DD HH:MM\". "},"error":{"type":"object","description":"Represents the reason why an operation failed. It includes a human-readable message describing the issue, which can help diagnose and resolve the failure. ","properties":{"message":{"type":"string","description":"A human-readable description of the error. "}}}}}}}}},"components/schemas/capture-get-by-id-response":{"id":"components/schemas/capture-get-by-id-response","kind":"json-schema","title":"CaptureGetByIdResponse","data":{"title":"CaptureGetByIdResponse","type":"object","properties":{"transaction_key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system."},"capture_date":{"type":"string","example":"2025-07-10","description":"The date when the action should be executed. This field specifies the exact day for capturing the transaction, formatted as \"YYYY-MM-DD\" (e.g., \"2024-06-30\"). It is optional and defaults to the current date if not specified."},"account":{"type":"object","description":"An object within the capture request that specifies the details of the account to which the funds should be routed, different from the initially requested account. This ensures that the captured funds are directed to the correct destination as per the specific routing requirements.","properties":{"id":{"type":"string","format":"uuid","example":"c0151524-79e6-437a-a549-2ddd7c95e245","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."}}},"descriptive":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as \"Payment of Invoice Nº 1982652\" or \"Ticket for Queen\"."},"children":[]}]}]}]},"value":{"type":"number","format":"double","example":38.98,"description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places (e.g., \"100.00\"). The value must be greater than or equal to 0.5. "},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the current status of the capture. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delayed: The capture attempt is scheduled for a future date and does not require further user interaction due to prior consent (e.g., authorization or frequent)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting: The payment instruction has been given, but the chosen payment method requires confirmation from an external entity before the status of the operation is finalized."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending: The capture is pending user completion."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"success: The capture has been completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed: The capture could not be completed due to an error or issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refunded: The capture has been refunded."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field provides a clear indication of the current state of the capture, helping users understand its progress and outcome."},"children":[]}]}]}],"enum":["delayed","waiting","success","pending","failed","refunded"]},"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"payment_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of payment processed. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single: A one-time payment transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frequent: A payment that occurs regularly but is not part of a subscription (e.g., recurring manual payments)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription: A recurring payment that is part of a subscription plan, automatically processed at regular intervals. This field helps to categorize and manage different payment methods based on their frequency and nature."},"children":[]}]}]}]}],"enum":["single","frequent","subscription"]},"payment_id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced. "},"force_3ds":{"type":"boolean","description":"A boolean field indicating whether to enforce 3D Secure (3DS) authentication for the transaction. If set to true, 3DS authentication will be required, adding an additional layer of security by verifying the cardholder's identity during the transaction process. If set to false, 3DS authentication will not be enforced. This field helps enhance security and reduce fraud in online payments. "},"refunds":{"type":"array","description":"The refunds issued against this capture. Each Refund object contains information about a processed refund. For payment methods that do not support direct refunds, additional fields are present to facilitate a fallback to a bank transfer.","items":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","format":"uuid","example":"c0151524-79e6-437a-a549-2ddd7c95e245"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the current status of the refund. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting: The payment instruction has been given, but the chosen payment method requires confirmation from an external entity before the status of the operation is finalized."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending: This is the initial state, and it means that the refund is queued."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"success: The refund has been completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed: The refund could not be completed due to an error or issue. This field provides a clear indication of the current state of the refund, helping users understand its progress and outcome."},"children":[]}]}]}]}],"enum":["waiting","pending","success","failed"]},"transaction_key":{"type":"string","description":"Your internal key identifying this refund.","example":"example key"},"value":{"type":"number","format":"double","description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places (e.g., \"100.00\"). The value must be greater than or equal to 0.5."},"iban":{"type":"string","description":"(Required for fallback): The International Bank Account Number of the account to which the refund will be sent. This field is used to uniquely identify the recipient's bank account across international borders."},"email":{"type":"string","description":"(Required for fallback): The email address of the account holder. This field is used for communication purposes, including sending notifications about the refund stat."},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Required for fallback): The contact phone number of the account holder, including the country code indicator (e.g., \"+351\"). This field is used for communication purposes, such as contacting the account holder for verification."},"children":[]}]}]}]},"account_holder":{"type":"string","description":"Bank account holder name."}}}},"splits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","format":"uuid","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"split_key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system.","example":"Example Key"},"split_descriptive":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as \"Payment of Invoice Nº 1982652\" or \"Ticket for Queen\""},"children":[]}]}]}],"example":"Descriptive Example"},"account":{"type":"object","description":"The account to which the funds should be routed. This field is used to specify the destination account for the split payment, ensuring that the correct recipient receives their designated portion of the funds.","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced. "}}},"value":{"type":"number","format":"double","example":10.89,"description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places (e.g., \"100.00\"). The value must be greater than or equal to 0.5"},"clearing_date":{"type":"string","format":"date","description":"The clearing date refers to the specific date when a financial transaction is finalized and the funds are transferred from one account to another. This is the point at which the payment is officially completed and the amount is debited from the payer's account and credited to the payee's account."},"clearing_period":{"type":"string","description":"The clearing period must follow the format 1Y, 10W or 30D. Y for Years, W for weeks, D for days. Minimum is 7 days, maximum is 1 year."},"margin_account":{"type":"object","description":"The account to which the margin value should be routed. This field specifies the destination account for the margin portion of the funds, ensuring that the correct recipient receives the designated margin value. ","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced. "}}},"margin_value":{"type":"number","format":"double","description":"The monetary amount designated as the margin in a split payment. This field is formatted as a double, and will be rounded to two decimal places (e.g., \"10.00\"). The value must be less than the total value of the split. This specifies the portion of the funds that should be routed to the margin account. ","example":10},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the Split. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waiting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while the split is queued for processing, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the funds have been routed, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if processing errored, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reverted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the split has been reverted after a refund or chargeback."},"children":[]}]}]}],"enum":["waiting","success","failed","reverted"]},"reward":{"type":"object","description":"Reward credits generated from this split. The credits are associated with the customer provided at the top level of the payment request and can only be redeemed by that customer. Present only when the split carries a reward.","properties":{"account":{"type":"object","description":"The account to which the reward credits are routed.","properties":{"id":{"type":"string","format":"uuid","example":"c0151524-79e6-437a-a549-2ddd7c95e245","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."}}},"value":{"type":"number","format":"double","description":"The reward amount generated from this split.","example":1},"expiration_date":{"type":"string","format":"date","description":"The date until which the reward credits are valid. Present only when the reward has an expiration date.","example":"2027-04-02"}}},"reverts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced. ","format":"uuid"},"value":{"type":"number","format":"double","description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places (e.g., \"100.00\"). The value must be greater than or equal to 0.5. "},"margin_value":{"type":"number","description":"The monetary amount designated as the margin in a split payment. This field is formatted as a double, and will be rounded to two decimal places (e.g., \"10.00\"). The value must be less than the total value of the split. This specifies the portion of the funds that should be routed to the margin account.","format":"double"}}}}}}},"reward_redemption":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reward credits redeemed in this capture. Present only when the capture redeemed reward credits. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/guides/rewards-and-redemptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rewards & Redemptions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full flow."},"children":[]}]}]}],"properties":{"account":{"type":"object","description":"The reward account the credits were debited from.","properties":{"id":{"type":"string","format":"uuid","example":"c0151524-79e6-437a-a549-2ddd7c95e245","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."}}},"value":{"type":"number","format":"double","description":"The redeemed reward amount.","example":2.5}}},"error":{"type":"object","description":"Represents the reason why an operation failed. It includes a human-readable message describing the issue, which can help diagnose and resolve the failure. ","properties":{"message":{"type":"string","description":"Represents the reason why an operation failed. It includes a human-readable message describing the issue, which can help diagnose and resolve the failure. "}}}}}},"components/schemas/capture-post-request":{"id":"components/schemas/capture-post-request","kind":"json-schema","title":"CapturePostRequest","data":{"title":"CapturePostRequest","type":"object","properties":{"transaction_key":{"type":"string","description":"Your internal key identifying this capture","maxLength":50,"example":"key example"},"capture_date":{"type":"string","format":"date","example":"2022-11-11","description":"The date when the action should be executed. This field specifies the exact day for capturing the transaction, formatted as \"YYYY-MM-DD\" (e.g., \"2024-06-30\"). It is optional and defaults to the current date if not specified."},"account":{"type":"object","description":"For multi-account clients.","properties":{"id":{"type":"string","format":"uuid","description":"The uuid of the account."}}},"splits":{"type":"array","description":"Used in split payments.","items":{"$ref":"#/components/schemas/capture-split-create"}},"reward_redemption":{"$ref":"#/components/schemas/reward-redemption"},"force_3ds":{"type":"boolean","description":"Whether or not you want to force the 3DS authentication on Credit Cards (used only on Frequent capture without authorisation).","default":false},"descriptive":{"type":"string","description":"This will appear in the bank statement/MB WAY application.","maxLength":255,"example":"descriptive example"},"value":{"type":"number","minimum":0.5,"description":"Value will be rounded to 2 decimals.","example":20.55,"format":"double"}}}},"components/schemas/capture-post-response":{"id":"components/schemas/capture-post-response","kind":"json-schema","title":"CapturePostResponse","data":{"title":"CapturePostResponse","type":"object","properties":{"status":{"type":"string","example":"ok"},"message":{"type":"array","items":{"type":"string","example":"Your request was successfully created"}},"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","example":"677dbec9-ec19-4a78-9e08-3d2901c7a32b"}}}},"components/schemas/status-details":{"id":"components/schemas/status-details","kind":"json-schema","title":"status-details","data":{"type":"object","properties":{"status":{"type":"string","example":"ok"},"message":{"type":"array","items":{"type":"string","example":"Your request was successfully created"}}}}},"components/schemas/authorisation-get-by-id-response":{"id":"components/schemas/authorisation-get-by-id-response","kind":"json-schema","title":"AuthorisationGetDetailsResponse","data":{"title":"AuthorisationGetDetailsResponse","type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"status":{"type":"string","enum":["waiting","pending","failed","canceled","deleted","success"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the current status of the authorisation. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The payment instruction has been given, but the chosen payment method requires confirmation from an external entity before the status of the operation is finalized."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This is the initial state, and it means that the authorisation is queued."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"success:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The authorisation has been completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The authorisation could not be completed due to an error or issue."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field provides a clear indication of the current state of the authorisation, helping users understand its progress and outcome."},"children":[]}]}]}]}]},"message":{"type":"string","description":"A string human-readable message included in the response."},"key":{"type":"string","description":"This can be any string that helps the user uniquely identify or reference the resource in their own system."},"customer":{"$ref":"#/components/schemas/customer"},"method":{"type":"object","properties":{"type":{"type":"string","enum":["MB","CC","DD","MBW"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the payment method type used for the authorisation. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MB:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Multibanco"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CC:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Credit Card"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DD:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Direct Debit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MBW:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" MB WAY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field helps to identify the payment method chosen by the customer for the transaction."},"children":[]}]}]}]}]},"status":{"enum":["waiting","pending","active","failed","canceled","deleted"]},"url":{"type":"string","description":"The URL where the merchant should redirect the user to complete Credit Card Payments. This field is only applicable and available for credit card payment transactions.","example":"https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a","format":"uri"},"last_four":{"type":"string","description":"The last four digits of the credit card number used for the payment. This field is only applicable for credit card transactions.","example":"1354"},"card_type":{"enum":["VISA","Mastercard"],"description":"Indicates the type of credit card used for the payment (e.g., \"Visa\", \"MasterCard\"). This field is only applicable for credit card transactions."},"expiration_date":{"type":"string","format":"date-time","description":"The timestamp indicating when the resource will expire. It is formatted as \"YYYY-MM-DD HH:MM"}}},"currency":{"type":"string","description":"The currency code in ISO 4217 format (e.g., \"EUR\" for Euro). This field specifies the type of currency used in financial operation","example":"EUR"},"value":{"type":"number","description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places.","example":125.89,"format":"double"},"value_captured":{"type":"number","description":"The monetary amount requested for the capture transaction. This field is formatted as a double, and will be rounded to two decimal places.","format":"double","example":10.87},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/payment-transactions"}}}}},"components/schemas/checkout-get-details-response":{"id":"components/schemas/checkout-get-details-response","kind":"json-schema","title":"checkout-get-details-response","data":{"type":"object","x-examples":{"example-1":{"status":"success","message":["checkout is not finished yet"],"checkout":{"id":"ced0ff93-d64f-47fc-b29e-4e5481cb38ec","status":"pending"},"payment":{"id":"df9d691d-f7fe-4ce4-8205-323888a769f3","status":"success","methods":["MB","CC","MBW","VI","UF"],"expiration_time":"2022-12-12T16:05:00Z","currency":"EUR","key":"Example Key","max_value":20,"min_value":2,"frequency":"1W","max_captures":10,"start_time":"2022-12-05T12:05:00Z","failover":true,"capture_now":true,"retries":2},"value":17.5}},"properties":{"status":{"type":"string","enum":["failed","success"]},"message":{"type":"array","items":{"type":"string"}},"checkout":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","canceled","complete"]}}},"payment":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["waiting","pending","active","deleted"]},"methods":{"type":"array","items":{"type":"string","enum":["MB","CC","MBW","DD","VI","AP","GP","SW"]}},"type":{"enum":["single","frequent","subscription"]},"expiration_time":{"type":"string"},"currency":{"type":"string"},"key":{"type":"string"},"max_value":{"type":"integer"},"min_value":{"type":"integer"},"unlimited_payments":{"type":"boolean"},"frequency":{"type":"string"},"max_captures":{"type":"integer"},"start_time":{"type":"string"},"failover":{"type":"boolean"},"capture_now":{"type":"boolean"},"retries":{"type":"integer"},"notification":{"$ref":"#/components/schemas/notification"}}},"value":{"type":"number"}}}},"components/schemas/checkout-payment-types-request":{"id":"components/schemas/checkout-payment-types-request","kind":"json-schema","title":"CheckoutPaymentTypesRequest","data":{"title":"CheckoutPaymentTypesRequest","type":"string","enum":["single","frequent","subscription"]}},"components/schemas/checkout-payment-methods-request":{"id":"components/schemas/checkout-payment-methods-request","kind":"json-schema","title":"Checkout Payment Methods","data":{"title":"Checkout Payment Methods","type":"array","description":"All the payment methods available to create a checkout payment.","items":{"type":"string","enum":["MB","MBW","DD","CC","VI","AP","GP","SW"],"example":"MBW"}}},"components/schemas/checkout-capture-object-request":{"id":"components/schemas/checkout-capture-object-request","kind":"json-schema","title":"CheckoutCaptureObjectRequest","data":{"title":"CheckoutCaptureObjectRequest","type":"object","properties":{"transaction_key":{"type":"string","description":"The internal key used to identify this transaction in the merchant's database.","maxLength":50},"capture_date":{"type":"string","format":"date","example":"2026-05-15","description":"The date on which the capture is performed."},"account":{"type":"object","description":"This object is used for multi-account clients.","properties":{"id":{"type":"string","format":"uuid","description":"The uuid of the account."}}},"splits":{"$ref":"#/components/schemas/capture-split-create","description":"This object is only used in split payments."},"descriptive":{"type":"string","maxLength":255,"description":"Required if the payment method is 'MBW'."}}}},"components/schemas/checkout-payment-object-request":{"id":"components/schemas/checkout-payment-object-request","kind":"json-schema","title":"CheckoutPaymentObjectRequest","data":{"title":"CheckoutPaymentObjectRequest","type":"object","properties":{"methods":{"$ref":"#/components/schemas/checkout-payment-methods-request","description":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Method"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frequent Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription Payment"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CC (Credit Card)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DD (Direct Debit)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MBW (MB WAY)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MB (Multibanco)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VI (Virtual IBAN)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SW (Samsung Wallet)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AP (Apple Pay)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GP (Google Pay)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]}]}]}]}]}]},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of financial operation being performed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This property is used only for Single Payments."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TYPE"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESCRIPTION"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sale"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a complete transaction where funds are immediately captured."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorisation"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a temporary hold on funds pending a future capture."},"children":[]}]}]}]}]}]}],"example":"sale","enum":["sale","authorisation"]},"capture":{"$ref":"#/components/schemas/checkout-capture-object-request","description":"Required only if the payment type is sale."},"sdd_mandate":{"$ref":"#/components/schemas/sdd-mandate"},"expiration_time":{"type":"string","description":"The last possible time to make the payment. Applicable in Multibanco payments.\n\nNote: If the expiration time is less than the default checkout session expiration (which is 30 minutes),\nthe user won't be able to interact with the Checkout after that time.\n","format":"date","example":"2027-12-12 16:05"},"currency":{"type":"string","default":"EUR","description":"The currency code in ISO 4217 format (e.g., \"EUR\" for Euro). This field specifies the type of currency used in financial operation."},"key":{"type":"string","description":"The merchant's key for identifying the payment.","maxLength":50},"max_value":{"type":"number","format":"double","minimum":0.5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"#FF0000"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional property for frequent payments."},"children":[]}]}]}]}]},"min_value":{"type":"number","format":"double","minimum":0.5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"#FF0000"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional property for frequent payments."},"children":[]}]}]}]}]},"unlimited_payments":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"#FF0000"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional property for frequent payments."},"children":[]}]}]}]}]},"frequency":{"enum":["1D","1W","2W","1M","2M","3M","4M","6M","1Y","2Y","3Y"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"#FF0000"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional property for subscription payments."},"children":[]}]}]}]}]},"max_captures":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"#FF0000"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional property for subscription payments."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines a maximum number of captures, is required when no expiration_time is set."},"children":[]}]}]}]},"start_time":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"#FF0000"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional property for subscription payments."},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the start of the billing cycles."},"children":[]}]}]}]},"failover":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"#FF0000"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional property for subscription payments."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After all retries failed, the payment cycle can have another try with another single method."},"children":[]}]}]}]},"capture_now":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"#FF0000"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional property for subscription payments."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to schedule an immediate capture and schedule the second one for start_time."},"children":[]}]}]}]},"retries":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"#FF0000"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional property for subscription payments."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of retries in each payment cycle."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chosen frequency will define the max number of possible retries."},"children":[]}]}]}],"default":0},"multibanco":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object that holds the details specific to a Multibanco transaction. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This property is used only for Single Payments."},"children":[]}]}]}]}],"required":["expiration_time"],"properties":{"expiration_time":{"type":"string","description":"The end timestamp indicating the deadline by which the Multibanco Reference must be paid. It defines the final time within which the payment must be completed. The format follows RFC3339 (e.g., \"2024-06-30T21:38:31Z\")."},"start_time":{"type":"string","description":"The starting timestamp indicating when the Multibanco Reference becomes valid for payment. It defines the initial time from which the payment can be made. The format follows RFC3339 (e.g., \"2024-06-30T21:38:31Z\"). This field is optional and defaults to the current timestamp if not specified, or if the sent value is in the past."},"multibanco":{"type":"object","description":"An object that holds the details specific to a Multibanco transaction.","required":["expiration_time"],"properties":{"expiration_time":{"type":"string","format":"date-time","description":"The end timestamp indicating the deadline by which the Multibanco Reference must be paid. It defines the final time within which the payment must be completed. The format follows RFC3339 (e.g., \"2024-06-30T21:38:31Z\")."},"start_time":{"type":"string","format":"date-time","description":"The starting timestamp indicating when the Multibanco Reference becomes valid for payment. It defines the initial time from which the payment can be made. The format follows RFC3339 (e.g., \"2024-06-30T21:38:31Z\"). This field is optional and defaults to the current timestamp if not specified, or if the sent value is in the past."},"product":{"type":"string","enum":["FILE","SPG","CHECKDIGIT"],"default":"CHECKDIGIT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to select the desired product. Below, the supported features for each product are listed. The default value is CHECKDIGIT. Additional costs may apply depending on the selected product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Features:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Immediate Issuance"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start Date"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHECKDIGIT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✓"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✓"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✗"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPG"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✗"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✓"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✓"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✗"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✓"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descriptions:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHECKDIGIT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Standard Multibanco references with immediate issuance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPG"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Special purpose group references with scheduling capabilities"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": File-based references for batch processing"},"children":[]}]}]}]}]}}}}},"notification":{"$ref":"#/components/schemas/notification"}}}},"components/schemas/checkout-order-response":{"id":"components/schemas/checkout-order-response","kind":"json-schema","title":"CheckoutOrderResponse","data":{"title":"CheckoutOrderResponse","type":"object","required":["value"],"properties":{"items":{"type":"array","items":{"type":"object","required":["description","value"],"properties":{"description":{"type":"string","maxLength":100,"description":"Brief description of the item.","example":"Description Example"},"quantity":{"type":"number","example":2,"description":"Quantity of this item being paid."},"key":{"type":"string","maxLength":50,"description":"The merchant's key to identify the item","example":"Key Example"},"value":{"type":"number","format":"double","example":10.55,"minimum":0.5,"description":"The price being paid for the specific item(s), rounded to 2 decimals."}}}},"key":{"type":"string","description":"The merchant's key to identify the order.","maxLength":50,"example":"Example Key"},"value":{"type":"number","format":"double","example":50.78,"description":"The price being paid for the entire order, rounded to 2 decimals","minimum":0.5}}}},"components/schemas/checkout-customer-request":{"id":"components/schemas/checkout-customer-request","kind":"json-schema","title":"Customer","data":{"title":"Customer","type":"object","description":"The Customer object contains detailed information about the customer required to create a Checkout payment.","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."},"name":{"type":"string","example":"Jonh Doe","description":"The full name of the customer. This field is used to identify the customer and personalize interactions. It typically includes the customer's first name and last name.","maxLength":255},"email":{"type":"string","format":"email","example":"example@easypay.pt","maxLength":70,"description":"The email address of the customer. This field is used for communication purposes, including sending transaction confirmations, receipts, and other notifications related to the customer's activities."},"phone":{"type":"string","example":"911234567","description":"The contact phone number of the customer has the E.164 pattern. This number will be used to make the payment if the method is MB WAY.","maxLength":15},"phone_indicative":{"type":"string","maxLength":5,"description":"The phone country code.","example":"+351"},"language":{"type":"string","description":"The language preference of the customer, specified in the ISO 639-1 Alpha-2 format (e.g., \"EN\" for English, \"PT\" for Portuguese). This field is used to indicate the customer's preferred language for communication and documentation.","minLength":2,"maxLength":2,"example":"EN"},"fiscal_number":{"type":"string","maxLength":20,"description":"The customer's fiscal number (prefixed by the country code).","example":"PT268826145"},"key":{"type":"string","maxLength":255,"description":"The merchant's key to identify the customer.","example":"Key Example"}}}},"components/schemas/checkout-request":{"id":"components/schemas/checkout-request","kind":"json-schema","title":"checkout-request","data":{"type":"object","x-examples":{"example-1":{"type":["single","frequent","subscription"],"payment":{"methods":["MB","CC","MBW","VI","UF","SC","DD","AP"],"type":"sale","capture":{"transaction_key":"string","capture_date":"string","account":{"id":"22ea3cc9-424b-489a-91b7-8955f643dc93"},"splits":[{"split_key":"string","split_descriptive":"Descriptive Example","value":1,"account":{"id":"22ea3cc9-424b-489a-91b7-8955f643dc93"},"margin_value":0.1,"margin_account":{"id":"22ea3cc9-424b-489a-91b7-8955f643dc93"}}],"descriptive":"Descriptive Example"},"expiration_time":"2017-12-12 16:05","currency":"EUR","key":"Example Key","max_value":20,"min_value":2,"unlimited_payments":false,"frequency":"1D","max_captures":10,"start_time":"2017-12-12 16:05","failover":true,"capture_now":true,"retries":2,"notification":{"customer_method_instructions_email":true}},"order":{"items":[{"description":"Item in Shopping Cart","quantity":2,"key":"Example Key","value":17.5}],"key":"Example Key","value":17.5},"customer":{"id":"22ea3cc9-424b-489a-91b7-8955f643dc93","name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","fiscal_number":"PT123456789","key":"Key Example"}}},"required":["type","payment"],"properties":{"type":{"type":"array","items":{"$ref":"#/components/schemas/checkout-payment-types-request"},"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the first value in the Array is considered (e.g. ['single', 'frequent'] would be equivalent to ['single'])."},"children":[]}]}]}]},"payment":{"$ref":"#/components/schemas/checkout-payment-object-request","description":"Describing the payment configuration."},"order":{"$ref":"#/components/schemas/checkout-order-response","description":"Order represent the order/cart being paid. Order is required if type is one single or subscription."},"customer":{"$ref":"#/components/schemas/checkout-customer-request","description":"The customer details."}}}},"components/schemas/checkout-post-response":{"id":"components/schemas/checkout-post-response","kind":"json-schema","title":"CheckoutPostResponse","data":{"title":"CheckoutPostResponse","type":"object","description":"The response body when the checkout is created successfully.","properties":{"id":{"type":"string","description":"UUID of the checkout.","format":"uuid","example":"5db36b83-0664-4bc4-a760-7040ac3726f0"},"session":{"type":"string","description":"Session token to be used by the rest of the Checkout process.","example":"PX2duB7zMRISp6WrKdkOHLcvhIj-7-yUXMYHDQf5k7L5b5mA3D_m5TCdsYT-mCOaALGw4k95I_gjYQS-tcsxAAjTqU4G0UM5sd2o5wdGTGOOuoZVv0CwmiBwhUY9j4Dq4MDryEEPXtqMHEYi7PJz7dakeBemaWFg9GCEvdE6BM_uDBjZLBIS--_uFjRWpKm5enhwTkGvF3iTXuNrsRAxrW8YTsPUGJZumz2s-xSwa6XVaqRqO9uTvuHWy9TrEs1eCTeiWpqwZaj8_aNry5Tc44Epvvw4-4yebDaMQ1gJIHyJDzkLQ9mv4lNPjOFFtJPHihzgIybJdxzE1f6oBnjudMJa0LHsyzkHt29_j4FNRwSyU0Sti2vtW9SEAJ9D8pqrhvMg7zDQkvYLxjNJrME8EVqlGA_il0hc75wigX3hRdoVokF7u0-0ac0HYltG2zYEgE2lxqzPaG_lSbidSBAIoFWhY5rij3TyQHg6lPhHF6jYhn0ytvsBRauIdlZnJau18KzcOH4fcwN8d59SuhffuSyD_Mtd7trlzz6lWM9AeoY="},"config":{"nullable":true}}}},"components/schemas/subscription-method-response-on-list":{"id":"components/schemas/subscription-method-response-on-list","kind":"json-schema","title":"SubscriptionMethodResponseOnList","data":{"title":"SubscriptionMethodResponseOnList","type":"object","properties":{"type":{"enum":["CC","DD"]},"status":{"enum":["active","inactive","waiting"]},"url":{"type":"string","format":"uri","example":"https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a"},"sdd_mandate":{"$ref":"#/components/schemas/sdd-mandate-response-on-list"}}}},"components/schemas/subscription-response-on-list":{"id":"components/schemas/subscription-response-on-list","kind":"json-schema","title":"subscription-response-on-list","data":{"type":"object","description":"Subscription object that returns after a success request.","properties":{"id":{"type":"string","format":"uuid","example":"458b2fc4-3092-4de3-abd4-fe1600c09420"},"key":{"type":"string","example":"payment 02536985"},"expiration_time":{"type":"string","format":"date-time","example":"2099-01-15 00:00"},"start_time":{"type":"string","example":"2027-01-15 00:00","format":"date-time"},"frequency":{"enum":["1D","1W","2W","1M","2M","3M","4M","6M","1Y","2Y","3Y"]},"retries":{"type":"integer","example":2},"max_captures":{"type":"integer","example":12},"failover":{"type":"boolean","default":false},"capture_now":{"type":"boolean"},"unlimited_payments":{"type":"boolean"},"customer":{"$ref":"#/components/schemas/customer-response-on-list"},"method":{"$ref":"#/components/schemas/subscription-method-response-on-list"},"currency":{"type":"string","description":"The currency code in ISO 4217 format (e.g., \"EUR\" for Euro). This field specifies the type of currency used in financial operation."},"value":{"type":"number","format":"double","example":10.55},"created_at":{"type":"string","format":"date-time","example":"2025-08-05 13:44:29"}}}},"components/schemas/frequency":{"id":"components/schemas/frequency","kind":"json-schema","title":"Frequency","data":{"title":"Frequency","x-stoplight":{"id":"yvzrcsvdf10ek"},"type":"string","enum":["1D","1W","2W","1M","2M","3M","4M","6M","1Y","2Y","3Y"],"description":"Defining the frequency that the cycles are charged."}},"components/schemas/customer-response-on-detail":{"id":"components/schemas/customer-response-on-detail","kind":"json-schema","title":"customer-response-on-detail","data":{"type":"object","x-stoplight":{"id":"ro8t50k4mow57"},"description":"The Customer object contains detailed information about the customer involved in the transaction.","properties":{"id":{"type":"string","format":"uuid","example":"1b4ca1cf-9a1a-415b-97bf-342c6ddcf9c1"},"name":{"type":"string","example":"Joey Price"},"email":{"type":"string","format":"email","example":"john.doe@yahoo.com"},"phone":{"type":"string","example":"911234567"},"phone_indicative":{"type":"string","example":"+351"},"fiscal_number":{"type":"string","example":"PT921839198892623010"},"key":{"type":"string","example":"subscription 01234589"},"language":{"type":"string","example":"PT"}}}},"components/schemas/subscription-method-response-on-detail":{"id":"components/schemas/subscription-method-response-on-detail","kind":"json-schema","title":"SubscriptionMethodResponseOnDetail","data":{"title":"SubscriptionMethodResponseOnDetail","type":"object","properties":{"type":{"enum":["CC","DD"]},"status":{"enum":["active","inactive","waiting"]},"url":{"type":"string","format":"uri","example":"https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a"},"last_four":{"type":"string","example":"2222"},"card_type":{"type":"string","example":"VISA"},"expiration_date":{"type":"string","example":"07/29"},"sdd_mandate":{"$ref":"#/components/schemas/sdd-mandate-response-on-detail"}}}},"components/schemas/subscription-response-on-detail":{"id":"components/schemas/subscription-response-on-detail","kind":"json-schema","title":"subscription-response-on-detail","data":{"type":"object","description":"Subscription object that returns after a success request.","properties":{"id":{"type":"string","format":"uuid","example":"458b2fc4-3092-4de3-abd4-fe1600c09420"},"status":{"type":"string","example":"ok"},"key":{"type":"string","example":"payment 02536985"},"expiration_time":{"type":"string","format":"date-time","example":"2099-01-15 00:00"},"start_time":{"type":"string","example":"2027-01-15 00:00","format":"date-time"},"frequency":{"enum":["1D","1W","2W","1M","2M","3M","4M","6M","1Y","2Y","3Y"]},"retries":{"type":"integer","example":2},"max_captures":{"type":"integer","example":12},"failover":{"type":"boolean","default":false},"capture_now":{"type":"boolean"},"unlimited_payments":{"type":"boolean"},"customer":{"$ref":"#/components/schemas/customer-response-on-detail"},"method":{"$ref":"#/components/schemas/subscription-method-response-on-detail"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/payment-transactions"}},"currency":{"$ref":"#/components/schemas/currency"},"value":{"type":"number","format":"double","example":10.55},"created_at":{"type":"string","format":"date-time","example":"2025-08-05 13:44:29"}}}},"components/schemas/cycle":{"id":"components/schemas/cycle","kind":"json-schema","title":"Cycle","data":{"title":"Cycle","type":"object","required":["id","type","status","value","capture_at"],"properties":{"id":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":"The cycle's unique identifier."},"type":{"type":"string","enum":["RENEWABLE","ONE_TIME_CHARGE","CAPTURE_NOW"],"example":"RENEWABLE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the cycle was created:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RENEWABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — part of the recurring schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONE_TIME_CHARGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — an ad-hoc capture added on top of the schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CAPTURE_NOW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — an immediate one-off capture."},"children":[]}]}]}]}]},"status":{"type":"string","enum":["PENDING","PROCESSING","WAITING","SUCCESS","FAILED","RETRY","FAILOVER","DELETED"],"example":"PENDING","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current state of the cycle:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — queued, waiting for its scheduled time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — capture is being executed right now."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — waiting on an external dependency (e.g. customer action)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — captured successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — capture failed and will not be retried."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — capture failed but is queued for another attempt."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILOVER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — switched to the failover method after the primary failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — cancelled before being captured."},"children":[]}]}]}]}]},"value":{"type":"number","format":"double","minimum":0,"example":10.5,"description":"The amount captured, in euros."},"capture_at":{"type":"string","format":"date-time","example":"2026-05-22T09:00:00Z","description":"When the capture is scheduled to run, in UTC (RFC 3339)."},"description":{"type":"string","maxLength":255,"example":"monthly charge","description":"Free-form text shown on the bank statement or in the MB WAY app. Omitted when not set."},"key":{"type":"string","maxLength":50,"example":"my-key","description":"Your internal identifier for the cycle. Omitted when not set."}}}},"components/schemas/one-time-charge-response-on-post":{"id":"components/schemas/one-time-charge-response-on-post","kind":"json-schema","title":"OneTimeChargeResponseOnPost","data":{"title":"OneTimeChargeResponseOnPost","type":"object","properties":{"status":{"type":"string","example":"ok"},"message":{"type":"array","items":{"type":"string"},"example":["Your request was successfully created"]},"id":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":"The UUID of the newly created cycle."}},"required":["status","message","id"]}},"components/schemas/update-cycle-response-on-patch":{"id":"components/schemas/update-cycle-response-on-patch","kind":"json-schema","title":"UpdateCycleResponseOnPatch","data":{"title":"UpdateCycleResponseOnPatch","type":"object","properties":{"status":{"type":"string","example":"ok"},"message":{"type":"array","items":{"type":"string"},"example":["Your request was successfully updated"]},"id":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The UUID of the updated cycle (same as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cycle_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter)."},"children":[]}]}]}]}},"required":["status","message","id"]}},"components/schemas/void-get-by-id-response":{"id":"components/schemas/void-get-by-id-response","kind":"json-schema","title":"VoidGetDetailsResponse","data":{"title":"VoidGetDetailsResponse","type":"object","properties":{"status":{"enum":["pending","processing","success","failed"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the current status of the void:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Initial state — the void has been created and queued."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The void is being processed by the acquirer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The void completed successfully (the authorisation was released)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The void could not be completed due to an error or issue."},"children":[]}]}]}]}]},"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."},"transaction_key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system."},"descriptive":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as \"Payment of Invoice Nº 1982652\" or \"Ticket for Queen\"."},"children":[]}]}]}]},"authorisation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."},"status":{"enum":["waiting","pending","failed","canceled","deleted","success"],"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The authorisation instruction has been given, but the chosen payment method requires confirmation from an external entity before the status of the operation is finalized."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is the initial state, and it means that the authorisation is queued."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The authorisation could not be completed due to an error or issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"canceled"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The authorisation has been canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The authorisation has been deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"success"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The authorisation has been created successfully."},"children":[]}]}]}]}]},"key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system."},"customer":{"$ref":"#/components/schemas/customer"},"method":{"type":"object","properties":{"type":{"enum":["CC","MBW","AP","GP","SW"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of payment method being used for the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TYPE"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESCRIPTION"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MBW"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multibanco"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Pay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Pay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SW"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Samsung Wallet"},"children":[]}]}]}]}]}]}]},"status":{"enum":["active","inactive"]}}},"currency":{"type":"string","enum":["EUR"]},"value":{"type":"number","format":"double","description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places.","example":15.78}}}}}},"components/schemas/void-post-request":{"id":"components/schemas/void-post-request","kind":"json-schema","title":"VoidPostRequest","data":{"title":"VoidPostRequest","type":"object","required":["descriptive"],"properties":{"descriptive":{"type":"string","description":"Free-text reason for the void. Required, up to 255 characters. This will appear in the bank statement / MB WAY application.\n","maxLength":255,"example":"Cancelling the duplicated authorisation"},"transaction_key":{"type":"string","description":"Optional. Your own internal key identifying this void, up to 50 characters. Echoed back on the void details.\n","maxLength":50,"example":"order-1982652-void"}},"example":{"descriptive":"Cancelling the duplicated authorisation","transaction_key":"order-1982652-void"}}},"components/schemas/void-post-response":{"id":"components/schemas/void-post-response","kind":"json-schema","title":"PostVoidResponse","data":{"title":"PostVoidResponse","type":"object","properties":{"status":{"type":"string","example":"ok"},"message":{"type":"array","description":"An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.","items":{"type":"string","example":"Your request was successfully created"}},"id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","example":"8010e7d5-9985-4ae3-b1bf-6b70019439c7"}}}},"components/schemas/money":{"id":"components/schemas/money","kind":"json-schema","title":"Money","data":{"title":"Money","type":"object","description":"The money type is a data structure used to represent a monetary value in a specific currency. It includes both the amount and the currency type to accurately define the value of money in various contexts, such as financial transactions, pricing, and accounting.","properties":{"amount":{"type":"string","description":"Represents the numerical value of the money. The amount should be a string formatted to include up to two decimal places to accurately represent cents or subunits of currency. For example, \"123.45\" represents one hundred twenty-three units and forty-five subunits of the currency."},"currency":{"type":"string","description":"Indicates the type of currency associated with the amount. This should follow standard currency codes (ISO 4217), such as \"USD\" for US Dollar, \"EUR\" for Euro, or \"JPY\" for Japanese Yen, to specify which currency the amount is denominated in."}},"examples":[{"amount":0.12,"currency":"EUR"}]}},"components/schemas/transaction-fee":{"id":"components/schemas/transaction-fee","kind":"json-schema","title":"Fee","data":{"title":"Fee","type":"object","properties":{"fixed_amount":{"$ref":"#/components/schemas/money"},"variable_amount":{"$ref":"#/components/schemas/money"},"vat_amount":{"$ref":"#/components/schemas/money"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object that represents a set of amounts in different categories such as fixed, variable, and VAT, each with an associated currency. The structure includes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fixed_amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Represents a fixed fee applied to the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variable_amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Represents a variable fee, usually dependent on the transaction amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vat_amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Represents the value-added tax (VAT) applied to the fees."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All amounts are represented in a specific currency."},"children":[]}]}]}]}]}},"components/schemas/financial-transaction-details":{"id":"components/schemas/financial-transaction-details","kind":"json-schema","title":"FinancialTransactionDetails","data":{"title":"FinancialTransactionDetails","type":"object","description":"An object containing detailed financial information related to the transaction. Provides a breakdown of various components of the transaction, such as fees , requested and payed amounts.","properties":{"requested_amount":{"$ref":"#/components/schemas/money"},"payed_amount":{"$ref":"#/components/schemas/money"},"fees":{"type":"array","items":{"$ref":"#/components/schemas/transaction-fee"},"description":"An array of fee objects, where each fee represents a specific charge or cost associated with a transaction. Each fee includes details such as the amount and currency, and may represent different types of fees like fixed, variable, or VAT."}}}},"components/schemas/ledger-entry-details":{"id":"components/schemas/ledger-entry-details","kind":"json-schema","title":"ledger-entry-details","data":{"type":"object","x-examples":{"Example 1":{"operation_id":"7bca9e29-21a3-4e23-a1f5-50bb605e2360","operation_key":"Merchant identification key","method":"CC","payment_id":"502b0844-13a8-4788-b775-5e4cc8194a50","payment_type":"single","payment_key":"Merchant identification key"}},"description":"An object containing detailed information about a specific operation and payment. This includes unique identifiers, the method used for the payment, and the type of payment.","properties":{"operation_id":{"type":"string","example":"502b0844-13a8-4788-b775-5e4cc8194a50","description":"A unique identifier for the operation, represented as a UUID."},"operation_key":{"type":"string","description":"A merchant-specific identification key for the operation."},"method":{"type":"string","description":"The payment method used for the transaction (e.g., CC for credit card).","example":"CC"},"payment_id":{"type":"string","description":"A unique identifier for the payment, represented as a UUID.","example":"235934c2-467d-44fa-9e81-9cbd9d1a6f61"},"payment_type":{"type":"string","description":"The type of payment, such as 'single' for a one-time payment.","example":"single"},"payment_key":{"type":"string","description":" A merchant-specific identification key for the payment."}}}},"components/schemas/ledger-entry":{"id":"components/schemas/ledger-entry","kind":"json-schema","title":"LedgerEntry","data":{"title":"LedgerEntry","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LedgerEntry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object represents a single entry in the financial ledger of Easypay reconciliation system. It captures detailed information about a specific financial transaction, including its type, category, and associated monetary details. This object serves as a comprehensive record of all activities impacting an account's balance, providing an audit trail for both debits and credits."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LedgerEntry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes metadata such as unique identifiers and timestamps to track when the entry was created and when the transaction occurred. It also encompasses financial breakdowns like fees, taxes, and transferred amounts, all contextualized with currency information. Additionally, the object can link to specific operations or payment methods, detailing the source and nature of each transaction."},"children":[]}]}]}],"examples":[{"id":"38c65c65-6b66-42e8-b3db-3a3361ef23e4","created_at":"2024-10-02 09:39","transaction_timestamp":"2024-10-02 09:39","transaction_type":"CP","amount_details":{"requested_amount":{"amount":8,"currency":"EUR"},"payed_amount":{"amount":8,"currency":"EUR"},"fees":[{"fixed_amount":{"amount":0.25,"currency":"EUR"},"variable_amount":{"amount":0.28,"currency":"EUR"},"vat_amount":{"amount":0.12,"currency":"EUR"}}]},"transfer_batch_date":"2024-10-11","transfer_batch":"781","descriptive":"Descriptive Josefa","details":{"operation_id":"7bca9e29-21a3-4e23-a1f5-50bb605e2360","operation_key":"Merchant identification key","method":"CC","payment_id":"502b0844-13a8-4788-b775-5e4cc8194a50","payment_type":"single","payment_key":"Merchant identification key"},"amount":{"amount":7.35,"currency":"EUR"}}],"properties":{"id":{"type":"string","example":"\"38c65c65-6b66-42e8-b3db-3a3361ef23e4\"","description":"A unique identifier for the ledger entry, represented as a UUID. This ID is used to uniquely track and reference individual entries within the ledger system."},"created_at":{"type":"string","format":"date-time","description":"The timestamp indicating when the resource was created. It is formatted as ISO 8601.","example":"2019-08-24T14:15:22Z"},"transaction_timestamp":{"type":"string","description":"The exact timestamp of when the associated transaction occurred. It is formatted as \"YYYY-MM-DD HH:MM\".","examples":["2024-09-23 11:03"]},"transaction_type":{"type":"string","enum":["CP","RF","RV","FEE","SP","MAN","TB","OT","CB","OP","TF","RW","RR","RX"],"example":"CP","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LedgerTransactionType"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a string enum that represents various types of financial transactions recorded in a ledger. Each transaction type is abbreviated with a code and corresponds to a specific financial operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following are the possible values and their descriptions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Capture): Represents the capture of funds, typically after a payment authorization. This transaction finalizes a payment and moves the funds from the payer's account to the payee's account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Refund): Represents a refund transaction where previously captured funds are returned to the payer's account. This transaction often occurs when a customer returns goods or services."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RV"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Revert): Indicates a revert transaction that undoes a previously made transaction, often used to correct errors or reverse transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Split Payment): Represents a split payment transaction, where a payment is divided among multiple recipients or for different purposes within the same transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Fee): Represents a fee transaction, which is a charge applied for a specific service or transaction. This could include service fees, processing fees, or other types of charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Manual Movement): Represents a manual movement of funds, typically entered manually by an administrator or accountant to adjust balances or correct errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TB"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Bank Transfer): Represents a bank transfer transaction, where funds are moved between different bank accounts. This can be a transfer within the same bank or across different banks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Out Transfer): Indicates an out transfer transaction, where funds are transferred out of the current ledger or account to another external account or ledger."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CB"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Chargeback): Represents a chargeback transaction, typically initiated by the payer's bank to reverse a disputed or fraudulent transaction. This transaction withdraws the funds from the payee's account and returns them to the payer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Out Payment): Represents an out payment transaction, where funds are paid out from the ledger to an external party or account. This transaction is usually used to settle debts or make external payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Transfer Funds): Represents a movement of funds from an Easypay account to a bank account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RW"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Reward): Represents a reward earned by a customer, funded from the account balance. The entry links to the capture that earned the reward through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RR"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Reward Redemption): Represents reward credits a customer redeemed against a purchase. The entry links to the capture the credits were redeemed on through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RX"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Reward Expiry): Represents the payout of a customer's unused reward credits when they expire. These entries are not linked to any operation, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not populated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/guides/rewards-and-redemptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rewards & Redemptions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for how reward movements work."},"children":[]}]}]}]},"amount_details":{"$ref":"#/components/schemas/financial-transaction-details"},"transfer_batch_date":{"type":"string","examples":["2024-10-11"],"description":"The date when the transfer batch is scheduled or processed. The date is represented in ISO 8601 format (YYYY-MM-DD), indicating the year, month, and day."},"transfer_batch":{"type":"string","example":"\"584\"","description":"A unique identifier for the transfer batch, typically represented as a string. This value is used to track and reference a specific batch of transfers within the system."},"descriptive":{"type":"string","description":"A brief, user-friendly description of the ledger entry. This is used to provide additional context or notes that describe the nature of the transaction in plain language."},"details":{"$ref":"#/components/schemas/ledger-entry-details"},"amount":{"$ref":"#/components/schemas/money"}}}},"components/schemas/metadata-page":{"id":"components/schemas/metadata-page","kind":"json-schema","title":"metadata-page","data":{"type":"object","x-examples":{"example-1":{"page":{"current":1,"total":8},"records":{"total":20,"per_page":20},"links":{"first":"?page=1","prev":"","next":"?page=2","last":"?page=8"}}},"description":"The Pagination object contains detailed information about the pagination of a collection of records.\n\nThis object is used to provide navigation and context for paginated results, allowing users to easily move between pages and understand the scope of the dataset.","properties":{"page":{"type":"object","required":["current","total"],"description":"An object containing information about the pagination of pages within the collection.","properties":{"current":{"type":"integer","description":"The current page number being viewed."},"total":{"type":"integer","description":"The total number of pages available in the collection."}}},"records":{"type":"object","description":"An object containing information about the records within the collection.","required":["total","per_page"],"properties":{"total":{"type":"integer","description":"The total number of records available in the collection."},"per_page":{"type":"integer","description":"The number of records displayed per page."}}},"links":{"type":"object","description":"An object containing URLs for navigation between different pages of the collection.","properties":{"first":{"type":"string","description":"The URL to the first page of the collection."},"prev":{"type":"string","description":"The URL to the previous page of the collection. This field is an empty string if there is no previous page."},"next":{"type":"string","description":"The URL to the next page of the collection. This field is an empty string if there is no next page."},"last":{"type":"string","description":"The URL to the last page of the collection."}}}},"required":["page","records"]}},"components/schemas/transaction-report-data":{"id":"components/schemas/transaction-report-data","kind":"json-schema","title":"transaction-report-data","data":{"type":"object","x-examples":{"example-1":{"id":"b41921f1-a255-41bc-9e92-9a28d266d378","key":"Merchant identification key","date":"2022-11-16T16:45:19Z","values":{"requested":44,"paid":44,"fixed_fee":0.25,"variable_fee":0.66,"tax":1.5,"transfer":42.88},"transfer_date":"2022-11-21T00:00:00Z","transfer_batch":"","method":"DD","document_number":"MARCEL0208220452011220221116164519","payment_type":"single","payment_id":"2a9112fe-6510-4366-b55e-24a3ae188d67","payment_account":{"id":"76f190b9-2b8a-4bd0-9490-411241a9dc81"},"payment_key":"Merchant identification key","payment_transaction_key":"Merchant identification key","descriptive":"Descriptive Josefa"}},"properties":{"id":{"type":"string","format":"uuid"},"key":{"type":"string","description":"Any value that will help the merchant manage the transaction on his database."},"date":{"type":"string","format":"date-time","description":"The date on which the provider reported the payment as having occurred."},"values":{"type":"object","properties":{"requested":{"type":"integer"},"paid":{"type":"integer"},"fixed_fee":{"type":"number"},"variable_fee":{"type":"number"},"tax":{"type":"number"},"transfer":{"type":"number"}}},"transfer_date":{"type":"string","format":"date"},"transfer_batch":{"type":"string","description":"The batch where this transaction has transfered."},"method":{"type":"string","description":"The payment method."},"document_number":{"type":"string","description":"Unique document number used for Easypay Invoice."},"payment_type":{"type":"string","enum":["single","frequent","subscription"],"example":"single"},"payment_id":{"type":"string","format":"uuid"},"payment_account":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}},"payment_key":{"type":"string"},"payment_transaction_key":{"type":"string","description":"Capture transaction key."},"descriptive":{"type":"string","description":"Any descriptive information that will help the merchant manage the transaction on his database."},"created_at":{"type":"string","format":"date-time","description":"The timestamp indicating when the payment record was added to the system."}}}},"components/schemas/settlement":{"id":"components/schemas/settlement","kind":"json-schema","title":"Settlement","data":{"title":"Settlement","type":"object","required":["id","created_at","updated_at","name","description","status","total_amount","number_of_items","destination"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the settlement.","example":"f6a7b8c9-d0e1-2345-fabc-456789012306"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the settlement was created. Always present.","example":"2026-02-05T09:30:00Z"},"updated_at":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp when the settlement was last updated, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it has never been updated."},"children":[]}]}]}],"example":"2025-10-01T00:00:00Z"},"name":{"type":"string","description":"Human-readable name of the settlement (its batch reference).","example":"1006"},"description":{"type":"string","description":"Human-readable description of the settlement.","example":"EASYPAY-1977225-42185-161-998590696"},"status":{"type":"string","enum":["IN_TRANSIT","SUCCEEDED","FAILED"],"description":"Current status of the settlement.","example":"IN_TRANSIT"},"total_amount":{"$ref":"#/components/schemas/money","description":"Total amount of the settlement"},"number_of_items":{"type":"integer","description":"Number of transactions included in the settlement.","example":2},"destination":{"type":"object","description":"Where the settled funds are sent.","required":["type"],"properties":{"type":{"type":"string","enum":["IBAN"],"description":"Type of destination.","example":"IBAN"},"details":{"type":"object","description":"Details specific to the destination type.","properties":{"iban":{"type":"string","description":"Destination IBAN. Omitted when empty.","example":"PT50007974951304464003280"}}}}}}}},"components/schemas/out-payment-transactions":{"id":"components/schemas/out-payment-transactions","kind":"json-schema","title":"out-payment-transactions","data":{"type":"object","description":"An array of transactions, where each one represents a specific charge or cost associated with a transaction. Includes details such as the amount and transfer, and its related fees.","properties":{"id":{"type":"string","description":"A unique identifier for the entry, represented as a UUID. This ID is used to uniquely track and reference individual entries within the ledger system.","example":"4fb3ac57-c7fe-4157-aeb7-4362ae24deec","format":"uuid"},"key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system.","example":"01J1PKR2RPHJNJQGFWGDYXY0KM"},"created_at":{"type":"string","description":"The timestamp indicating when the resource was created. It is formatted as ISO 8601.","format":"date-time","example":"2025-05-30T17:21:47Z"},"date":{"type":"string","description":"The timestamp indicating when the resource was updated. It is formatted as ISO 8601.","example":"2025-05-30T17:21:46Z","format":"date-time"},"values":{"type":"object","properties":{"requested":{"type":"number","description":"The amount requested, rounded by two decimapl plates.","format":"double","example":12.55},"paid":{"type":"number","format":"double","example":12.55,"description":"The amount paid, rounded by two decimal plates."},"fixed_fee":{"type":"number","description":"The fixed fee amount applied to this transaction.","format":"double","example":0.07},"variable_fee":{"type":"number","description":"The variable fee amount applied to this transaction.","example":0.09},"tax":{"type":"number","description":"The vat amount applied to this transaction.","format":"double","example":0.04},"transfer":{"type":"number","format":"double","example":12.35,"description":"The net value to be transferred."}}},"transfer_date":{"type":"string","format":"date-time","example":"2025-06-02T00:00:00Z","description":"The estimation when the funds will be transfered. It is formatted as ISO 8601."},"transfer_batch":{"type":"string","description":"A unique identifier for the transfer batch, typically represented as a string. This value is used to track and reference a specific batch of transfers within the system.","example":"584"},"method":{"type":"string","description":"Method used for the transaction.","example":"transfer"},"document_number":{"type":"string","example":"MARCEL0208220628294020250530172147","description":"Unique document number used for Easypay Invoice."},"descriptive":{"type":"string","example":"blue t-shirts","description":"This is used to provide additional context or notes that describe the nature of the transaction in plain language."}}}},"components/schemas/out-payment-response":{"id":"components/schemas/out-payment-response","kind":"json-schema","title":"out-payment-response","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."},"status":{"type":"string","enum":["success","pending","deleted","delayed"],"description":"Status of the out payment."},"type":{"type":"string","description":"Type of out payment.","enum":["normal","instant"]},"method":{"type":"string","enum":["transfer","mb"],"description":"Method used for the out payment."},"customer":{"type":"object","description":"Customer associated with the out payment.","properties":{"id":{"type":"string","description":"Unique identifier for the customer."}}},"account":{"type":"object","description":"Easypay account from which the funds are transferred.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the Easypay account."}}},"out_account":{"type":"object","description":"Destination SEPA bank account for the out payment.","properties":{"id":{"type":"string","description":"Unique identifier for the destination account.","format":"uuid"}}},"key":{"type":"string","description":"Merchant reference key for the out payment."},"value":{"type":"number","format":"double","description":"Amount to be transferred."},"schedule_at":{"type":"string","description":"Scheduled date and time for the out payment (YYYY-MM-DD HH:MM:SS).","example":"2022-09-15 20:28:58"},"transactions":{"$ref":"#/components/schemas/out-payment-transactions","description":"Transaction related to the out payment."},"created_at":{"type":"string","description":"Date and time when the out payment was created.","example":"2022-09-15 20:28:58"},"timestamp":{"type":"string","description":"Timestamp of the last update or event for this out payment.","example":"1749054192"}}}},"components/schemas/account":{"id":"components/schemas/account","kind":"json-schema","title":"Account","data":{"title":"Account","type":"object","properties":{"id":{"type":"string","format":"uuid"}}}},"components/schemas/out-account":{"id":"components/schemas/out-account","kind":"json-schema","title":"out-account","data":{"type":"object","properties":{"account_holder":{"type":"string","description":"Bank account holder name","maxLength":100},"iban":{"type":"string","maxLength":34,"description":"Only IBANS from SEPA zones are supported"},"email":{"type":"string","maxLength":50},"phone":{"type":"string","maxLength":20},"key":{"type":"string","maxLength":255,"description":"Custom string controlled by our clients"},"country_code":{"type":"string","description":"Bank account country code","deprecated":true}},"required":["account_holder","iban","email","phone"]}},"components/schemas/refund-get-list-response":{"id":"components/schemas/refund-get-list-response","kind":"json-schema","title":"RefundListSuccessResponse","data":{"title":"RefundListSuccessResponse","type":"object","properties":{"metadata":{"type":"object","description":"An object containing additional information about the response. It includes details that help manage and navigate the retrieved data.","properties":{"next_cursor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides the cursor for the next set of records. This value should be used as the cursor parameter in subsequent requests to continue paginating through the data. If the cursor is an empty string or null, it indicates that there are no more results. To retrieve all available results, continue making subsequent requests until next_cursor is empty or null."},"children":[]}]}]}]},"count":{"type":"number","description":"The total number of records in the current response. This field indicates the number of items returned in the current set of results.","example":5}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the current status of the refund. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The payment instruction has been given, but the chosen payment method requires confirmation from an external entity before the status of the operation is finalized."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This is the initial state, and it means that the refund is queued."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"success:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The refund has been completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The refund could not be completed due to an error or issue."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field provides a clear indication of the current state of the refund, helping users understand its progress and outcome."},"children":[]}]}]}],"enum":["success","pending","failed","waiting"]},"transaction_key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system."},"value":{"type":"number","format":"float","example":10.89,"description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places."},"iban":{"type":"string","description":"The International Bank Account Number of the account to which the refund will be sent. This field is used to uniquely identify the recipient's bank account across international borders.","example":"PT50007950088428437201551"},"email":{"type":"string","description":"The email address of the account holder. This field is used for communication purposes, including sending notifications about the refund stat.","example":"customer@example.pt"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact phone number of the account holder, including the country code indicator (e.g., \"+351\"). This field is used for communication purposes, such as contacting the account holder for verification."},"children":[]}]}]}],"example":"+351912345678"},"account_holder":{"type":"string","description":"The name of the person or entity that holds the bank account. This field ensures that the refund is directed to the correct recipient."},"capture":{"type":"object","description":"The targeted Capture details.","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."},"payment_id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of payment processed. Possible values include: - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A one-time payment transaction. - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frequent:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A payment that occurs regularly but is not part of a subscription (e.g., recurring manual payments). - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A recurring payment that is part of a subscription plan, automatically processed at regular intervals. This field helps to categorize and manage different payment methods based on their frequency and nature."},"children":[]}]}]}]}}},"create_at":{"type":"string","format":"date-time","description":"The timestamp indicating when the resource was created. It is formatted as \"YYYY-MM-DD HH:MM\"","example":"2025-12-02 16:00:00"},"update_at":{"type":"string","format":"date-time","description":"The timestamp indicating when the resource was updated. It is formatted as \"YYYY-MM-DD HH:MM\".","example":"2025-12-02 16:00:00"}}}}}}},"components/schemas/refund-get-by-id-response":{"id":"components/schemas/refund-get-by-id-response","kind":"json-schema","title":"RefundDetailsSuccessResponse","data":{"title":"RefundDetailsSuccessResponse","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."},"status":{"enum":["success","pending","failed","waiting"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the current status of the refund. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The payment instruction has been given, but the chosen payment method requires confirmation from an external entity before the status of the operation is finalized."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This is the initial state, and it means that the refund is queued."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"success:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The refund has been completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The refund could not be completed due to an error or issue."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field provides a clear indication of the current state of the refund, helping users understand its progress and outcome."},"children":[]}]}]}]},"transaction_key":{"type":"string","description":"Your internal key identifying this refund."},"value":{"type":"number","format":"double","description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places (e.g., \"100.00\").","example":15.98},"account_holder":{"type":"string","description":"Bank account holder name."},"email":{"type":"string","description":"The email address of the account holder. This field is used for communication purposes, including sending notifications about the refund stat.","example":"customer@example.pt"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact phone number of the account holder, including the country code indicator (e.g., \"+351\"). This field is used for communication purposes, such as contacting the account holder for verification"},"children":[]}]}]}],"example":"+351912345678"},"iban":{"type":"string","description":"The International Bank Account Number of the account to which the refund will be sent. This field is used to uniquely identify the recipient's bank account across international borders.","example":"PT50007950088428437201551"},"reward_redemption_reversal":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reversal of the capture's reward redemption performed by this refund — the cashback restored to the customer's reward balance instead of being refunded to the payment method (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revert.reward_redemption_reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the refund was created with). Present only when the refunded capture had redeemed reward credits and this refund restored them. This amount is wallet credit and is not part of the refund "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" paid out to the payment method. The restored credit appears on the customer's reward ledger as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REWARD_RESTORATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /customer/{id}/rewards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/guides/rewards-and-redemptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rewards & Redemptions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full flow."},"children":[]}]}]}],"properties":{"value":{"type":"number","format":"double","description":"The reward amount this refund restored to the customer's reward balance.","example":2.5},"value_remaining":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The capture's redemption still un-reversed — the redeemed amount minus everything already restored to the customer's reward balance (the reversals of the capture's non-failed refunds and any chargeback restorations). Zero once the redemption is fully restored."},"children":[]}]}]}],"example":0}}},"capture":{"type":"object","description":"Object with all the details about the capture.","properties":{"transaction_key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system."},"capture_date":{"type":"string","format":"date-time","description":"The date when the action should be executed. This field specifies the exact day for capturing the transaction, formatted as \"YYYY-MM-DD\" (e.g., \"2024-06-30\"). It is optional and defaults to the current date if not specified."},"account":{"type":"object","description":"An object within the capture request that specifies the details of the account to which the funds should be routed, different from the initially requested account. This ensures that the captured funds are directed to the correct destination as per the specific routing requirements.","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."}}},"status":{"enum":["delayed","waiting","pending","success","failed","refunded"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the current status of the capture. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delayed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The capture attempt is scheduled for a future date and does not require further user interaction due to prior consent (e.g., authorization or frequent)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The payment instruction has been given, but the chosen payment method requires confirmation from an external entity before the status of the operation is finalized."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The capture is pending user completion."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"success:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The capture has been completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The capture could not be completed due to an error or issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refunded:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The capture has been refunded."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field provides a clear indication of the current state of the capture, helping users understand its progress and outcome."},"children":[]}]}]}]},"splits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the split. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."},"split_key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system."},"split_descriptive":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as \"Payment of Invoice Nº 1982652\" or \"Ticket for Queen\"."},"children":[]}]}]}]},"account":{"type":"object","description":"The account to which the funds should be routed. This field is used to specify the destination account for the split payment, ensuring that the correct recipient receives their designated portion of the funds.","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."}}},"value":{"type":"number","format":"double","example":8.65,"description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places. The value must be greater than or equal to 0.5."},"clearing_date":{"type":"string","format":"date","description":"The clearing date refers to the specific date when a financial transaction is finalized and the funds are transferred from one account to another. This is the point at which the payment is officially completed and the amount is debited from the payer's account and credited to the payee's account."},"clearing_period":{"type":"string","description":"The clearing period must follow the format 1Y, 10W or 30D. Y for Years, W for weeks, D for days. Minimum is 7 days, maximum is 1 year.","example":"1W"},"margin_account":{"type":"object","description":"The account to which the margin value should be routed. This field specifies the destination account for the margin portion of the funds, ensuring that the correct recipient receives the designated margin value.","properties":{"id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."}}},"margin_value":{"type":"number","format":"double","description":"The monetary amount designated as the margin in a split payment. This field is formatted as a double, and will be rounded to two decimal places. The value must be less than the total value of the split. This specifies the portion of the funds that should be routed to the margin account.","example":1.25},"status":{"enum":["waiting","success","failed","reverted"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the Split. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waiting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while the split is queued for processing, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the funds have been routed, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if processing errored, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reverted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the split has been reverted after a refund or chargeback."},"children":[]}]}]}]},"reward":{"type":"object","description":"Reward credits generated from this split. The credits are associated with the customer provided at the top level of the payment request and can only be redeemed by that customer. Present only when the split carries a reward.","properties":{"account":{"type":"object","description":"The account to which the reward credits are routed.","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."}}},"value":{"type":"number","format":"double","description":"The reward amount generated from this split.","example":1},"expiration_date":{"type":"string","format":"date","description":"The date until which the reward credits are valid. Present only when the reward has an expiration date.","example":"2027-04-02"}}},"reverts":{"type":"array","description":"Object with all the information about the revert.","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."},"value":{"type":"number","format":"double","example":12.87,"description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places. The value must be greater than or equal to 0.5."},"margin_value":{"type":"number","format":"double","description":"The monetary amount designated as the margin in a split payment. This field is formatted as a double, and will be rounded to two decimal places. The value must be less than the total value of the split. This specifies the portion of the funds that should be routed to the margin account.","example":1.25}}}}}}},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of payment processed. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A one-time payment transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frequent:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A payment that occurs regularly but is not part of a subscription (e.g., recurring manual payments)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A recurring payment that is part of a subscription plan, automatically processed at regular intervals. This field helps to categorize and manage different payment methods based on their frequency and nature."},"children":[]}]}]}]}]},"payment_id":{"type":"string","format":"uuid","description":"A unique identifier for the payment. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."},"id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."},"descriptive":{"type":"string","description":"Description about the capture."},"value":{"type":"number","format":"float","example":10.86,"description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places. The value must be greater than or equal to 0.5."},"force_3ds":{"type":"boolean","description":"Whether or not you want to force the 3DS authentication.","default":false},"reward_redemption":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reward credits redeemed in the original capture. Present only when the capture redeemed reward credits. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/guides/rewards-and-redemptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rewards & Redemptions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full flow."},"children":[]}]}]}],"properties":{"account":{"type":"object","description":"The reward account the credits were debited from.","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."}}},"value":{"type":"number","format":"double","description":"The redeemed reward amount.","example":2.5}}}}}}}},"components/schemas/refund-post-request":{"id":"components/schemas/refund-post-request","kind":"json-schema","title":"RefundPostRequestBody","data":{"title":"RefundPostRequestBody","type":"object","required":["value"],"properties":{"transaction_key":{"type":"string","maxLength":50,"description":"Your internal key identifying this refund"},"iban":{"type":"string","maxLength":34,"description":"Optional - Iban from the bank account"},"email":{"type":"string","maxLength":50,"description":"Optional - Email from the bank account holder"},"phone":{"type":"string","maxLength":20,"description":"Optional - Phone from the bank account holder"},"account_holder":{"type":"string","maxLength":40,"description":"Optional - Bank account holder name"},"value":{"type":"number","format":"double","minimum":0.01,"example":17.5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount to refund. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present, this is the gross amount from the payer's perspective — the amount refunded to the payment method plus any redeemed reward credits being restored."},"children":[]}]}]}]},"revert":{"type":"object","description":"Reverts refers to the process of reversing a previously made split payment. This means that the amounts that were divided and allocated to different recipients or accounts are returned to the original payer or redistributed as per the new instructions.","properties":{"mode":{"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" All associated splits and their margins will be reverted - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only the selected splits and their margins will be reverted"},"children":[]}]}]}]}],"enum":["partial","total"]},"reward_redemption_reversal":{"type":"number","format":"double","example":2.5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the refund value to restore to the customer's reward balance instead of refunding it to the payment method — the payment method receives the refund value minus this amount. Only valid when the capture redeemed reward credits, and it can exceed neither the refund value nor the redemption not yet restored by previous refunds. On a TOTAL revert it must equal the remaining redemption, and defaults to it when omitted; on captures fully paid with reward credits it defaults to the refund value. Otherwise, omitting the field restores nothing. The restored credit lands on the customer's reward ledger as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REWARD_RESTORATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /customer/{id}/rewards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/guides/rewards-and-redemptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rewards & Redemptions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full flow."},"children":[]}]}]}]},"splits":{"type":"array","description":"Array of splits to revert. Required only if the mode is PARTIAL.","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The uuid of split."}}}}}}}}},"components/schemas/refund-post-response":{"id":"components/schemas/refund-post-response","kind":"json-schema","title":"RefundPostSuccessResponse","data":{"title":"RefundPostSuccessResponse","type":"object","properties":{"status":{"type":"string","example":"ok"},"message":{"type":"string","example":"Your request was successfully created"},"id":{"type":"string","format":"uuid","example":"25997c28-1902-4f6d-842e-c6050e7d5421","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."}}}},"components/schemas/chargeback-list-response":{"id":"components/schemas/chargeback-list-response","kind":"json-schema","title":"Chargeback","data":{"title":"Chargeback","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"created_at":{"type":"string","description":"The timestamp indicating when the resource was created. It is formatted as \"YYYY-MM-DD HH:MM\".","example":"2006-01-02 15:04"},"message":{"type":"string","description":"The message field provides a human-readable explanation of the chargeback reason code, making it easier to understand the cause of the dispute without needing to interpret technical codes. This message clarifies the issue, such as incorrect account information, insufficient funds, or unauthorized transactions, and helps merchants quickly identify the nature of the problem.","example":"MD06 - Refund Request by End Customer"},"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code field provides the specific SEPA or Visa/Masterd code associated with the chargeback. This code identifies the reason for the chargeback, offering insight into why the transaction was disputed by the consumer's bank or card issuer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SEPA reasons:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AC01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Incorrect Account Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AC04"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Closed Account Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AC06"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Blocked Account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AC13"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Invalid Debitor Account Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AG01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Transaction Forbidden"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AG02"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Invalid Bank Operation Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AM04"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Insufficient Funds"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AM05"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Duplication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BE05"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Unrecognised Initiating Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CNOR"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Creditor Bank is Not Registered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNOR"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Debitor Bank is Not Registered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ED05"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Settlement Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FF01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Invalid File Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MD01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  No Mandate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MD02"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Missing Mandatory Mandate Information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MD06"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Refund Request by End Customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MD07"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  End Customer Deceased"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MS02"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Not Specified Reason Customer Generated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MS03"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Not Specified Reason Agent Generated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RC01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Bank Identifier Incorrect"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RR01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Missing Debitor Account Or Identification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RR02"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Missing Debitor Name Or Address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RR03"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Missing Creditor Name or Address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RR04"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Regulatory Reason"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SL01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Specific Service Offered By Debitor Agent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa Reasons:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EMV Liability Shift Counterfeit Fraud"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EMV Liability Shift Non-Counterfeit Fraud"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Other Fraud, Card-Present Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.4"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Other Fraud, Card-Absent Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Visa Fraud Monitoring Program"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11.1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Card Recovery Bulletin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11.2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Declined Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12.1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Late Presentment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12.2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Incorrect Transaction Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Incorrect Currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12.4"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Incorrect Account Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12.5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Incorrect Amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Duplicate Processing / Paid By Other Means"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12.7"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Invalid Data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Merchandise / Services Not Received"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cancelled Recurring Transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Not As Described Or Defective Merchandise / Services"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.4"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Counterfeit Merchandise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Misrepresentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Credit Not Processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.7"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cancelled Merchandise / Services"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.8"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Original Credit Transaction Not Accepted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.9"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Non-Receipt of Cash or Load Transaction Value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mastercard reasons:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4837"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No Cardholder Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4840"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Fraudulent Processing Of Transactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4849"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Questionable Merchant Activity - Global Merchant Audit Program (GMAP)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4849"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Questionable Merchant Activity - Mastercard Rule 3.7 Violation for Coercion Claim"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4849"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Questionable Merchant Activity - Questionable Merchant Audit Program (QMAP)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4863"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Does Not Recognize, Potential Fraud"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4870"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EMV Chip Liability Shift"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4871"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Chip Liability Shift – Lost / Stolen / Never Received Fraud"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4807"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Warning Bulletin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4808"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authorization Chargeback - Cardholder-Activated Terminal (CAT) 3 Device"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4808"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authorization Chargeback - Expired Chargeback Protection Period"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4808"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authorization Chargeback - Multiple Authorization Requests"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4808"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authorization Chargeback - Required Authorization Not Obtained"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4812"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Account Number Not On File"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Credit Posted as a Purchase"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Digital Goods Purchase of $25 or Less"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Goods or Services Not as Described or Defective"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Goods or Services Not Provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Issuer Dispute of a Recurring Transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Timeshares"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - \"No Show\" Hotel Charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Transaction Did Not Complete"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Addendum Dispute"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Cardholder Dispute of a Recurring Transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Counterfeit Goods"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Credit Not Processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4855"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Goods or Services Not Provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4859"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Addendum, No-Show, or ATM Dispute (Europe)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4859"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Addendum, No-Show, or ATM Dispute (Non-European Bank)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4860"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Credit Not Processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4831"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Incorrect Transaction Amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - Charges for Loss, Theft, or Damages"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - Late Presentment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - Merchant Credit Correcting Error, Cardholder Currency Exchange Loss"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - Transaction Amount Differs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - Currency Conversion (Dynamic Currency Conversion)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - Unreasonable Amount (Europe)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - ATM Disputes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - Cardholder Debited More than Once"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4841"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Canceled Recurring or Digital Goods Transactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4842"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Late Presentment (Europe)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4842"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Late Presentment (Non-European Banks)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4846"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Correct Transaction Currency Code Not Provided / Currency Errors (Non-European Bank)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4846"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Correct Transaction Currency Code Not Provided / Currency Error (Europe)"},"children":[]}]}]}]}],"example":"MD06"},"amount":{"type":"number","format":"double","minimum":0.5,"example":12.87,"description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places. The value must be greater than or equal to 0.5."},"capture":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"payment_id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"payment_type":{"type":"string","enum":["single","frequent","subscription"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of payment processed. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single: A one-time payment transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frequent: A payment that occurs regularly but is not part of a subscription (e.g., recurring manual payments)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription: A recurring payment that is part of a subscription plan, automatically processed at regular intervals."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field helps to categorize and manage different payment methods based on their frequency and nature."},"children":[]}]}]}]}}}}}},"metadata":{"$ref":"#/components/schemas/metadata-cursor"}}}},"components/schemas/chargeback-get-by-id-response":{"id":"components/schemas/chargeback-get-by-id-response","kind":"json-schema","title":"ChargebackDetailsSuccessResponse","data":{"title":"ChargebackDetailsSuccessResponse","type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"created_at":{"type":"string","description":"The timestamp indicating when the resource was created. It is formatted as \"YYYY-MM-DD HH:MM\".","example":"2006-01-02 15:04"},"message":{"type":"string","description":"The message field provides a human-readable explanation of the chargeback reason code, making it easier to understand the cause of the dispute without needing to interpret technical codes. This message clarifies the issue, such as incorrect account information, insufficient funds, or unauthorized transactions, and helps merchants quickly identify the nature of the problem.","example":"MD06 - Refund Request by End Customer"},"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code field provides the specific SEPA or Visa/Masterd code associated with the chargeback. This code identifies the reason for the chargeback, offering insight into why the transaction was disputed by the consumer's bank or card issuer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SEPA reasons:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AC01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Incorrect Account Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AC04"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Closed Account Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AC06"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Blocked Account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AC13"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Invalid Debitor Account Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AG01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Transaction Forbidden"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AG02"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Invalid Bank Operation Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AM04"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Insufficient Funds"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AM05"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Duplication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BE05"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Unrecognised Initiating Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CNOR"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Creditor Bank is Not Registered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNOR"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Debitor Bank is Not Registered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ED05"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Settlement Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FF01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Invalid File Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MD01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  No Mandate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MD02"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Missing Mandatory Mandate Information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MD06"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Refund Request by End Customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MD07"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  End Customer Deceased"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MS02"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Not Specified Reason Customer Generated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MS03"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Not Specified Reason Agent Generated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RC01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Bank Identifier Incorrect"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RR01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Missing Debitor Account Or Identification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RR02"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Missing Debitor Name Or Address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RR03"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Missing Creditor Name or Address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RR04"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Regulatory Reason"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SL01"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Specific Service Offered By Debitor Agent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa Reasons:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EMV Liability Shift Counterfeit Fraud"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EMV Liability Shift Non-Counterfeit Fraud"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Other Fraud, Card-Present Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.4"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Other Fraud, Card-Absent Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Visa Fraud Monitoring Program"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11.1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Card Recovery Bulletin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11.2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Declined Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12.1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Late Presentment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12.2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Incorrect Transaction Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Incorrect Currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12.4"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Incorrect Account Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12.5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Incorrect Amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Duplicate Processing / Paid By Other Means"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12.7"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Invalid Data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Merchandise / Services Not Received"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cancelled Recurring Transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Not As Described Or Defective Merchandise / Services"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.4"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Counterfeit Merchandise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Misrepresentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Credit Not Processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.7"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cancelled Merchandise / Services"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.8"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Original Credit Transaction Not Accepted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13.9"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Non-Receipt of Cash or Load Transaction Value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mastercard reasons:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4837"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No Cardholder Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4840"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Fraudulent Processing Of Transactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4849"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Questionable Merchant Activity - Global Merchant Audit Program (GMAP)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4849"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Questionable Merchant Activity - Mastercard Rule 3.7 Violation for Coercion Claim"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4849"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Questionable Merchant Activity - Questionable Merchant Audit Program (QMAP)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4863"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Does Not Recognize, Potential Fraud"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4870"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EMV Chip Liability Shift"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4871"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Chip Liability Shift – Lost / Stolen / Never Received Fraud"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4807"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Warning Bulletin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4808"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authorization Chargeback - Cardholder-Activated Terminal (CAT) 3 Device"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4808"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authorization Chargeback - Expired Chargeback Protection Period"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4808"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authorization Chargeback - Multiple Authorization Requests"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4808"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authorization Chargeback - Required Authorization Not Obtained"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4812"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Account Number Not On File"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Credit Posted as a Purchase"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Digital Goods Purchase of $25 or Less"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Goods or Services Not as Described or Defective"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Goods or Services Not Provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Issuer Dispute of a Recurring Transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Timeshares"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - \"No Show\" Hotel Charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Transaction Did Not Complete"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Addendum Dispute"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Cardholder Dispute of a Recurring Transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Counterfeit Goods"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4853"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder Dispute - Credit Not Processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4855"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Goods or Services Not Provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4859"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Addendum, No-Show, or ATM Dispute (Europe)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4859"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Addendum, No-Show, or ATM Dispute (Non-European Bank)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4860"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Credit Not Processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4831"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Incorrect Transaction Amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - Charges for Loss, Theft, or Damages"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - Late Presentment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - Merchant Credit Correcting Error, Cardholder Currency Exchange Loss"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - Transaction Amount Differs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - Currency Conversion (Dynamic Currency Conversion)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - Unreasonable Amount (Europe)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - ATM Disputes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4834"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POI Error - Cardholder Debited More than Once"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4841"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Canceled Recurring or Digital Goods Transactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4842"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Late Presentment (Europe)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4842"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Late Presentment (Non-European Banks)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4846"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Correct Transaction Currency Code Not Provided / Currency Errors (Non-European Bank)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4846"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Correct Transaction Currency Code Not Provided / Currency Error (Europe)"},"children":[]}]}]}]}],"example":"MD06"},"amount":{"type":"number","format":"double","minimum":0.5,"example":12.87,"description":"The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places. The value must be greater than or equal to 0.5."},"capture":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"payment_id":{"type":"string","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"payment_type":{"type":"string","enum":["SINGLE","FREQUENT","SUBSCRIPTION"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of payment processed. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single: A one-time payment transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frequent: A payment that occurs regularly but is not part of a subscription (e.g., recurring manual payments)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription: A recurring payment that is part of a subscription plan, automatically processed at regular intervals."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field helps to categorize and manage different payment methods based on their frequency and nature."},"children":[]}]}]}]}}}}}},"components/schemas/payment-types-response":{"id":"components/schemas/payment-types-response","kind":"json-schema","title":"PayByLinkPaymentTypes","data":{"title":"PayByLinkPaymentTypes","type":"string","enum":["SINGLE","FREQUENT","SUBSCRIPTION"],"description":""}},"components/schemas/communication-channels-response":{"id":"components/schemas/communication-channels-response","kind":"json-schema","title":"Communication-Channels","data":{"title":"Communication-Channels","type":"array","description":"The communication channels specifies where the final customer link should be forwarded.","items":{"type":"string","enum":["SMS","EMAIL"],"example":"SMS"}}},"components/schemas/customer-response":{"id":"components/schemas/customer-response","kind":"json-schema","title":"Customer","data":{"title":"Customer","type":"object","description":"The Customer object contains detailed information about the customer required to create a pay-by-link.","required":["name","email","phone"],"properties":{"name":{"type":"string","example":"Jonh Doe","description":"The full name of the customer. This field is used to identify the customer and personalize interactions. It typically includes the customer's first name and last name."},"email":{"type":"string","format":"email","example":"example@easypay.pt","description":"The email address of the customer. This field is used for communication purposes, including sending transaction confirmations, receipts, and other notifications related to the customer's activities."},"phone":{"type":"string","example":"+351911234567","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact phone number of the customer, excluding the country code indicator (e.g., \"+351\"). This field is used for communication purposes. If the payment method is MB WAY, the phone_number is required and is used to send the MB WAY push notification."},"children":[]}]}]}]}}}},"components/schemas/payment-methods-response":{"id":"components/schemas/payment-methods-response","kind":"json-schema","title":"PBL-Payment-Methods","data":{"title":"PBL-Payment-Methods","type":"array","description":"All the payment methods available to create a pay-by-link payment.","items":{"type":"string","enum":["MB","MBW","DD","CC","VI","AP","GP"],"example":"MBW"}}},"components/schemas/capture-response":{"id":"components/schemas/capture-response","kind":"json-schema","title":"Capture","data":{"title":"Capture","type":"object","properties":{"descriptive":{"type":"string","description":"A customizable text field for users to input some descriptive associated with this capture operation."},"key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system."}}}},"components/schemas/single-response":{"id":"components/schemas/single-response","kind":"json-schema","title":"Single","data":{"title":"Single","type":"object","description":"Single object with all the fields necessary after creating a Pay-by-Link request.","required":["requested_amount"],"properties":{"requested_amount":{"type":"string","pattern":"^\\d+(\\.\\d{1,2})?$","description":"String representing the monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places.","example":"10.45"}}}},"components/schemas/frequent-response":{"id":"components/schemas/frequent-response","kind":"json-schema","title":"frequent-response","data":{"type":"object","description":"Frequent object with all the fields necessary after creating a Pay-by-Link request.","required":["minimum_amount","maximum_amount","unlimited_payments"],"properties":{"minimum_amount":{"type":"string","description":"Minimum value available to create a Pay-by-link request.","example":"5"},"maximum_amount":{"type":"string","description":"Maximum value available to create a Pay-by-link request.","example":"10"},"unlimited_payments":{"type":"boolean","description":"Determines whether payments can be unlimited."}}}},"components/schemas/subscription-response":{"id":"components/schemas/subscription-response","kind":"json-schema","title":"subscription-response","data":{"type":"object","description":"Subscription object with all the fields necessary after creating a Pay-by-Link request.","required":["frequency","start_time"],"properties":{"frequency":{"enum":["1D","1W","2W","1M","2M","3M","4M","6M","1Y","2Y","3Y"],"description":"Determines how often the subscription payment is made."},"maximum_captures":{"type":"integer","example":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the maximum number of captures for this subscription."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It's only required when no expiration_time is set."},"children":[]}]}]}]}]},"start_time":{"type":"string","description":"Determines the start date of billing cycles for this subscription. This date must be always in the future.","example":"2025-01-15 00:00"},"capture_now":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether an immediate capture is performed. If this value is true, an immediate capture will be performed and the second capture will be on the date entered in the start_time field."},"children":[]}]}]}]},"retries":{"type":"integer","description":"Number of retries in each payment cycle.\nThe chosen frequency will define the max number of possible retries."},"failover":{"type":"boolean","default":false,"description":"After all retries failed, the payment cycle can have another try with another single method."},"expiration_time":{"type":"string","format":"date-time","description":"RFC3339 formatted time for the subscription expiration date."}}}},"components/schemas/status-response":{"id":"components/schemas/status-response","kind":"json-schema","title":"Status","data":{"title":"Status","type":"string","enum":["ACTIVE","EXPIRED","DISABLED","FINALIZED"]}},"components/schemas/link-get-response-object":{"id":"components/schemas/link-get-response-object","kind":"json-schema","title":"Link","data":{"title":"Link","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","readOnly":true},"created_at":{"type":"string","example":"2025-06-16T13:32:32Z","description":"String with the date on which this Pay By Link was created.","format":"date-time"},"modified_at":{"type":"string","example":"2025-06-16T13:32:32Z","description":"String with the date on which this Pay By Link was modified.","format":"date-time"},"expiration_time":{"type":"string","format":"date-time","description":"The last possible time to make the payment.","example":"2026-06-10T09:27:55Z"},"type":{"$ref":"#/components/schemas/payment-types-response","description":"Specifies the type of payment being performed. Possible values are \"Single\" (One-time transactions that will let your customers pay an amount of money to you), \"Frequent\" (Are repeatable transactions of varying sums without the client having to enter their payment details again), and \"Subscription\" (periodic payments of the same amount of money, configured through Checkout or our Payments API)."},"communication_channels":{"$ref":"#/components/schemas/communication-channels-response"},"customer":{"$ref":"#/components/schemas/customer-response"},"payment":{"type":"object","properties":{"methods":{"$ref":"#/components/schemas/payment-methods-response"},"capture":{"$ref":"#/components/schemas/capture-response"},"single":{"$ref":"#/components/schemas/single-response"},"frequent":{"$ref":"#/components/schemas/frequent-response"},"subscription":{"$ref":"#/components/schemas/subscription-response"}}},"url":{"type":"string","format":"url","example":"https://easypay.pt/s/XStDvnMKZaN","description":"Link that redirects to the Easypay checkout payment page."},"image":{"type":"string","format":"url","example":"https://cdn.easypay.pt/images/qr/XStDvnMKZaN","description":"Link that redirects to a QR code to access the payment checkout page."},"status":{"$ref":"#/components/schemas/status-response","description":"All the payment status after creating a pay-by-link payment."}}}},"components/schemas/invalid-params-response":{"id":"components/schemas/invalid-params-response","kind":"json-schema","title":"PayByLinkInvalidParamsResponse","data":{"title":"PayByLinkInvalidParamsResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the payload field that contains an error.","example":"expiration_time"},"reason":{"type":"string","description":"Reason why this payload field contains an error.","example":"expiration_time should be formated as RFC 3339 and in the future"}}}},"components/schemas/bad-request-response":{"id":"components/schemas/bad-request-response","kind":"json-schema","title":"PayByLinkBadRequestResponse","data":{"title":"PayByLinkBadRequestResponse","type":"object","properties":{"type":{"type":"string","description":"Link that redirects to the API documentation.","example":"https://docs.easypay.pt/docs/error-handling#invalid-params-error-400"},"title":{"type":"string","example":"Invalid payload provided","description":"Brief title about the error."},"detail":{"type":"string","example":"Your request parameters didn't validate","description":"Brief description about the error."},"status":{"type":"number","default":400,"description":"API error code."},"invalid_params":{"$ref":"#/components/schemas/invalid-params-response"}}}},"components/schemas/forbidden-response":{"id":"components/schemas/forbidden-response","kind":"json-schema","title":"PayByLinkForbiddenResponse","data":{"title":"PayByLinkForbiddenResponse","type":"object","properties":{"type":{"type":"string","description":"Link that redirects to the API documentation.","example":"https://docs.easypay.pt/docs/error-handling#authentication-error-403"},"title":{"type":"string","example":"Forbidden","description":"Brief title about the error."},"detail":{"type":"string","example":"Authentication failed","description":"Brief description about the error."},"status":{"type":"number","default":403,"description":"API error code."}}}},"components/schemas/internal-server-error-response":{"id":"components/schemas/internal-server-error-response","kind":"json-schema","title":"PayByLinkBadRequestResponse","data":{"title":"PayByLinkBadRequestResponse","type":"object","properties":{"status":{"description":"Indicates the response status of the API request.","type":"string","example":"error"},"message":{"type":"string","description":"An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.\n","example":"Internal server error"}}}},"components/schemas/payment-types-request":{"id":"components/schemas/payment-types-request","kind":"json-schema","title":"PayByLinkPaymentTypes","data":{"title":"PayByLinkPaymentTypes","type":"string","enum":["SINGLE","FREQUENT","SUBSCRIPTION"],"description":""}},"components/schemas/customer-request":{"id":"components/schemas/customer-request","kind":"json-schema","title":"Customer","data":{"title":"Customer","type":"object","description":"The Customer object contains detailed information about the customer required to create a pay-by-link.","required":["name","email","phone","language"],"properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."},"name":{"type":"string","example":"Jonh Doe","description":"The full name of the customer. This field is used to identify the customer and personalize interactions. It typically includes the customer's first name and last name.","maxLength":255},"email":{"type":"string","format":"email","example":"example@easypay.pt","maxLength":70,"description":"The email address of the customer. This field is used for communication purposes, including sending transaction confirmations, receipts, and other notifications related to the customer's activities.\nAlso, this email will be used to send the payment link if the EMAIL channel was requested in the communication channels."},"phone":{"type":"string","example":"+351911234567","description":"The contact phone number of the customer has the E.164 pattern and is always required. This number will be used to make the payment if the method is MB WAY and to send the payment link if the SMS channel was requested in the communication channels.","maxLength":15},"language":{"type":"string","description":"The language preference of the customer, specified in the ISO 639-1 Alpha-2 format (e.g., \"EN\" for English, \"PT\" for Portuguese). This field is used to indicate the customer's preferred language for communication and documentation.","default":"PT","minLength":2,"maxLength":2}}}},"components/schemas/communication-channels-request":{"id":"components/schemas/communication-channels-request","kind":"json-schema","title":"Communication-Channels","data":{"title":"Communication-Channels","type":"array","description":"The communication channels specifies where the final customer link should be forwarded.","items":{"type":"string","enum":["SMS","EMAIL"],"example":"SMS"}}},"components/schemas/payment-methods-request":{"id":"components/schemas/payment-methods-request","kind":"json-schema","title":"PBL-Payment-Methods","data":{"title":"PBL-Payment-Methods","type":"array","description":"All the payment methods available to create a pay-by-link payment.","items":{"type":"string","enum":["MB","MBW","DD","CC","VI","AP","GP"],"example":"MBW"}}},"components/schemas/capture-request":{"id":"components/schemas/capture-request","kind":"json-schema","title":"Capture","data":{"title":"Capture","type":"object","properties":{"descriptive":{"type":"string","description":"A customizable text field for users to input some descriptive associated with this capture operation.","maxLength":255},"key":{"type":"string","description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system.","maxLength":50}},"description":"Capture object with all the fields necessary to create a Pay-by-Link request"}},"components/schemas/single-request":{"id":"components/schemas/single-request","kind":"json-schema","title":"Single","data":{"title":"Single","type":"object","description":"Single object with all the fields necessary to create a Pay-by-Link request.","required":["requested_amount"],"properties":{"requested_amount":{"type":"string","pattern":"^\\d+(\\.\\d{1,2})?$","description":"String representing the monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places.","example":"10.45"}}}},"components/schemas/frequent-request":{"id":"components/schemas/frequent-request","kind":"json-schema","title":"frequent-request","data":{"type":"object","description":"This frequent object is not implemented yet. For now, we can only use Pay By Link with Single payments.","required":["minimum_amount","maximum_amount","unlimited_payments"],"properties":{"minimum_amount":{"type":"string","description":"Minimum value available to create a Pay-by-link request."},"maximum_amount":{"type":"string","description":"Maximum value available to create a Pay-by-link request."},"unlimited_payments":{"type":"boolean","description":"Determines whether payments can be unlimited."}}}},"components/schemas/subscription-request":{"id":"components/schemas/subscription-request","kind":"json-schema","title":"subscription-request","data":{"type":"object","description":"This subscription object is not implemented yet. For now, we can only use Pay By Link with Single payments.","required":["frequency","start_time"],"properties":{"frequency":{"enum":["1D","1W","2W","1M","2M","3M","4M","6M","1Y","2Y","3Y"],"description":"Determines how often the subscription payment is made."},"maximum_captures":{"type":"integer","example":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the maximum number of captures for this subscription."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It's only required when no expiration_time is set."},"children":[]}]}]}]}]},"start_time":{"type":"string","description":"Determines the start date of billing cycles for this subscription. This date must be always in the future.","example":"2025-01-15 00:00"},"capture_now":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether an immediate capture is performed. If this value is true, an immediate capture will be performed and the second capture will be on the date entered in the start_time field."},"children":[]}]}]}]},"retries":{"type":"integer","description":"Number of retries in each payment cycle.\nThe chosen frequency will define the max number of possible retries."},"failover":{"type":"boolean","default":false,"description":"After all retries failed, the payment cycle can have another try with another single method."},"expiration_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC3339 formatted time for the subscription expiration date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if maximum_captures is not defined."},"children":[]}]}]}]}]}}}},"components/schemas/notification-request":{"id":"components/schemas/notification-request","kind":"json-schema","title":"Notification","data":{"title":"Notification","type":"object","description":"Opt-in notification preferences for the link. When enabled, the customer receives an email with the payment instructions after choosing the method on the Pay by Link page.","properties":{"customer_method_instructions_email":{"type":"boolean","default":false,"description":"When true, sends the payment-instructions email to the customer. Requires the customer name, email and language to be present."}}}},"components/schemas/link-response-object":{"id":"components/schemas/link-response-object","kind":"json-schema","title":"Link","data":{"title":"Link","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.","readOnly":true},"created_at":{"type":"string","description":"String with the date on which this Pay By Link was created.","example":"2025-06-16T13:32:32Z","format":"date-time","readOnly":true},"modified_at":{"type":"string","description":"String with the date on which this Pay By Link was modified.","example":"2025-06-16T13:32:32Z","format":"date-time","readOnly":true},"expiration_time":{"type":"string","format":"date-time","description":"The last possible time to make the payment.","example":"2026-06-10T09:27:55Z"},"type":{"$ref":"#/components/schemas/payment-types-response","description":"Specifies the type of payment being performed. Possible values are \"Single\" (One-time transactions that will let your customers pay an amount of money to you), \"Frequent\" (Are repeatable transactions of varying sums without the client having to enter their payment details again), and \"Subscription\" (periodic payments of the same amount of money, configured through Checkout or our Payments API)."},"customer":{"$ref":"#/components/schemas/customer-response"},"communication_channels":{"$ref":"#/components/schemas/communication-channels-response"},"payment":{"type":"object","properties":{"methods":{"$ref":"#/components/schemas/payment-methods-response"},"capture":{"$ref":"#/components/schemas/capture-response"},"single":{"$ref":"#/components/schemas/single-response"},"frequent":{"$ref":"#/components/schemas/frequent-response"},"subscription":{"$ref":"#/components/schemas/subscription-response"}}},"url":{"type":"string","format":"url","example":"https://easypay.pt/s/XStDvnMKZaN","description":"Link that redirects to the Easypay checkout payment page."},"image":{"type":"string","format":"url","example":"https://cdn.easypay.pt/images/qr/XStDvnMKZaN","description":"Link that redirects to a QR code to access the payment checkout page."},"status":{"$ref":"#/components/schemas/status-response","description":"All the payment status after creating a pay-by-link payment."}}}},"components/schemas/not-implemented-response":{"id":"components/schemas/not-implemented-response","kind":"json-schema","title":"PayByLinkNotImplementedResponse","data":{"title":"PayByLinkNotImplementedResponse","type":"object","properties":{"title":{"type":"string","example":"The feature you tried to use is not implemented","description":"Brief title about the error."},"detail":{"type":"string","example":"Subscriptions and Frequents are not yet available","description":"Brief description about the error."},"status":{"type":"number","default":501,"description":"API error code."}}}},"components/schemas/not-found-response":{"id":"components/schemas/not-found-response","kind":"json-schema","title":"PayByLinkNotFoundResponse","data":{"title":"PayByLinkNotFoundResponse","type":"object","properties":{"title":{"type":"string","example":"Not Found","description":"Brief title about the error."},"detail":{"type":"string","example":"no link found with the provided id","description":"Brief description about the error."},"status":{"type":"number","default":404,"description":"API error code."}}}},"components/schemas/conflict-response":{"id":"components/schemas/conflict-response","kind":"json-schema","title":"PayByLinkConflictResponse","data":{"title":"PayByLinkConflictResponse","type":"object","properties":{"title":{"type":"string","example":"Conflict with the current state of the target resource","description":"Brief title about the error."},"detail":{"type":"string","example":"conflict with the resource's current state","description":"Brief description about the error."},"status":{"type":"number","default":409,"description":"API error code."}}}},"components/schemas/customer-detail":{"id":"components/schemas/customer-detail","kind":"json-schema","title":"customer-detail","data":{"type":"object","description":"The Customer object contains detailed information about the customer, including reward balances.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the customer.","example":"649e88cf-0b78-4c36-8f99-33f5ebb812a1"},"name":{"type":"string","description":"Full name of the customer.","maxLength":255,"example":"John Doe"},"email":{"type":"string","format":"email","description":"Customer's email address.","maxLength":70,"example":"john.doe@example.com"},"phone":{"type":"string","description":"The contact phone number of the customer, excluding the country code indicator.","maxLength":15,"example":"911234567"},"phone_indicative":{"type":"string","description":"The country code indicator for the customer's phone number.","maxLength":5,"example":"+351"},"fiscal_number":{"type":"string","description":"Customer's tax identification number or fiscal number.","maxLength":20,"example":"PT123456789"},"key":{"type":"string","description":"A customizable text field for users to input their own identifier for the customer.","maxLength":255,"example":"customer Key Example"},"language":{"type":"string","description":"Preferred language for customer communications. Uses ISO 639-1 language codes.","maxLength":2,"minLength":2,"enum":["PT","EN","ES"],"example":"PT"},"reward_balances":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reward balances across all reward accounts for this customer. Empty array if no reward accounts exist. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/guides/rewards-and-redemptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rewards & Redemptions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full flow."},"children":[]}]}]}],"items":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The unique identifier of the reward account.","example":"458b2fc4-3092-4de3-abd4-fe1600c09420"},"available_balance":{"type":"number","description":"The available reward balance for this account.","example":12.5}}}}}}},"components/schemas/reward-ledger-entry":{"id":"components/schemas/reward-ledger-entry","kind":"json-schema","title":"reward-ledger-entry","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single movement on a customer's reward ledger. Each entry represents a reward earned ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REWARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), a redemption against a reward ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REDEMPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), an unused reward swept at its expiry date ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REWARD_EXPIRATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), a reward taken back after the earning capture was refunded or charged back ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REWARD_REVERSAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or a redemption given back as fresh credit after a refund or chargeback ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REWARD_RESTORATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"required":["id","account_id","type","amount","created_at"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the ledger entry.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"account_id":{"type":"string","format":"uuid","description":"The reward account this entry belongs to.","example":"458b2fc4-3092-4de3-abd4-fe1600c09420"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of movement. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REWARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for credits earned; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REDEMPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for credits consumed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REWARD_EXPIRATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for unused credits removed from the balance at their expiry date; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REWARD_REVERSAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for credits taken back when the capture that earned them was refunded or charged back; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REWARD_RESTORATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for credits given back when a redemption is undone — either by a refund created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revert.reward_redemption_reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or by a chargeback on the capture that redeemed them."},"children":[]}]}]}],"enum":["REWARD","REDEMPTION","REWARD_EXPIRATION","REWARD_REVERSAL","REWARD_RESTORATION"],"example":"REWARD"},"amount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The absolute value of the movement. Always positive; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" signals direction."},"children":[]}]}]}],"example":10},"expiration_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date after which the reward expires. Present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REWARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REWARD_EXPIRATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REWARD_RESTORATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2027-01-15"},"capture":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The capture associated with this entry — the capture that granted the credit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REWARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REWARD_EXPIRATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REWARD_REVERSAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or the capture that consumed it ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REDEMPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: REWARD_RESTORATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Omitted when the entry is not linked to a capture (e.g. orphaned splits)."},"children":[]}]}]}],"required":["id"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the capture.","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"}}},"created_at":{"type":"string","format":"date-time","description":"The date and time when the movement occurred.","example":"2026-01-15T10:30:00Z"}}}},"components/schemas/terminal":{"id":"components/schemas/terminal","kind":"json-schema","title":"terminal","data":{"type":"object","description":"Terminal (POS) object representing a payment terminal device.","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the terminal.","example":"458b2fc4-3092-4de3-abd4-fe1600c09420"},"serial_number":{"type":"string","description":"The serial number of the terminal device. Unique per acquirer.","example":"123-456-789"},"name":{"type":"string","description":"The name of the terminal. Must be unique.","example":"Terminal Checkout 1"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","DELETED"],"description":"The current status of the terminal. Determined by the device state.","example":"ACTIVE"},"acquirer":{"type":"string","enum":["VERIFONE"],"description":"The acquirer associated with the terminal.","example":"VERIFONE"},"model":{"type":"string","description":"The model of the terminal device. Inferred from the serial number.","example":"V240m"},"last_transaction_at":{"type":["string","null"],"format":"date-time","description":"The date and time of the last transaction processed by the terminal. Null if no transactions have been processed.","example":"2025-08-05T13:44:29Z"},"created_at":{"type":"string","format":"date-time","description":"The date and time when the terminal was created.","example":"2025-08-05T13:44:29Z"}}}},"components/schemas/notification-generic":{"id":"components/schemas/notification-generic","kind":"json-schema","title":"notification-generic","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the related notified resource","format":"uuid","example":"1bbc14c3-8ca8-492c-887d-1ca86400e4fa"},"key":{"type":"string","description":"Merchant identification key","example":"Example Key"},"type":{"type":"string","example":"capture","enum":["authorisation","capture","frequent_create","void","refund","chargeback","subscription_create","subscription_capture","out_payment"]},"status":{"type":"string","example":"success","enum":["failed","success"]},"messages":{"type":"array","items":{"type":"string","example":"Your request was successfully created"}},"date":{"type":"string","example":"2022-01-01 10:20:30"}}}},"components/schemas/notification-authorisation":{"id":"components/schemas/notification-authorisation","kind":"json-schema","title":"notification-authorisation","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the notification","example":"131d25c8-404d-4075-a264-67091620b0b3"},"value":{"type":"string","description":"The monetary amount","example":"10.5"},"currency":{"type":"string","description":"ISO 4217 currency code","example":"EUR"},"key":{"type":"string","description":"Merchant identification key","example":"Example Key"},"expiration_time":{"type":"string","format":"date-time","description":"The expiration time for the payment","example":"2025-12-26T10:32:45Z"},"method":{"type":"string","description":"Payment method used","example":"MBW"},"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"00ef522f-6a34-4d03-8448-834830cabb91"},"name":{"type":"string","example":"Josefa Gomes"},"email":{"type":"string","format":"email","example":"customer@example.com"},"phone":{"type":"string","example":"921234567"},"phone_indicative":{"type":"string","example":"+351"},"fiscal_number":{"type":"string","example":"PT123456789"},"key":{"type":"string","example":"Customer Key"}}},"account":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"131d25c8-404d-4075-a264-67091620b066"}}},"authorisation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"131d25c8-404d-4075-a264-67091620b0b3"}}}}}},"components/schemas/notification-capture":{"id":"components/schemas/notification-capture","kind":"json-schema","title":"notification-capture","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the notification","example":"ad3a0bb3-15a0-462c-8049-4abeb2e11f11"},"value":{"type":"string","description":"The monetary amount","example":"10.5"},"currency":{"type":"string","description":"ISO 4217 currency code","example":"EUR"},"key":{"type":"string","description":"Merchant identification key","example":"Example Key"},"expiration_time":{"type":"string","format":"date-time","description":"The expiration time for the payment","example":"2025-12-26T10:32:45Z"},"method":{"type":"string","description":"Payment method used","example":"MBW"},"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"4a908674-3bfb-47e5-b518-052a5e14b8fb"},"name":{"type":"string","example":"Josefa Gomes"},"email":{"type":"string","format":"email","example":"customer@example.com"},"phone":{"type":"string","example":"911234567"},"phone_indicative":{"type":"string","example":"+351"},"fiscal_number":{"type":"string","example":"PT123456789"},"key":{"type":"string","example":"Customer Key"}}},"account":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"3ab50128-567c-4624-9268-04c5899ffb66"}}},"transaction":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"3ab50128-567c-4624-9268-04c5899ffb60"},"key":{"type":"string","example":"Transaction_key"},"type":{"type":"string","example":"capture"},"date":{"type":"string","format":"date-time","example":"2025-12-26T10:32:45Z"},"transfer_date":{"type":"string","format":"date-time","example":"2025-12-29T00:00:00Z"},"document_number":{"type":"string","example":"MARCEL0208220658120320251226103247"},"values":{"type":"object","properties":{"requested":{"type":"string","example":"10.5"},"paid":{"type":"string","example":"10.5"},"fixed_fee":{"type":"string","example":"0.07"},"variable_fee":{"type":"string","example":"0.08"},"tax":{"type":"string","example":"0"},"transfer":{"type":"string","example":"10.5"}}}}}}}},"schema_210":{"kind":"json-schema","data":{"type":"integer","default":1,"example":1},"id":"schema_210"},"schema_211":{"kind":"json-schema","data":{"type":"integer","default":20,"example":20},"id":"schema_211"},"schema_212":{"kind":"json-schema","data":{"type":"string","enum":["sale","authorisation"],"example":"sale"},"id":"schema_212"},"schema_213":{"kind":"json-schema","data":{"type":"string","example":"interval(2006-01-02 15:04,2006-01-02 15:04)"},"id":"schema_213"},"schema_214":{"kind":"json-schema","data":{"type":"string","example":"MB","enum":["CC","VI","DD","MB","MBW","AP","GP"]},"id":"schema_214"},"schema_215":{"kind":"json-schema","data":{"type":"string","example":"01J32EDWGNX94XMWP8PWB23KBK"},"id":"schema_215"},"schema_216":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"bb3e7e60-20f3-4208-9b21-64c635a51f42"},"id":"schema_216"},"schema_217":{"kind":"json-schema","data":{"type":"string","example":"01J32EESEC1Z543P7J3PKSF1Q9"},"id":"schema_217"},"schema_218":{"kind":"json-schema","data":{"type":"number","format":"double","example":10.32},"id":"schema_218"},"schema_219":{"kind":"json-schema","data":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/meta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/single"}}}},"id":"schema_219"},"schema_220":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"array","items":{"type":"string"}}}},"id":"schema_220"},"schema_221":{"kind":"json-schema","data":{"type":"object","required":["value","method"],"properties":{"type":{"type":"string","enum":["sale","authorisation"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of financial operation being performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TYPE"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESCRIPTION"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sale"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a complete transaction where funds are immediately captured."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorisation"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a temporary hold on funds pending a future capture."},"children":[]}]}]}]}]}]}]},"capture":{"$ref":"#/components/schemas/create-capture"},"expiration_time":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last possible time to make the payment. Applicable in Multibanco payments. This field is deprecated, use multibanco.expiration_time instead."},"children":[]}]}]}],"example":"2017-12-12 16:05","deprecated":true},"currency":{"description":"ISO 4217 currency code. If not specified, the default currency is set to EUR.","type":"string","example":"EUR"},"value":{"type":"number","format":"double","example":17.5,"minimum":0.5,"maximum":999999.99,"description":"The monetary amount for the transaction. This field specifies the value of the payment in the designated currency. It must be a positive decimal number representing the exact amount to be processed."},"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enumerates the possible values for the payment method used in the transaction. This field helps to identify the selected payment method. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"METHOD"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESCRIPTION"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VI"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digital IBAN"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Debit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MB"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multibanco"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MBW"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MB WAY"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Pay*"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Pay*"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SW"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Samsung Wallet*"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IPP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In-Person Payment"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{"style":{"color":"red"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"*payment only available through checkout yet"},"children":[]}]}]}],"enum":["CC","VI","DD","MB","MBW","GP","AP","SW","IPP"],"examples":["CC"]},"terminal":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object that holds the details specific to the terminal used in the transaction. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IPP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["id"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the terminal.","example":"458b2fc4-3092-4de3-abd4-fe1600c09420"}}},"key":{"type":"string","maxLength":50,"description":"A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system.","example":"Payment of Invoice Nº 1982652"},"customer":{"$ref":"#/components/schemas/customer"},"multibanco":{"type":"object","description":"An object that holds the details specific to a Multibanco transaction.","required":["expiration_time"],"properties":{"expiration_time":{"type":"string","format":"date-time","description":"The end timestamp indicating the deadline by which the Multibanco Reference must be paid. It defines the final time within which the payment must be completed. The format follows RFC3339 (e.g., \"2024-06-30T21:38:31Z\")."},"start_time":{"type":"string","format":"date-time","description":"The starting timestamp indicating when the Multibanco Reference becomes valid for payment. It defines the initial time from which the payment can be made. The format follows RFC3339 (e.g., \"2024-06-30T21:38:31Z\"). This field is optional and defaults to the current timestamp if not specified, or if the sent value is in the past."},"product":{"type":"string","enum":["FILE","SPG","CHECKDIGIT"],"default":"CHECKDIGIT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to select the desired product. Below, the supported features for each product are listed. The default value is CHECKDIGIT. Additional costs may apply depending on the selected product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Features:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Immediate Issuance"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start Date"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHECKDIGIT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✓"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✓"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✗"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPG"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✗"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✓"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✓"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✗"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✓"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descriptions:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHECKDIGIT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Standard Multibanco references with immediate issuance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPG"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Special purpose group references with scheduling capabilities"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": File-based references for batch processing"},"children":[]}]}]}]}]}}},"mbway":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object that holds the details specific to an MB WAY transaction. Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MBW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; it is ignored for any other method."},"children":[]}]}]}],"properties":{"phone":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The phone number to charge for the MB WAY payment, in full E.164 format (leading "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and country code). When present, this number is charged instead of the one built from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer.phone_indicative"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer.phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer.phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes optional. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer.phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is left untouched."},"children":[]}]}]}],"example":"+351911234567"}}},"sdd_mandate":{"$ref":"#/components/schemas/sdd-mandate"},"notification":{"$ref":"#/components/schemas/notification"}}},"id":"schema_221"},"schema_222":{"kind":"json-schema","data":{"type":"object","x-examples":{"Example 1":{"status":"ok","message":["Your request was successfully created"],"id":"7120ac93-7a55-4fa5-a1e4-d7f8d2dc8738","method":{"type":"MBW","status":"success"},"customer":{"id":"6726cd0e-6503-46ec-90da-e01c3838a9e9"},"capture":{"id":"85c3503d-882b-4b4a-bb83-081946b57e56"}}},"properties":{"status":{"$ref":"#/components/schemas/response-status"},"message":{"$ref":"#/components/schemas/response-message"},"id":{"type":"string","format":"uuid","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"method":{"$ref":"#/components/schemas/method-on-post-response"},"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"}}},"capture":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"splits":{"type":"array","items":{"$ref":"#/components/schemas/capture-split-response"}},"reward_redemption":{"type":"object","description":"Reward credits redeemed in this payment.","properties":{"account":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/identifier"}]}},"required":["id"]},"value":{"type":"number","format":"double","description":"The redeemed reward amount.","example":5}}}}},"multibanco":{"$ref":"#/components/schemas/response-multibanco"},"notification":{"$ref":"#/components/schemas/notification"}}},"id":"schema_222"},"schema_223":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_223"},"schema_224":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/identifier"}]},"created_at":{"type":"string"},"captures":{"type":"array","items":{"$ref":"#/components/schemas/single-capture-full"}},"key":{"type":"string","example":"Payment of Invoice Nº 1982652"},"descriptive":{"$ref":"#/components/schemas/descriptive"},"value":{"$ref":"#/components/schemas/value"},"expiration_time":{"type":"string"},"currency":{"$ref":"#/components/schemas/currency"},"customer":{"$ref":"#/components/schemas/customer"},"method":{"$ref":"#/components/schemas/single-detail-method-response"},"paid_at":{"type":"string"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/payment-transactions"}},"payment_status":{"$ref":"#/components/schemas/single-payment-status"},"multibanco":{"$ref":"#/components/schemas/response-multibanco"},"terminal":{"$ref":"#/components/schemas/response-terminal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"method.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IPP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"notification":{"$ref":"#/components/schemas/notification"}}},"id":"schema_224"},"schema_225":{"kind":"json-schema","data":{"type":"object","properties":{"expiration_time":{"type":"string","deprecated":true},"currency":{"description":"ISO 4217 currency code. If not specified, the default currency is set to EUR.","type":"string","example":"EUR"},"customer":{"$ref":"#/components/schemas/updatable-customer"},"key":{"$ref":"#/components/schemas/key"},"sdd_mandate":{"$ref":"#/components/schemas/updatable-sdd-mandate"}}},"id":"schema_225"},"schema_226":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/identifier"},"message":{"$ref":"#/components/schemas/response-message"},"status":{"$ref":"#/components/schemas/response-status"},"method":{"$ref":"#/components/schemas/single-edit-method-response"},"customer":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/identifier"}}}}},"id":"schema_226"},"schema_227":{"kind":"json-schema","data":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/meta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/frequent"}}},"required":["meta","data"]},"id":"schema_227"},"schema_228":{"kind":"json-schema","data":{"type":"object","properties":{"expiration_time":{"type":"string","description":"Expiration date and time for the payment in YYYY-MM-DD HH:mm format","example":"2038-12-12 16:05"},"currency":{"type":"string","enum":["EUR","BRL"],"default":"EUR","description":"Currency code for the payment","example":"EUR"},"customer":{"$ref":"#/components/schemas/customer"},"key":{"type":"string","description":"The merchant's key for identifying the payment.","maxLength":50,"example":"Key Example"},"min_value":{"type":"number","format":"double","minimum":0.01,"description":"Minimum value allowed for transactions","example":10},"max_value":{"type":"number","format":"double","minimum":0.01,"description":"Maximum value allowed for transactions","example":25.5},"unlimited_payments":{"type":"boolean","default":true,"description":"Transactions will be unlimited, max or min value will be refreshed on each payment."},"method":{"type":"string","enum":["MB","CC","DD","MBW","VI"],"description":"Payment method type","example":"DD"},"sdd_mandate":{"$ref":"#/components/schemas/sdd-mandate"},"multibanco":{"type":"object","description":"Configuration of the Multibanco payment","properties":{"reference":{"type":"string","minLength":9,"maxLength":9,"pattern":"^[0-9]*$","example":"505237431","description":"This field controls which reference is going to be created. It's only available if you have an exclusive Multibanco entity."}},"required":["reference"]}},"required":["customer","method"]},"id":"schema_228"},"schema_229":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","description":"Status of the request","example":"ok"},"message":{"type":"array","items":{"type":"string","example":"Your request was successfully created"},"description":"Array of status messages"},"id":{"type":"string","format":"uuid","description":"Unique identifier for the created frequent payment","example":"86401037-1c8d-4cf3-9172-d0a29b17b9fd"},"method":{"type":"object","description":"Payment method details","properties":{"type":{"type":"string","enum":["MB","CC","DD","MBW","VI"],"description":"Payment method type","example":"CC"},"status":{"type":"string","enum":["waiting","pending","active","deleted","success"],"description":"Current status of the payment method","example":"waiting"},"entity":{"type":"string","description":"Entity identifier","example":"59126"},"reference":{"type":"string","description":"Payment reference","example":"810000618"},"url":{"type":"string","description":"Only returns if the payment is a Credit Card.","example":"https://cc.test.easypay.pt/start/980d4826-8574-4782-8450-18db150b7c26"},"iban":{"type":"string","description":"Only returns if the payment method is Visa Direct.","example":"PT50123400007000199799996"},"alias":{"type":"string","description":"Only returns if the payment method is MB WAY.","example":"6ac1c9c50be844858afdbc74eb74acbc"},"sdd_mandate":{"$ref":"#/components/schemas/sdd-mandate-response-on-detail"}}},"customer":{"type":"object","description":"Customer information","properties":{"id":{"type":"string","format":"uuid","description":"Customer unique identifier","example":"e7bb115b-3e59-441a-bdb4-60b0f066c2d0"}}}}},"id":"schema_229"},"schema_230":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","enum":["active","deleted"],"description":"Status of the frequent payment","example":"active"},"expiration_time":{"type":"string","format":"Y-m-d H:i","description":"Expiration date and time for the payment","example":"2017-12-12 16:05"},"currency":{"$ref":"#/components/schemas/currency"},"customer":{"$ref":"#/components/schemas/customer"},"key":{"type":"string","description":"The merchant's key for identifying the payment.","maxLength":50,"example":"Key Example"},"max_value":{"type":"number","format":"double","minimum":0.01,"description":"Maximum value allowed for transactions","example":25.5},"min_value":{"type":"number","format":"double","minimum":0.01,"description":"Minimum value allowed for transactions","example":10},"unlimited_payments":{"type":"boolean","default":true,"description":"Transactions will be unlimited, max or min value will be refreshed on each payment."},"sdd_mandate":{"$ref":"#/components/schemas/sdd-mandate"}}},"id":"schema_230"},"schema_231":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","description":"Status of the request","example":"ok"},"message":{"type":"array","items":{"type":"string","example":"Your request was successfully created"},"description":"Array of status messages"},"id":{"type":"string","format":"uuid","description":"Unique identifier for the frequent payment","example":"86401037-1c8d-4cf3-9172-d0a29b17b9fd"},"method":{"type":"object","description":"Payment method details","properties":{"type":{"type":"string","enum":["MB","CC","DD","MBW","VI"],"description":"Payment method type","example":"CC"},"status":{"type":"string","enum":["waiting","pending","active","deleted"],"description":"Current status of the payment method","example":"waiting"},"url":{"type":"string","description":"Only returns if the payment is a Credit Card.","example":"https://cc.test.easypay.pt/start/86401037-1c8d-4cf3-9172-d0a29b17b9fd"},"entity":{"type":"string","description":"Entity identifier","example":"59126"},"reference":{"type":"string","description":"Payment reference","example":"810000618"},"sdd_mandate":{"type":"object","description":"SDD mandate details for direct debit payments","properties":{"id":{"type":"string","example":"12345678901"},"iban":{"type":"string","example":"PT50002700000001234567833"},"key":{"type":"string","example":"Key Example"},"name":{"type":"string","example":"Name Example"},"email":{"type":"string","example":"customer@example.com"},"phone":{"type":"string","example":"911234567"},"account_holder":{"type":"string","example":"Acount Name Example"},"country_code":{"type":"string","example":"PT"},"max_num_debits":{"type":"string","example":"12"},"reference_adc":{"type":"string","example":"987654321123"}}}}},"customer":{"type":"object","description":"Customer information","properties":{"id":{"type":"string","format":"uuid","description":"Customer unique identifier","example":"e7bb115b-3e59-441a-bdb4-60b0f066c2d0"}}}}},"id":"schema_231"},"schema_232":{"kind":"json-schema","data":{"type":"object","properties":{"mbway_sdk":{"type":"object","description":"MB WAY SDK configuration for payment processing","deprecated":true,"properties":{"purchase_token":{"type":"string","description":"Purchase token for MB WAY SDK"},"initial_timestamp":{"type":"string","description":"Initial timestamp for the transaction","example":"2018-01-01 23:59:59"},"merchant_operation_id":{"type":"string","description":"unique-concatenation between client identifier and client operation id.","maxLength":20,"example":"TESTACCOUNT5436"},"payload":{"type":"string","description":"JSON payload for MB WAY SDK"}}},"transaction_key":{"type":"string","description":"Your internal key identifying this authorisation.","maxLength":255,"example":"transaction_key_123"},"force_3ds":{"type":"boolean","default":false,"description":"Whether or not you want to force the 3DS authentication."},"descriptive":{"type":"string","description":"This will appear in the bank statement/MB WAY application.","maxLength":255,"example":"Descriptive Example"},"value":{"type":"number","description":"Value will be rounded to 2 decimals.","format":"double","minimum":0.5,"example":10.5}},"required":["descriptive","value"]},"id":"schema_232"},"schema_233":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the authorization","example":"4c67e74b-a256-4e0a-965d-97bf5d01bd50"},"status":{"type":"string","description":"Status of the request","example":"ok"},"message":{"type":"array","items":{"type":"string","example":"Your request was successfully created"},"description":"Array of status messages"}}},"id":"schema_233"},"schema_234":{"kind":"json-schema","data":{"type":"number"},"id":"schema_234"},"schema_235":{"kind":"json-schema","data":{"type":"number","default":20},"id":"schema_235"},"schema_236":{"kind":"json-schema","data":{"type":"string"},"id":"schema_236"},"schema_237":{"kind":"json-schema","data":{"type":"string","example":"active"},"id":"schema_237"},"schema_238":{"kind":"json-schema","data":{"type":"string","example":"10.55"},"id":"schema_238"},"schema_239":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/subscription-response-on-list"}},"meta":{"$ref":"#/components/schemas/meta"}}},"id":"schema_239"},"schema_240":{"kind":"json-schema","data":{"type":"object","x-examples":{"example-1":{"frequent_id":"4c67e74b-a256-4e0a-965d-97bf5d01bd50","capture":{"transaction_key":"string","account":{"id":"22ea3cc9-424b-489a-91b7-8955f643dc93"},"descriptive":"Descriptive Example"},"expiration_time":"2017-12-12 16:05","currency":"EUR","customer":{"id":"22ea3cc9-424b-489a-91b7-8955f643dc93","name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","fiscal_number":"PT123456789","key":"Key Example","language":"PT"},"key":"Example Key","value":17.5,"frequency":"1D","max_captures":10,"start_time":"2017-12-12 16:05","failover":true,"capture_now":true,"retries":2,"method":"CC","sdd_mandate":{"id":"12345678901","iban":"PT50002700000001234567833","key":"Key Example","name":"Name Example","email":"customer@example.com","phone":"911234567","account_holder":"Acount Name Example","country_code":"PT","max_num_debits":"12"}}},"required":["value","frequency","start_time","method"],"properties":{"frequent_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only required to create a subscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from an active Frequent Payment."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some properties like"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sdd_mandate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are inherited by the subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"So it's not necessary to send them in the request creation."},"children":[]}]}]}],"type":"string","format":"uuid","example":"9234ef0f-b666-41cc-8ad2-5b54c1a84150"},"capture":{"type":"object","properties":{"transaction_key":{"type":"string","description":"The internal key used to identify this transaction in the merchant's database.","maxLength":50},"account":{"type":"object","description":"For multi-account clients.","properties":{"id":{"type":"string","description":"The uuid of the account.","format":"uuid"}}},"descriptive":{"type":"string","description":"The description of the capture. Will be displayed in the bank statement or in the MB WAY application.","maxLength":255}}},"expiration_time":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last possible time to make the payment."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_captures"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unlimited_payments"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set."},"children":[]}]}]}],"format":"Y-m-d H:i","example":"2037-12-12 16:05"},"currency":{"type":"string","description":"The currency code in ISO 4217 format (e.g., \"EUR\" for Euro). This field specifies the type of currency used in financial operation."},"customer":{"$ref":"#/components/schemas/customer"},"key":{"type":"string","description":"The merchant's key for identifying the payment.","maxLength":50,"example":"Example Key"},"value":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will be rounded to 2 decimals."},"children":[]}]}]}],"format":"double","minimum":0.5,"example":12.55},"frequency":{"$ref":"#/components/schemas/frequency"},"max_captures":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defining the total of cycles that will be charged."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiration_time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unlimited_payments"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set."},"children":[]}]}]}]},"unlimited_payments":{"type":"boolean","default":false,"description":"When this property is set, unlimited cycles will be charged until the subscription is inactivated or deleted."},"start_time":{"type":"string","example":"2027-01-11 16:05","description":"Defining the start of billing cycles.","format":"Y-m-d H:i"},"failover":{"type":"boolean","default":false,"description":"After all retries failed, the payment cycle can have another try with another single method."},"capture_now":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to schedule an immediate capture and schedule the second one for start_time."},"children":[]}]}]}],"default":false},"retries":{"type":"integer","default":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of tries for every cycle of payments."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of retries that can occur will be determined by the frequency that is selected."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a capture is unsuccessful for any reason, it will attempt to charge once more until the allotted number of attempts is reached."},"children":[]}]}]}]},"method":{"type":"string","example":"CC","enum":["CC","DD"],"description":"The payment methods."},"sdd_mandate":{"$ref":"#/components/schemas/sdd-mandate"}}},"id":"schema_240"},"schema_241":{"kind":"json-schema","data":{"type":"object","x-examples":{"example-1":{"status":"inactive","expiration_time":"2017-12-12 16:05","currency":"EUR","customer":{"id":"22ea3cc9-424b-489a-91b7-8955f643dc93","name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","fiscal_number":"PT123456789","key":"Key Example","language":"PT"},"key":"Example Key","value":17.5,"max_captures":10,"failover":true,"retries":2,"sdd_mandate":{"id":"12345678901","iban":"PT50002700000001234567833","key":"Key Example","name":"Name Example","email":"customer@example.com","phone":"911234567","account_holder":"Acount Name Example","country_code":"PT","max_num_debits":"12"}}},"properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Subscription Status."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When sets to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the next pending cycles will be deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When sets to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a new billing cycle will be schedule"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accordingly the new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Those properties are required to active a subscription."},"children":[]}]}]}]}],"enum":["active","inactive"],"example":"active"},"capture":{"type":"object","properties":{"transaction_key":{"type":"string","description":"The internal key used to identify this transaction in the merchant's database.","maxLength":50},"account":{"type":"object","description":"For multi-account clients.","properties":{"id":{"type":"string","description":"The uuid of the account.","format":"uuid"}}},"descriptive":{"type":"string","description":"The description of the capture. Will be displayed in the bank statement or in the MB WAY application.","maxLength":255}}},"expiration_time":{"type":"string","format":"Y-m-d H:i","example":"2039-12-12 16:05"},"currency":{"$ref":"#/components/schemas/currency"},"customer":{"$ref":"#/components/schemas/updatable-customer"},"key":{"type":"string","description":"The merchant's key for identifying the payment.","maxLength":50,"example":"Example Key"},"value":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will be rounded to 2 decimals."},"children":[]}]}]}],"format":"double","minimum":0.5,"example":12.55},"frequency":{"$ref":"#/components/schemas/frequency"},"max_captures":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defining the total of cycles that will be charged."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this property is set, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unlimited_payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be inactivated."},"children":[]}]}]}]},"unlimited_payments":{"type":"boolean","description":"When this property is set, unlimited cycles will be charged until the subscription is inactivated or deleted."},"start_time":{"type":"string","example":"2025-12-12 16:05","description":"Defining the start of billing cycles.","format":"Y-m-d H:i"},"failover":{"type":"boolean","default":false,"description":"After all retries failed, the payment cycle can have another try with another single method."},"retries":{"type":"integer","default":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of retries in each payment cycle."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chosen frequency will define the max number of possible retries."},"children":[]}]}]}]},"sdd_mandate":{"$ref":"#/components/schemas/sdd-mandate"}}},"id":"schema_241"},"schema_242":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","example":"ok"},"message":{"$ref":"#/components/schemas/subscription-response-on-detail"}}},"id":"schema_242"},"schema_243":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":50,"example":10},"id":"schema_243"},"schema_244":{"kind":"json-schema","data":{"type":"string","example":"lL_j7ilk7rc"},"id":"schema_244"},"schema_245":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["PENDING","PROCESSING","WAITING","SUCCESS","FAILED","RETRY","FAILOVER","DELETED"]},"example":["PENDING","FAILED"]},"id":"schema_245"},"schema_246":{"kind":"json-schema","data":{"type":"object","required":["data","metadata"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/cycle"}},"metadata":{"$ref":"#/components/schemas/metadata-cursor"}}},"id":"schema_246"},"schema_247":{"kind":"json-schema","data":{"type":"object","required":["value"],"properties":{"value":{"type":"number","format":"double","minimum":0.5,"example":10.5,"description":"Must have at most two decimal places."},"capture_at":{"type":"string","format":"Y-m-d H:i","example":"2037-12-12 09:00","description":"When to schedule the charge, in UTC. Must not be in the past. Omit to capture immediately."},"description":{"type":"string","maxLength":255,"example":"extra subscription charge","description":"Free-form text shown on the bank statement or in the MB WAY app."},"key":{"type":"string","maxLength":50,"example":"one-time-charge-key","description":"Your internal identifier for this charge. Useful for reconciliation on your side."}}},"id":"schema_247"},"schema_248":{"kind":"json-schema","data":{"type":"object","required":["value"],"properties":{"value":{"type":"number","format":"double","minimum":0.01,"maximum":999999.99,"example":99.99,"description":"New amount for the cycle, in euros. Must have at most two decimal places."}}},"id":"schema_248"},"schema_249":{"kind":"json-schema","data":{"type":"object","properties":{"clearing_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new date for the split to be cleared."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field must be in the future and no longer than 2 years from today."},"children":[]}]}]}],"example":"2006-01-02"}}},"id":"schema_249"},"schema_250":{"kind":"json-schema","data":{"type":"object","properties":{"X-Easypay-Code":{"type":"string","description":"A user defined code"}}},"id":"schema_250"},"schema_251":{"kind":"json-schema","data":{"type":"number","default":100},"id":"schema_251"},"schema_252":{"kind":"json-schema","data":{"type":"string","enum":["CP","RF","RV","FEE","SP","MAN","TB","OT","CB","OP","TF","RW","RR","RX"]},"id":"schema_252"},"schema_253":{"kind":"json-schema","data":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/metadata-cursor"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ledger-entry"}}}},"id":"schema_253"},"schema_254":{"kind":"json-schema","data":{"type":"object","properties":{}},"id":"schema_254"},"schema_255":{"kind":"json-schema","data":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/metadata-cursor"}}},"id":"schema_255"},"schema_256":{"kind":"json-schema","data":{"type":"object","properties":{"meta":{"type":"string"}}},"id":"schema_256"},"schema_257":{"kind":"json-schema","data":{"type":"string","format":"Y-m-d H:i"},"id":"schema_257"},"schema_258":{"kind":"json-schema","data":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/metadata-page"},"data":{"type":"array","items":{"$ref":"#/components/schemas/transaction-report-data"}}},"required":["meta"]},"id":"schema_258"},"schema_259":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["IN_TRANSIT","SUCCEEDED","FAILED"]},"example":["SUCCEEDED","FAILED"]},"id":"schema_259"},"schema_260":{"kind":"json-schema","data":{"type":"object","required":["data","metadata"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/settlement"}},"metadata":{"$ref":"#/components/schemas/metadata-cursor"}}},"id":"schema_260"},"schema_261":{"kind":"json-schema","data":{"type":"string","enum":["transfer","mb"]},"id":"schema_261"},"schema_262":{"kind":"json-schema","data":{"type":"string","enum":["normal","instant"]},"id":"schema_262"},"schema_263":{"kind":"json-schema","data":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/metadata-page"},"data":{"type":"array","items":{"$ref":"#/components/schemas/out-payment-response"}}}},"id":"schema_263"},"schema_264":{"kind":"json-schema","data":{"type":"object","required":["customer","value","out_account","method","timestamp"],"properties":{"customer":{"$ref":"#/components/schemas/customer"},"key":{"type":"string","description":"Merchant identification key","maxLength":50},"value":{"type":"number","minimum":0.5,"format":"double","description":"Value will be rounded to 2 decimals"},"type":{"type":"string","enum":["normal","instant"],"description":"Optional - only applicable to method transfer","default":"normal"},"schedule_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled date and time to execute the payment, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD HH:MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format (UTC, no timezone suffix)."},"children":[]}]}]}],"example":"2026-04-24 16:25"},"descriptive":{"type":"string","pattern":"^[a-zA-Z0-9 .,/+*$%]+$","maxLength":140,"description":"Description for the out payment."},"account":{"$ref":"#/components/schemas/account"},"out_account":{"$ref":"#/components/schemas/out-account"},"method":{"type":"string","default":"transfer","example":"transfer","enum":["transfer","mb"]},"timestamp":{"type":"string","description":"Unix timestamp UTC, must be no more than 1 minute before or after real time, if not the strong authentication signature will not be valid"}}},"id":"schema_264"},"schema_265":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","example":"ok"},"message":{"type":"array","items":{"type":"string","example":"Your request was successfully created"}},"id":{"type":"string","format":"uuid","description":"A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced."},"method":{"type":"object","properties":{"type":{"type":"string","enum":["normal","instant"]},"status":{"type":"string","example":"pending","enum":["pending","delayed","success","deleted"]}}},"customer":{"type":"object","description":"Customer associated with the out payment.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the customer."}}},"out_account":{"type":"object","description":"Destination SEPA bank account for the out payment.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the destination account."}}}}},"id":"schema_265"},"schema_266":{"kind":"json-schema","data":{"type":"object","properties":{"generic":{"type":"string","description":"URL for generic notification.","maxLength":255,"example":"https://www.easypay.pt/generic"},"authorisation":{"type":"string","description":"URL for authorisation notification.","maxLength":255,"example":"https://www.easypay.pt/authorisation"},"transaction":{"type":"string","description":"URL for transaction notification.","maxLength":255,"example":"https://www.easypay.pt/transaction"},"visa_fwd":{"type":"string","description":"URL for redirect clients on credit card forward.","maxLength":255,"example":"https://www.easypay.pt/visa_fwd"},"visa_detail":{"type":"string","description":"URL for credit card payment detail.","maxLength":255,"example":"https://www.easypay.pt/visa_detail"}}},"id":"schema_266"},"schema_267":{"kind":"json-schema","data":{"type":"object","required":["type","customer","communication_channels","payment"],"properties":{"expiration_time":{"type":"string","format":"date-time","description":"RFC3339 formatted time for the link expiration date.","example":"2026-06-10T09:27:55.339Z"},"type":{"$ref":"#/components/schemas/payment-types-request","description":"Specifies the type of payment being performed.\nPossible values are \"Single\" (One-time transactions that will let your customers pay an amount of money to you),\n\"Frequent\" (Are repeatable transactions of varying sums without the client having to enter their payment details again),\nand \"Subscription\" (periodic payments of the same amount of money, configured through Checkout or our Payments API)."},"customer":{"$ref":"#/components/schemas/customer-request","description":"The Customer object contains detailed information about the customer involved in the transaction."},"communication_channels":{"$ref":"#/components/schemas/communication-channels-request"},"payment":{"type":"object","description":"Payment object with the payment method, capture object and payment type object (Single, Frequent, Subscription).","required":["methods"],"properties":{"methods":{"$ref":"#/components/schemas/payment-methods-request"},"capture":{"$ref":"#/components/schemas/capture-request"},"single":{"$ref":"#/components/schemas/single-request"},"frequent":{"$ref":"#/components/schemas/frequent-request"},"subscription":{"$ref":"#/components/schemas/subscription-request"}}},"notification":{"$ref":"#/components/schemas/notification-request"}}},"id":"schema_267"},"schema_268":{"kind":"json-schema","data":{"type":"object","required":["metadata","data"],"properties":{"metadata":{"$ref":"#/components/schemas/metadata-cursor"},"data":{"type":"array","items":{"$ref":"#/components/schemas/link-get-response-object"},"readOnly":true}}},"id":"schema_268"},"schema_269":{"kind":"json-schema","data":{"type":"object","required":["expiration_time"],"properties":{"expiration_time":{"type":"string","format":"date-time","description":"RFC3339 formatted time for the link expiration date"}}},"id":"schema_269"},"schema_270":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"458b2fc4-3092-4de3-abd4-fe1600c09420"},"id":"schema_270"},"schema_271":{"kind":"json-schema","data":{"type":"string","enum":["REWARD","REDEMPTION","REWARD_EXPIRATION","REWARD_REVERSAL","REWARD_RESTORATION"],"example":"REWARD"},"id":"schema_271"},"schema_272":{"kind":"json-schema","data":{"type":"string","example":"interval(2026-01-01,2027-12-31)"},"id":"schema_272"},"schema_273":{"kind":"json-schema","data":{"type":"string","example":"interval(2026-01-01 00:00,2026-01-31 23:59)"},"id":"schema_273"},"schema_274":{"kind":"json-schema","data":{"type":"object","required":["metadata","data"],"properties":{"metadata":{"$ref":"#/components/schemas/metadata-cursor"},"data":{"type":"array","items":{"$ref":"#/components/schemas/reward-ledger-entry"},"readOnly":true}}},"id":"schema_274"},"schema_275":{"kind":"json-schema","data":{"type":"string","enum":["ACTIVE","INACTIVE"]},"id":"schema_275"},"schema_276":{"kind":"json-schema","data":{"type":"object","required":["metadata","data"],"properties":{"metadata":{"$ref":"#/components/schemas/metadata-cursor"},"data":{"type":"array","items":{"$ref":"#/components/schemas/terminal"},"readOnly":true}}},"id":"schema_276"},"schema_277":{"kind":"json-schema","data":{"type":"object","required":["serial_number","name","acquirer"],"properties":{"serial_number":{"type":"string","description":"The serial number of the terminal device. Unique per acquirer.","maxLength":255,"example":"123-456-789"},"name":{"type":"string","description":"The name of the terminal. Must be unique.","maxLength":255,"example":"Terminal Checkout 1"},"acquirer":{"type":"string","enum":["VERIFONE"],"description":"The acquirer associated with the terminal.","example":"VERIFONE"}}},"id":"schema_277"},"schema_278":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the terminal. Must be unique.","maxLength":255,"example":"Terminal Checkout 2"}}},"id":"schema_278"},"schema_279":{"kind":"json-schema","data":{"type":"object","properties":{"environment":{"type":"string","example":"sandbox"},"time":{"type":"string","format":"date-time","example":"2026-01-01T12:00:00Z"}}},"id":"schema_279"}},"exampleStore":{"paths/~1single/get/responses/200/content/application~1json/examples/List All":{"value":{"meta":{"page":{"current":0,"total":0},"records":{"total":0,"per_page":0},"links":{"first":"string","prev":"string","next":"string","last":"string"}},"data":[{"id":"c6056234-a3f9-42de-b944-3ed793fcb6bb","type":"sale","key":"Payment of Invoice Nº 1982652","descriptive":"Payment of Invoice Nº 1982652","expiration_time":"2024-06-30 21:38:31","customer":{"id":"1b4ca1cf-9a1a-415b-97bf-342c6ddcf9c1","name":"Joe*** Pri***","email":"Cam***@yahoo.com","phone":"936***098","phone_indicative":"+351","fiscal_number":"PT921***10","key":"subscription 01234589","language":"PT"},"method":{"type":"CC","status":"active","sdd_mandate":{"id":"50389142122","iban":"PT500027**XX7833","key":"SDD Mandate key","name":"Fre*** DD***","email":"Cam***@yahoo.com","phone":"911***567","account_holder":"Acc*** Exa***","country_code":"PT","max_num_debits":"12","billing_entity":"PT16103627"},"card_type":"VISA","last_four":"1234","expiration_date":"string","url":"https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a","alias":"string","entity":"11683","reference":"665876931","iban":"PT50000747199140461443823"},"currency":"EUR","value":15.32,"created_at":"2024-06-30 21:38:31","payment_status":"paid","multibanco":{"expiration_time":"2025-09-28T12:41:08Z","start_time":"2025-08-26T12:41:09Z","product":"SPG"}},{"id":"2f1a5d8c-4b2f-4f3a-9e49-5d0f8b4f2d91","type":"sale","key":"IPP payment","descriptive":"IPP payment","expiration_time":"2024-07-01 12:00:00","customer":{"id":"2a88e01f-53f6-4c2c-8cf9-9dd5bff1d7b4","name":"Mar*** Sil***","email":"mar***@example.com","phone":"912***345","phone_indicative":"+351","fiscal_number":"PT123***45","key":"store 123","language":"PT"},"method":{"type":"IPP","status":"active"},"currency":"EUR","value":45,"created_at":"2024-07-01 12:00:00","payment_status":"paid","terminal":{"id":"458b2fc4-3092-4de3-abd4-fe1600c09420"}}]},"key":"List All","summary":"List All","id":"paths/~1single/get/responses/200/content/application~1json/examples/List All"},"paths/~1single/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1single/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1single/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1single/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1single/get/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1single/get/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1single/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1single/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1single/post/requestBody/content/application~1json/examples/Multibanco":{"value":{"customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","key":"customer Key Example","language":"EN"},"key":"merchant identification key Example","value":15.5,"method":"MB","capture":{"descriptive":"transaction descriptive Example","transaction_key":"transaction key Example"},"notification":{"customer_method_instructions_email":true}},"key":"Multibanco","summary":"Multibanco","id":"paths/~1single/post/requestBody/content/application~1json/examples/Multibanco"},"paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product SPG":{"value":{"customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","key":"customer Key Example","language":"EN"},"key":"merchant identification key Example","value":15.5,"method":"MB","multibanco":{"product":"SPG","start_time":"2026-03-23T17:52:13Z","expiration_time":"2029-03-23T17:52:13Z"},"capture":{"descriptive":"transaction descriptive Example","transaction_key":"transaction key Example"},"notification":{"customer_method_instructions_email":true}},"key":"Multibanco with product SPG","summary":"Multibanco with product SPG","id":"paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product SPG"},"paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product FILE":{"value":{"customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","key":"customer Key Example"},"key":"merchant identification key Example","value":15.5,"method":"MB","multibanco":{"product":"FILE","start_time":"2026-03-23T17:52:13Z","expiration_time":"2029-03-23T17:52:13Z"},"capture":{"descriptive":"transaction descriptive Example","transaction_key":"transaction key Example"},"notification":{"customer_method_instructions_email":true}},"key":"Multibanco with product FILE","summary":"Multibanco with product FILE","id":"paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product FILE"},"paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product CHECKDIGIT":{"value":{"customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","key":"customer Key Example"},"key":"merchant identification key Example","value":15.5,"method":"MB","multibanco":{"product":"CHECKDIGIT","expiration_time":"2029-03-23T17:52:13Z"},"capture":{"descriptive":"transaction descriptive Example","transaction_key":"transaction key Example"},"notification":{"customer_method_instructions_email":true}},"key":"Multibanco with product CHECKDIGIT","summary":"Multibanco with product CHECKDIGIT","id":"paths/~1single/post/requestBody/content/application~1json/examples/Multibanco with product CHECKDIGIT"},"paths/~1single/post/requestBody/content/application~1json/examples/Direct Debit":{"value":{"customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","key":"customer Key Example"},"key":"merchant identification key Example","value":17.5,"method":"dd","sdd_mandate":{"iban":"PT50002700000001234567833","key":"Sdd mandate Key Example","name":"Customer name Example","email":"customer@example.com","phone":"911234567","account_holder":"acount holder name Example"},"capture":{"descriptive":"transaction descriptive Example","transaction_key":"transaction key Example"}},"key":"Direct Debit","summary":"Direct Debit","id":"paths/~1single/post/requestBody/content/application~1json/examples/Direct Debit"},"paths/~1single/post/requestBody/content/application~1json/examples/CC Authorisation":{"value":{"currency":"EUR","customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351"},"key":"Example Key","value":17.5,"type":"authorisation","method":"cc"},"key":"CC Authorisation","summary":"CC Authorisation","id":"paths/~1single/post/requestBody/content/application~1json/examples/CC Authorisation"},"paths/~1single/post/requestBody/content/application~1json/examples/CC Sale":{"value":{"currency":"EUR","customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351"},"key":"Example Key","value":17.5,"type":"sale","method":"cc","capture":{"descriptive":"string","transaction_key":"string"}},"key":"CC Sale","summary":"CC Sale","id":"paths/~1single/post/requestBody/content/application~1json/examples/CC Sale"},"paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Authorisation":{"value":{"currency":"EUR","customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351"},"key":"Example Key","value":17.5,"type":"authorisation","method":"mbw"},"key":"MB WAY Authorisation","summary":"MB WAY Authorisation","id":"paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Authorisation"},"paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Sale":{"value":{"currency":"EUR","customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351"},"key":"Example Key","value":17.5,"type":"sale","method":"mbw","capture":{"descriptive":"string","transaction_key":"string"}},"key":"MB WAY Sale","summary":"MB WAY Sale","id":"paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Sale"},"paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Sale with dedicated payer phone":{"value":{"currency":"EUR","customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351"},"mbway":{"phone":"+351922222222"},"key":"Example Key","value":17.5,"type":"sale","method":"MBW","capture":{"descriptive":"string","transaction_key":"string"}},"key":"MB WAY Sale with dedicated payer phone","summary":"MB WAY Sale with dedicated payer phone","id":"paths/~1single/post/requestBody/content/application~1json/examples/MB WAY Sale with dedicated payer phone"},"paths/~1single/post/requestBody/content/application~1json/examples/Virtual IBAN":{"value":{"customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","key":"customer Key Example","language":"EN"},"key":"merchant identification key Example","value":0.5,"method":"vi","capture":{"descriptive":"transaction descriptive Example","transaction_key":"transaction key Example"},"notification":{"customer_method_instructions_email":true}},"key":"Virtual IBAN","summary":"Virtual IBAN","id":"paths/~1single/post/requestBody/content/application~1json/examples/Virtual IBAN"},"paths/~1single/post/requestBody/content/application~1json/examples/Sale with Reward Redemption":{"value":{"customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","key":"customer Key Example"},"key":"merchant identification key Example","value":50,"method":"CC","capture":{"descriptive":"transaction descriptive Example","transaction_key":"transaction key Example","reward_redemption":{"account":{"id":"7e697e0c-c2bf-422a-9535-ab0b750bb832"},"value":2.5}}},"key":"Sale with Reward Redemption","summary":"Sale with Reward Redemption","id":"paths/~1single/post/requestBody/content/application~1json/examples/Sale with Reward Redemption"},"paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits and Rewards":{"value":{"customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","key":"customer Key Example"},"key":"merchant identification key Example","value":649.99,"method":"CC","capture":{"descriptive":"transaction descriptive Example","transaction_key":"808254-9734","splits":[{"split_key":"5d87a15c-dab6-441a-b9f6-ecd86171517e","split_descriptive":"product","account":{"id":"7e697e0c-c2bf-422a-9535-ab0b750bb832"},"margin_account":{"id":"b6f53027-0478-4728-9269-8bcc0f8088ea"},"margin_value":26.39,"reward":{"account":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"value":5},"value":649.99}]}},"key":"Sale with Splits and Rewards","summary":"Sale with Splits and Rewards","id":"paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits and Rewards"},"paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits":{"value":{"customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","key":"customer Key Example"},"key":"merchant identification key Example","value":649.99,"method":"CC","capture":{"descriptive":"transaction descriptive Example","transaction_key":"808254-9734","splits":[{"split_key":"5d87a15c-dab6-441a-b9f6-ecd86171517e","split_descriptive":"product","account":{"id":"7e697e0c-c2bf-422a-9535-ab0b750bb832"},"margin_account":{"id":"b6f53027-0478-4728-9269-8bcc0f8088ea"},"margin_value":26.39,"value":649.99}]}},"key":"Sale with Splits","summary":"Sale with Splits","id":"paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits"},"paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits and Reward Redemption":{"value":{"customer":{"id":"6726cd0e-6503-46ec-90da-e01c3838a9e9","name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","key":"customer Key Example"},"key":"merchant identification key Example","value":100,"method":"CC","capture":{"descriptive":"transaction descriptive Example","transaction_key":"808254-9734","reward_redemption":{"account":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"value":10},"splits":[{"split_key":"5d87a15c-dab6-441a-b9f6-ecd86171517e","split_descriptive":"Marketplace seller","account":{"id":"7e697e0c-c2bf-422a-9535-ab0b750bb832"},"margin_account":{"id":"b6f53027-0478-4728-9269-8bcc0f8088ea"},"margin_value":5,"value":70},{"split_descriptive":"Platform share","account":{"id":"c3d4e5f6-a1b2-7890-abcd-ef1234567890"},"value":20}]}},"key":"Sale with Splits and Reward Redemption","summary":"Sale with Splits and Reward Redemption","id":"paths/~1single/post/requestBody/content/application~1json/examples/Sale with Splits and Reward Redemption"},"paths/~1single/post/requestBody/content/application~1json/examples/IPP Sale":{"value":{"value":17.5,"method":"IPP","terminal":{"id":"458b2fc4-3092-4de3-abd4-fe1600c09420"},"capture":{"descriptive":"transaction descriptive Example","transaction_key":"transaction key Example"}},"key":"IPP Sale","summary":"IPP Sale","id":"paths/~1single/post/requestBody/content/application~1json/examples/IPP Sale"},"paths/~1single/post/responses/201/content/application~1json/examples/Created Direct Debit with success":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"ed7f8dac-0ea2-4846-8433-f5f8b0e70ed7","method":{"type":"DD","status":"pending","entity":"21098","reference":"503564027","sdd_mandate":{"id":"50356402710","billing_entity":"PT16103627","iban":"PT50002700000001234567833","key":"sdd mandate key","name":"Name Example","email":"customer@example.com","phone":"912997715","account_holder":"Account Name Example","country_code":"PT","max_num_debits":"1","reference_adc":"50356402710"}},"customer":{"id":"2544ce48-ccec-465e-9722-d42ccf0aa640"},"capture":{"id":"c6101a8b-b8c6-44a7-b128-bef8888e14d7"}},"key":"Created Direct Debit with success","summary":"Created Direct Debit with success","id":"paths/~1single/post/responses/201/content/application~1json/examples/Created Direct Debit with success"},"paths/~1single/post/responses/201/content/application~1json/examples/Created Digital IBAN with success":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"52a29de3-c337-4681-acc5-9e16a1bcbc76","method":{"type":"VI","status":"pending","iban":"PT50123400009900032909922"},"customer":{"id":"9d66ceba-8daf-4f9e-af59-747b0d196096"},"capture":{"id":"833259eb-343d-4f4d-aac8-4797a7b2bfe6"}},"key":"Created Digital IBAN with success","summary":"Created Digital IBAN with success","id":"paths/~1single/post/responses/201/content/application~1json/examples/Created Digital IBAN with success"},"paths/~1single/post/responses/201/content/application~1json/examples/Created Multibanco with success":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"e95dec61-fa63-461a-8e5b-ea42c4755bac","method":{"type":"MB","status":"pending","entity":"11683","reference":"663000450","expiration_date":"07/17"},"customer":{"id":"fba21a72-70fc-4e15-92e0-bcc967dfb750"},"capture":{"id":"2a2b6501-b3eb-4b88-8e43-beb3d348fef0"},"multibanco":{"product":"CHECKDIGIT","start_time":"2025-07-25T10:22:53Z","expiration_time":"2025-08-24T10:22:52Z"}},"key":"Created Multibanco with success","summary":"Created Multibanco with success","id":"paths/~1single/post/responses/201/content/application~1json/examples/Created Multibanco with success"},"paths/~1single/post/responses/201/content/application~1json/examples/Created Credit Card with success":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"66d50369-1e80-4a6e-8346-ae7bc7e88355","method":{"type":"CC","status":"pending","url":"https://cc.test.easypay.pt/v3/public/card-details/66d50369-1e80-4a6e-8346-ae7bc7e88355"},"customer":{"id":"b929f784-3cd3-4a6d-b712-4e9f17e7fa2f"},"capture":{"id":"15962a97-3c67-41bf-8db7-f8e0cddc16b5"}},"key":"Created Credit Card with success","summary":"Created Credit Card with success","id":"paths/~1single/post/responses/201/content/application~1json/examples/Created Credit Card with success"},"paths/~1single/post/responses/201/content/application~1json/examples/Created MB Way with success":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"1c21f592-e0a3-4da4-9bac-2c56069b807e","method":{"type":"MBW","status":"success"},"customer":{"id":"e162c103-ce92-4a55-b39a-38f72a77d899"},"capture":{"id":"ad0e3276-6ebc-48ee-bb27-9a2a39d8a986"}},"key":"Created MB Way with success","summary":"Created MB Way with success","id":"paths/~1single/post/responses/201/content/application~1json/examples/Created MB Way with success"},"paths/~1single/post/responses/201/content/application~1json/examples/Created MB WAY with dedicated payer phone":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"7b8f4c2d-51e6-4a0b-9c3f-8e2d61a5f470","method":{"type":"MBW","status":"success","mbway":{"phone":"+351922222222"}},"customer":{"id":"e162c103-ce92-4a55-b39a-38f72a77d899"},"capture":{"id":"ad0e3276-6ebc-48ee-bb27-9a2a39d8a986"}},"key":"Created MB WAY with dedicated payer phone","summary":"Created MB WAY with dedicated payer phone","id":"paths/~1single/post/responses/201/content/application~1json/examples/Created MB WAY with dedicated payer phone"},"paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Reward Redemption":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"5bf6b4cf-2d31-4a8d-ae51-1e9f1f0ad7de","method":{"type":"CC","status":"pending","url":"https://cc.test.easypay.pt/v3/public/card-details/5bf6b4cf-2d31-4a8d-ae51-1e9f1f0ad7de"},"customer":{"id":"6726cd0e-6503-46ec-90da-e01c3838a9e9"},"capture":{"id":"9c2a1f88-3b3a-4f0e-9f2f-6b6f1d5d2c11","reward_redemption":{"account":{"id":"7e697e0c-c2bf-422a-9535-ab0b750bb832"},"value":2.5}}},"key":"Created Sale with Reward Redemption","summary":"Created Sale with Reward Redemption","id":"paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Reward Redemption"},"paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits and Rewards":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"1f7d9b22-1f55-4c84-9c0e-2ef3e4d3a812","method":{"type":"CC","status":"pending","url":"https://cc.test.easypay.pt/v3/public/card-details/1f7d9b22-1f55-4c84-9c0e-2ef3e4d3a812"},"customer":{"id":"6726cd0e-6503-46ec-90da-e01c3838a9e9"},"capture":{"id":"73a51c29-9ae0-4f1a-8b34-2bb02c4e0a7d","splits":[{"id":"4a2c9e10-5f40-4f9a-9e3b-7d6f6c1d8c41","split_key":"5d87a15c-dab6-441a-b9f6-ecd86171517e","split_descriptive":"product","account":{"id":"7e697e0c-c2bf-422a-9535-ab0b750bb832"},"margin_account":{"id":"b6f53027-0478-4728-9269-8bcc0f8088ea"},"margin_value":26.39,"reward":{"account":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"value":5,"expiration_date":"2027-01-15"},"value":649.99,"status":"waiting"}]}},"key":"Created Sale with Splits and Rewards","summary":"Created Sale with Splits and Rewards","id":"paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits and Rewards"},"paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"8b6db0e1-12c4-4f5d-b6c2-9a30bb1ef0de","method":{"type":"CC","status":"pending","url":"https://cc.test.easypay.pt/v3/public/card-details/8b6db0e1-12c4-4f5d-b6c2-9a30bb1ef0de"},"customer":{"id":"6726cd0e-6503-46ec-90da-e01c3838a9e9"},"capture":{"id":"e2841fbd-7d36-4d1a-95a9-0e9a2c2f3a55","splits":[{"id":"0d3a4f87-1e22-4f6f-bf2e-9c5a3b8a6e10","split_key":"5d87a15c-dab6-441a-b9f6-ecd86171517e","split_descriptive":"product","account":{"id":"7e697e0c-c2bf-422a-9535-ab0b750bb832"},"margin_account":{"id":"b6f53027-0478-4728-9269-8bcc0f8088ea"},"margin_value":26.39,"value":649.99,"status":"waiting"}]}},"key":"Created Sale with Splits","summary":"Created Sale with Splits","id":"paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits"},"paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits and Reward Redemption":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"3a92e5c8-4a17-4d2e-9c1f-5e1a6b7c8d90","method":{"type":"CC","status":"pending","url":"https://cc.test.easypay.pt/v3/public/card-details/3a92e5c8-4a17-4d2e-9c1f-5e1a6b7c8d90"},"customer":{"id":"6726cd0e-6503-46ec-90da-e01c3838a9e9"},"capture":{"id":"7c3a1f4d-2b85-4f3a-a912-6e0f2d4b9c11","splits":[{"id":"9b1e3d4c-5a67-4f8e-9c2a-1d3e4f5a6b7c","split_key":"5d87a15c-dab6-441a-b9f6-ecd86171517e","split_descriptive":"Marketplace seller","account":{"id":"7e697e0c-c2bf-422a-9535-ab0b750bb832"},"margin_account":{"id":"b6f53027-0478-4728-9269-8bcc0f8088ea"},"margin_value":5,"value":70,"status":"waiting"},{"id":"2c4d6e8f-1a3b-4c5d-7e9f-0a1b2c3d4e5f","split_descriptive":"Platform share","account":{"id":"c3d4e5f6-a1b2-7890-abcd-ef1234567890"},"value":20,"status":"waiting"}],"reward_redemption":{"account":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"value":10}}},"key":"Created Sale with Splits and Reward Redemption","summary":"Created Sale with Splits and Reward Redemption","id":"paths/~1single/post/responses/201/content/application~1json/examples/Created Sale with Splits and Reward Redemption"},"paths/~1single/post/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1single/post/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1single/post/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1single/post/responses/404/content/application~1json/examples/Resource not found"},"paths/~1single/post/responses/409/content/application~1json/examples/conflict":{"value":{"status":"409","message":"Conflict - Resource already exists or state conflict","id":"00000000-0000-0000-0000-000000000000"},"key":"conflict","summary":"Resource conflict example","id":"paths/~1single/post/responses/409/content/application~1json/examples/conflict"},"paths/~1single/post/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1single/post/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1single/post/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1single/post/responses/500/content/application~1json/examples/Internal error"},"paths/~1single~1{id}/get/responses/200/content/application~1json/examples/IPP Payment":{"value":{"id":"2f1a5d8c-4b2f-4f3a-9e49-5d0f8b4f2d91","created_at":"2024-07-01 12:00:00","key":"IPP payment","descriptive":"IPP payment","value":45,"expiration_time":"2024-07-01 12:00:00","currency":"EUR","customer":{"id":"2a88e01f-53f6-4c2c-8cf9-9dd5bff1d7b4","name":"Mar*** Sil***","email":"mar***@example.com","phone":"912***345","phone_indicative":"+351","fiscal_number":"PT123***45","key":"store 123","language":"PT"},"method":{"type":"IPP","status":"active"},"paid_at":"2024-07-01 12:05:00","payment_status":"paid","terminal":{"id":"458b2fc4-3092-4de3-abd4-fe1600c09420"}},"key":"IPP Payment","summary":"IPP Payment","id":"paths/~1single~1{id}/get/responses/200/content/application~1json/examples/IPP Payment"},"paths/~1single~1{id}/get/responses/200/content/application~1json/examples/MB WAY with dedicated payer phone":{"value":{"id":"1c21f592-e0a3-4da4-9bac-2c56069b807e","created_at":"2024-07-01 12:00:00","key":"merchant identification key Example","descriptive":"transaction descriptive Example","value":17.5,"currency":"EUR","customer":{"id":"e162c103-ce92-4a55-b39a-38f72a77d899","name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351"},"method":{"type":"MBW","status":"active","mbway":{"phone":"+351922222222"}},"paid_at":"2024-07-01 12:05:00","payment_status":"paid"},"key":"MB WAY with dedicated payer phone","summary":"MB WAY with dedicated payer phone","id":"paths/~1single~1{id}/get/responses/200/content/application~1json/examples/MB WAY with dedicated payer phone"},"paths/~1single~1{id}/get/responses/200/content/application~1json/examples/Sale with Reward Redemption":{"value":{"id":"5bf6b4cf-2d31-4a8d-ae51-1e9f1f0ad7de","created_at":"2024-07-01 12:00:00","key":"merchant identification key Example","descriptive":"transaction descriptive Example","value":50,"currency":"EUR","customer":{"id":"6726cd0e-6503-46ec-90da-e01c3838a9e9","name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351"},"method":{"type":"CC","status":"active"},"captures":[{"id":"9c2a1f88-3b3a-4f0e-9f2f-6b6f1d5d2c11","status":"success","descriptive":"transaction descriptive Example","transaction_key":"transaction key Example","reward_redemption":{"account":{"id":"7e697e0c-c2bf-422a-9535-ab0b750bb832"},"value":2.5}}],"paid_at":"2024-07-01 12:05:00","payment_status":"paid"},"key":"Sale with Reward Redemption","summary":"Sale with Reward Redemption","id":"paths/~1single~1{id}/get/responses/200/content/application~1json/examples/Sale with Reward Redemption"},"paths/~1single~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1single~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1single~1{id}/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1single~1{id}/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1single~1{id}/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1single~1{id}/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1single~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1single~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1single~1{id}/delete/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1single~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"},"paths/~1single~1{id}/delete/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1single~1{id}/delete/responses/500/content/application~1json/examples/Internal error"},"paths/~1single~1{id}/patch/responses/200/content/application~1json/examples/Example 1":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"d4851c0a-66e2-4b34-9587-1e453ddcc650","method":{"type":"CC","status":"pending","url":"https://cc.easypay.pt/v3/public/card-details/d4851c0a-66e2-4b34-9587-1e453ddcc650"},"customer":{"id":"156de567-b17d-4591-a154-442c873b76c7"}},"key":"Example 1","summary":"Example 1","id":"paths/~1single~1{id}/patch/responses/200/content/application~1json/examples/Example 1"},"paths/~1single~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1single~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1single~1{id}/patch/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1single~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"},"paths/~1single~1{id}/patch/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1single~1{id}/patch/responses/500/content/application~1json/examples/Internal error"},"paths/~1frequent/get/responses/200/content/application~1json/examples/Response":{"value":{"meta":{"page":{"current":1,"total":2335},"records":{"total":4669,"per_page":2},"links":{"first":"?page=1","prev":"","next":"?page=2","last":"?page=2335"}},"data":[{"id":"ab2f2eb6-3655-4951-98ae-36367d5f3727","key":"Default Key","expiration_time":"2022-12-12T16:05:00Z","value":10,"customer":{"id":"06300032-5cbd-4393-b73d-9f4c9875270a","name":"***","email":"ema***@example.com","phone":"***","fiscal_number":"***","key":"Customer key","language":"PT"},"method":{"type":"CC","status":"waiting","url":"https://cc.test.easypay.pt/start/ab2f2eb6-3655-4951-98ae-36367d5f3727"},"currency":"EUR","max_value":20.55,"min_value":2.32,"unlimited_payments":false,"created_at":"2022-11-23 12:03:29"},{"id":"f15cee45-d5a5-469d-8cb2-79a6dcba977f","key":"Default Key","expiration_time":"2022-12-12T16:05:00Z","value":10,"customer":{"id":"48307582-91bc-4e15-a9f6-84633fbdd2c7","name":"***","email":"ema***@example.com","phone":"***","fiscal_number":"***","key":"Customer key","language":"PT"},"method":{"type":"DD","status":"active","sdd_mandate":{"id":"50124502381","billing_entity":"PT16103627","iban":"PT500027**XX7833","key":"Sdd Mandate key","name":"Fre*** DD***","email":"cus***@example.com","phone":"911***567","account_holder":"Acc*** Exa***","country_code":"PT","max_num_debits":"0"}},"currency":"EUR","max_value":20.55,"min_value":2.32,"unlimited_payments":false,"created_at":"2022-11-23 11:56:35"}]},"key":"Response","summary":"Response","id":"paths/~1frequent/get/responses/200/content/application~1json/examples/Response"},"paths/~1frequent/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1frequent/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1frequent/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1frequent/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1frequent/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1frequent/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment DD":{"value":{"expiration_time":"2038-12-12 16:05","currency":"EUR","customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"351","fiscal_number":"PT123456789","key":"Key Example","language":"PT"},"key":"Key Example","max_value":25.5,"min_value":10,"unlimited_payments":true,"method":"DD","sdd_mandate":{"iban":"PT50002700000001234567833","key":"Key Example","name":"Name Example","email":"customer@example.com","phone":"911234567","account_holder":"Acount Name Example","country_code":"PT","max_num_debits":"12"}},"key":"Create a Frequent Payment DD","summary":"Create a Frequent Payment DD","id":"paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment DD"},"paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment CC":{"value":{"expiration_time":"2038-12-12 16:05","currency":"EUR","customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"351","fiscal_number":"PT123456789","key":"Key Example","language":"PT"},"key":"Key Example","max_value":999.99,"min_value":10,"unlimited_payments":true,"method":"CC"},"key":"Create a Frequent Payment CC","summary":"Create a Frequent Payment CC","id":"paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment CC"},"paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment MBW":{"value":{"customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"351","fiscal_number":"PT123456789","key":"Key Example","language":"PT"},"key":"Key Example","max_value":999.99,"min_value":1,"unlimited_payments":true,"method":"MBW"},"key":"Create a Frequent Payment MBW","summary":"Create a Frequent Payment MBW","id":"paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment MBW"},"paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment MB":{"value":{"customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"351","fiscal_number":"PT123456789","key":"Key Example","language":"PT"},"key":"Key Example","max_value":999.99,"min_value":10,"method":"MB"},"key":"Create a Frequent Payment MB","summary":"Create a Frequent Payment MB","id":"paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment MB"},"paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment VI":{"value":{"key":"Key Example","max_value":999.99,"min_value":10,"method":"VI"},"key":"Create a Frequent Payment VI","summary":"Create a Frequent Payment VI","id":"paths/~1frequent/post/requestBody/content/application~1json/examples/Create a Frequent Payment VI"},"paths/~1frequent/post/responses/201/content/application~1json/examples/Response from CC method":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"cd90455e-4ab3-42cf-a91c-cfc6e3afa65a","method":{"type":"CC","status":"waiting","url":"https://cc.test.easypay.pt/v3/public/card-details/e388fe5a-5b9f-44b6-91b1-62e321a7dc4b"},"customer":{"id":"68d07e52-3e04-493f-aaeb-bffe7ddb81ee"}},"key":"Response from CC method","summary":"Response from CC method","id":"paths/~1frequent/post/responses/201/content/application~1json/examples/Response from CC method"},"paths/~1frequent/post/responses/201/content/application~1json/examples/Response from DD method":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"86401037-1c8d-4cf3-9172-d0a29b17b9fd","method":{"type":"DD","status":"active","sdd_mandate":{"id":"50389142122","iban":"PT50002700000001234567833","key":"Key Example","name":"John Doe","email":"john.doe@example.com","phone":"911345678","account_holder":"John Doe","country_code":"PT","max_num_debits":"12","billing_entity":"PT16103627","reference_adc":"987654321123"}},"customer":{"id":"e7bb115b-3e59-441a-bdb4-60b0f066c2d0"}},"key":"Response from DD method","summary":"Response from DD method","id":"paths/~1frequent/post/responses/201/content/application~1json/examples/Response from DD method"},"paths/~1frequent/post/responses/201/content/application~1json/examples/Response from MB method":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"076d8c3f-a198-4e06-b44c-9ed1e9ba021a","method":{"type":"MB","status":"waiting","entity":"21098","reference":"504273872"},"customer":{"id":"09a5c637-179b-4783-b6e7-849df5b4c341"}},"key":"Response from MB method","summary":"Response from MB method","id":"paths/~1frequent/post/responses/201/content/application~1json/examples/Response from MB method"},"paths/~1frequent/post/responses/201/content/application~1json/examples/Response from VI method":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"0f5480ab-7c7b-4f27-ae1a-1c170e6c5a3e","method":{"type":"VI","status":"pending","iban":"PT50123400007000199799996"},"customer":{"id":"2752241c-ca5b-4144-9d65-e825c58feeb5"}},"key":"Response from VI method","summary":"Response from VI method","id":"paths/~1frequent/post/responses/201/content/application~1json/examples/Response from VI method"},"paths/~1frequent/post/responses/201/content/application~1json/examples/Response from MBW method":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"fdf44408-3a39-4800-a9ef-521e648d69cc","method":{"type":"MBW","status":"success","alias":"6ac1c9c50be844858afdbc74eb74acbc"},"customer":{"id":"48b815dd-ce3e-489f-a378-09dc930bd3da"}},"key":"Response from MBW method","summary":"Response from MBW method","id":"paths/~1frequent/post/responses/201/content/application~1json/examples/Response from MBW method"},"paths/~1frequent/post/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1frequent/post/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1frequent/post/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1frequent/post/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1frequent/post/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1frequent/post/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1frequent/post/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1frequent/post/responses/500/content/application~1json/examples/Internal error"},"paths/~1frequent~1{id}/get/responses/200/content/application~1json/examples/Response":{"value":{"id":"ac1913a3-fd78-4822-8394-0a14f4169247","key":"Default Key","expiration_time":"2022-12-12T16:05:00Z","customer":{"id":"fdc4bc82-8e45-4597-b46d-51d3285cf935","name":"Robert Stuart","email":"email@example.com","phone":"911234567","key":"Customer key","language":"PT"},"method":{"type":"CC","status":"active","url":"https://cc.test.easypay.pt/start/ac1913a3-fd78-4822-8394-0a14f4169247","last_four":"0000","card_type":"VISA","expiration_date":"04/25"},"currency":"EUR","max_value":20,"min_value":2,"unlimited_payments":false,"created_at":"2022-11-23 13:16:58"},"key":"Response","summary":"Response","id":"paths/~1frequent~1{id}/get/responses/200/content/application~1json/examples/Response"},"paths/~1frequent~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1frequent~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1frequent~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1frequent~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1frequent~1{id}/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1frequent~1{id}/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1frequent~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1frequent~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1frequent~1{id}/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1frequent~1{id}/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1frequent~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1frequent~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1frequent~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1frequent~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1frequent~1{id}/delete/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1frequent~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"},"paths/~1frequent~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1frequent~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1frequent~1{id}/delete/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1frequent~1{id}/delete/responses/500/content/application~1json/examples/Internal error"},"paths/~1frequent~1{id}/patch/requestBody/content/application~1json/examples/Update frequent payment":{"value":{"status":"active","expiration_time":"2038-12-12 16:05","currency":"EUR","customer":{"id":"22ea3cc9-424b-489a-91b7-8955f643dc93","name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","fiscal_number":"PT123456789","key":"Key Example","language":"PT"},"key":"Example Key","max_value":20,"min_value":2,"unlimited_payments":false,"sdd_mandate":{"id":"12345678901","iban":"PT50002700000001234567833","key":"Key Example","name":"Name Example","email":"customer@example.com","phone":"911234567","account_holder":"Account Name Example","country_code":"PT","max_num_debits":"12"}},"key":"Update frequent payment","summary":"Update frequent payment","id":"paths/~1frequent~1{id}/patch/requestBody/content/application~1json/examples/Update frequent payment"},"paths/~1frequent~1{id}/patch/responses/200/content/application~1json/examples/Full Response":{"value":{"method":{"type":"DD","sdd_mandate":{"id":"12345678901","iban":"PT50002700000001234567833","key":"Key Example","name":"Name Example","email":"customer@example.com","phone":"911234567","account_holder":"Account Name Example","country_code":"PT","max_num_debits":"12","reference_adc":"987654321123"}},"status":"ok","message":["Your request was successfully created"]},"key":"Full Response","summary":"Full Response","id":"paths/~1frequent~1{id}/patch/responses/200/content/application~1json/examples/Full Response"},"paths/~1frequent~1{id}/patch/responses/200/content/application~1json/examples/Response from CC Method":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"86401037-1c8d-4cf3-9172-d0a29b17b9fd","method":{"type":"CC","status":"waiting","entity":"59126","reference":"810000618","url":"https://cc.test.easypay.pt/start/86401037-1c8d-4cf3-9172-d0a29b17b9fd"},"customer":{"id":"e7bb115b-3e59-441a-bdb4-60b0f066c2d0"}},"key":"Response from CC Method","summary":"Response from CC Method","id":"paths/~1frequent~1{id}/patch/responses/200/content/application~1json/examples/Response from CC Method"},"paths/~1frequent~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1frequent~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1frequent~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1frequent~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1frequent~1{id}/patch/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1frequent~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"},"paths/~1frequent~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1frequent~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1frequent~1{id}/patch/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1frequent~1{id}/patch/responses/500/content/application~1json/examples/Internal error"},"paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create MB WAY Frequent Authorisation":{"value":{"transaction_key":"string","descriptive":"Descriptive Example","value":17.5},"key":"Create MB WAY Frequent Authorisation","summary":"Create MB WAY Frequent Authorisation","id":"paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create MB WAY Frequent Authorisation"},"paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create CC Frequent Authorisation":{"value":{"transaction_key":"string","descriptive":"Descriptive Example","value":17.5},"key":"Create CC Frequent Authorisation","summary":"Create CC Frequent Authorisation","id":"paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create CC Frequent Authorisation"},"paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create CC Frequent Authorisation with 3DS authentication":{"value":{"transaction_key":"string","descriptive":"Descriptive Example","value":17.5,"force_3ds":true},"key":"Create CC Frequent Authorisation with 3DS authentication","summary":"Create CC Frequent Authorisation with 3DS authentication","id":"paths/~1frequent~1authorisation~1{id}/post/requestBody/content/application~1json/examples/Create CC Frequent Authorisation with 3DS authentication"},"paths/~1frequent~1authorisation~1{id}/post/responses/201/content/application~1json/examples/Response":{"value":{"id":"4c67e74b-a256-4e0a-965d-97bf5d01bd50","status":"ok","message":["Your request was successfully created"]},"key":"Response","summary":"Response","id":"paths/~1frequent~1authorisation~1{id}/post/responses/201/content/application~1json/examples/Response"},"paths/~1frequent~1authorisation~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1frequent~1authorisation~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1frequent~1authorisation~1{id}/post/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1frequent~1authorisation~1{id}/post/responses/404/content/application~1json/examples/Resource not found"},"paths/~1frequent~1authorisation~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1frequent~1authorisation~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1frequent~1authorisation~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1frequent~1authorisation~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1frequent~1authorisation~1{id}/post/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1frequent~1authorisation~1{id}/post/responses/500/content/application~1json/examples/Internal error"},"paths/~1subscription/get/responses/200/content/application~1json/examples/Success":{"value":{"data":[{"id":"458b2fc4-3092-4de3-abd4-fe1600c09420","key":"subscription 02536985","expiration_time":"2099-01-15 00:00","start_time":"2027-01-15 00:00","frequency":"1M","retries":2,"max_captures":12,"failover":false,"capture_now":true,"unlimited_payments":false,"customer":{"id":"e66c4f80-3dc6-11eb-b378-0242ac130002","name":"João Silva","email":"joao.silva@test.com","phone":"+351911234567","fiscal_number":"123456789","key":"customer_key_123"},"method":{"type":"CC","status":"active","url":"https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a"},"currency":"EUR","value":10.55,"created_at":"2025-08-05 13:44:29"}],"meta":{"page":{"current":2,"total":500},"records":{"total":60000,"per_page":20},"links":{"first":"?page=1","prev":"?page=2","next":"?page=4","last":"?page=5487"}}},"key":"Success","summary":"Success","description":"Success","id":"paths/~1subscription/get/responses/200/content/application~1json/examples/Success"},"paths/~1subscription/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1subscription/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1subscription/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1subscription/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a CC payment method":{"value":{"expiration_time":"2022-12-04 12:00","max_captures":2,"start_time":"2022-12-04 12:00","value":17.55,"frequency":"1D","method":"CC"},"key":"Create a Subscription with a CC payment method","summary":"Create a Subscription with a CC payment method","id":"paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a CC payment method"},"paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a DD payment method":{"value":{"max_captures":2,"start_time":"2022-12-04 12:00","value":17.5,"frequency":"1Y","method":"DD","sdd_mandate":{"iban":"PT50002700000001234567833","name":"Frequent Payment DD","email":"customer@example.com","phone":"911234567","account_holder":"Account Name Example","key":"Sdd Mandate key"}},"key":"Create a Subscription with a DD payment method","summary":"Create a Subscription with a DD payment method","id":"paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a DD payment method"},"paths/~1subscription/post/requestBody/content/application~1json/examples/Full filled example":{"value":{"frequent_id":"4c67e74b-a256-4e0a-965d-97bf5d01bd50","capture":{"transaction_key":"string","account":{"id":"22ea3cc9-424b-489a-91b7-8955f643dc93"},"descriptive":"Descriptive Example"},"expiration_time":"2017-12-12 16:05","currency":"EUR","customer":{"id":"22ea3cc9-424b-489a-91b7-8955f643dc93","name":"Customer Example","email":"customer@example.com","phone":"911234567","phone_indicative":"+351","fiscal_number":"PT123456789","key":"Key Example","language":"PT"},"key":"Example Key","value":17.5,"frequency":"1D","max_captures":10,"start_time":"2017-12-12 16:05","failover":true,"capture_now":true,"retries":2,"method":"CC","sdd_mandate":{"id":"12345678901","iban":"PT50002700000001234567833","key":"Key Example","name":"Name Example","email":"customer@example.com","phone":"911234567","account_holder":"Acount Name Example","country_code":"PT","max_num_debits":"12"}},"key":"Full filled example","summary":"Full filled example","id":"paths/~1subscription/post/requestBody/content/application~1json/examples/Full filled example"},"paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a Frequent Payment":{"value":{"frequent_id":"8f952787-4110-40e5-b1ee-f8f041cb9881","retries":2,"capture_now":true,"key":"Payment Key Key","max_captures":999,"start_time":"2025-08-05 10:25","expiration_time":"2099-12-25 23:25","value":10.99,"frequency":"1M","method":"DD"},"key":"Create a Subscription with a Frequent Payment","summary":"Create a Subscription with a Frequent Payment","id":"paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with a Frequent Payment"},"paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with unlimited payments":{"value":{"retries":2,"capture_now":true,"key":"Payment Key Key","start_time":"{{date}}","unlimited_payments":true,"value":10.99,"frequency":"1M","method":"CC"},"key":"Create a Subscription with unlimited payments","summary":"Create a Subscription with unlimited payments","id":"paths/~1subscription/post/requestBody/content/application~1json/examples/Create a Subscription with unlimited payments"},"paths/~1subscription/post/responses/201/content/application~1json/examples/Response from CC method":{"value":{"status":"ok","message":{"id":"458b2fc4-3092-4de3-abd4-fe1600c09420","key":"subscription 02536985","expiration_time":"2099-01-15 00:00","start_time":"2027-01-15 00:00","frequency":"1M","retries":2,"max_captures":12,"failover":false,"capture_now":true,"unlimited_payments":false,"customer":{"id":"e66c4f80-3dc6-11eb-b378-0242ac130002","name":"João Silva","email":"joao.silva@test.com","phone":"+351911234567","fiscal_number":"123456789","key":"customer_key_123","phone_indicators":{"country_calling_code":"+351","national_destination_code":"91","subscriber_number":"1234567"}},"method":{"type":"CC","status":"active","url":"https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a","last_four":"2222","card_type":"VISA","expiration_date":"07/29"},"transactions":[],"currency":"EUR","value":10.55,"created_at":"2025-08-05 13:44:29"}},"key":"Response from CC method","summary":"Response from CC method","description":"Success","id":"paths/~1subscription/post/responses/201/content/application~1json/examples/Response from CC method"},"paths/~1subscription/post/responses/201/content/application~1json/examples/Response from DD method":{"value":{"status":"ok","message":{"id":"458b2fc4-3092-4de3-abd4-fe1600c09420","key":"subscription 02536985","expiration_time":"2099-01-15 00:00","start_time":"2027-01-15 00:00","frequency":"1M","retries":2,"max_captures":12,"failover":false,"capture_now":true,"unlimited_payments":false,"customer":{"id":"e66c4f80-3dc6-11eb-b378-0242ac130002","name":"João Silva","email":"joao.silva@test.com","phone":"+351911234567","fiscal_number":"123456789","key":"customer_key_123","phone_indicators":{"country_calling_code":"+351","national_destination_code":"91","subscriber_number":"1234567"}},"method":{"type":"DD","status":"active","sdd_mandate":{"id":"50389142122","billing_entity":"PT16103627","iban":"PT50002700000001234567833","key":"Key Example","name":"John Doe","email":"john.doe@example.com","phone":"911345678","account_holder":"John Doe","country_code":"PT","max_num_debits":"12","reference_adc":"987654321123"}},"transactions":[],"currency":"EUR","value":10.55,"created_at":"2025-08-05 13:44:29"}},"key":"Response from DD method","summary":"Response from DD method","description":"Success","id":"paths/~1subscription/post/responses/201/content/application~1json/examples/Response from DD method"},"paths/~1subscription/post/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription/post/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription/post/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1subscription/post/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1subscription/post/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1subscription/post/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1subscription/post/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1subscription/post/responses/500/content/application~1json/examples/Internal error"},"paths/~1subscription~1{id}/get/responses/200/content/application~1json/examples/Success":{"value":{"id":"458b2fc4-3092-4de3-abd4-fe1600c09420","key":"subscription 02536985","expiration_time":"2099-01-15 00:00","start_time":"2027-01-15 00:00","frequency":"1M","retries":2,"max_captures":12,"failover":false,"capture_now":true,"unlimited_payments":false,"customer":{"id":"e66c4f80-3dc6-11eb-b378-0242ac130002","name":"João Silva","email":"joao.silva@test.com","phone":"+351911234567","fiscal_number":"123456789","key":"customer_key_123","phone_indicators":{"country_calling_code":"+351","national_destination_code":"91","subscriber_number":"1234567"}},"method":{"type":"CC","status":"active","url":"https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a","last_four":"2222","card_type":"VISA","expiration_date":"07/29"},"transactions":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","key":"payment 123456","status":"paid","date":"2025-08-05 13:44:29","currency":"EUR","value":10.55}],"currency":"EUR","value":10.55,"created_at":"2025-08-05 13:44:29"},"key":"Success","summary":"Success","description":"Success","id":"paths/~1subscription~1{id}/get/responses/200/content/application~1json/examples/Success"},"paths/~1subscription~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription~1{id}/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1subscription~1{id}/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1subscription~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1subscription~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1subscription~1{id}/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1subscription~1{id}/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1subscription~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription~1{id}/delete/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1subscription~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"},"paths/~1subscription~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1subscription~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1subscription~1{id}/delete/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1subscription~1{id}/delete/responses/500/content/application~1json/examples/Internal error"},"paths/~1subscription~1{id}/patch/requestBody/content/application~1json/examples/Full PATCH":{"value":{"capture":{"transaction_key":"Transaction Key","descriptive":"subscription"},"retries":2,"customer":{"email":"john.doe@example.com","key":"Customer Key","language":"PT"},"key":"Payment Key Key","max_captures":12,"start_time":"2025-08-06 11:07","expiration_time":"2099-08-06 11:07","value":10.99,"frequency":"1M","method":"DD","sdd_mandate":{"iban":"PT50002700000001234567833","name":"John Doe","email":"john.doe@example.com","phone":"911234567","account_holder":"John Doe","key":"SDD Mandate key","max_num_debits":"12"}},"key":"Full PATCH","summary":"Full PATCH","id":"paths/~1subscription~1{id}/patch/requestBody/content/application~1json/examples/Full PATCH"},"paths/~1subscription~1{id}/patch/requestBody/content/application~1json/examples/Example 1":{"value":{"status":"active","capture":{"transaction_key":"string","account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08"},"descriptive":"string"},"expiration_time":"2039-12-12 16:05","currency":"EUR","customer":{"name":"Jonh Doe","email":"user@example.com","phone":"962496235","phone_indicative":"351","fiscal_number":"PT277712580","key":"01J1PKR2RPHJNJQGFWGDYXY0KM","language":"PT"},"key":"Example Key","value":12.55,"frequency":"1D","max_captures":0,"unlimited_payments":true,"start_time":"2025-12-12 16:05","failover":false,"retries":0,"sdd_mandate":{"id":"c6056234-a3f9-42de-b944-3ed793fcb6bb","iban":"PT50000747199140461443823","key":"01J1PKR2RPHJNJQGFWGDYXY0KM","name":"string","email":"string","phone":"string","account_holder":"string","country_code":"string","max_num_debits":"string","billing_entity":"PT16103627"}},"key":"Example 1","summary":"Example 1","id":"paths/~1subscription~1{id}/patch/requestBody/content/application~1json/examples/Example 1"},"paths/~1subscription~1{id}/patch/responses/200/content/application~1json/examples/Success":{"value":{"status":"ok","message":{"id":"458b2fc4-3092-4de3-abd4-fe1600c09420","key":"subscription 02536985","expiration_time":"2099-01-15 00:00","start_time":"2027-01-15 00:00","frequency":"1M","retries":2,"max_captures":12,"failover":false,"capture_now":true,"unlimited_payments":false,"customer":{"id":"e66c4f80-3dc6-11eb-b378-0242ac130002","name":"João Silva","email":"joao.silva@test.com","phone":"+351911234567","fiscal_number":"123456789","key":"customer_key_123","phone_indicators":{"country_calling_code":"+351","national_destination_code":"91","subscriber_number":"1234567"}},"method":{"type":"CC","status":"active","url":"https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a","last_four":"2222","card_type":"VISA","expiration_date":"07/29"},"transactions":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","key":"payment 123456","status":"paid","date":"2025-08-05 13:44:29","currency":"EUR","value":10.55}],"currency":"EUR","value":10.55,"created_at":"2025-08-05 13:44:29"}},"key":"Success","summary":"Success","description":"Success","id":"paths/~1subscription~1{id}/patch/responses/200/content/application~1json/examples/Success"},"paths/~1subscription~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription~1{id}/patch/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1subscription~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"},"paths/~1subscription~1{id}/patch/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1subscription~1{id}/patch/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1subscription~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1subscription~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1subscription~1{id}/patch/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1subscription~1{id}/patch/responses/500/content/application~1json/examples/Internal error"},"paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/First page":{"value":{"data":[{"id":"550e8400-e29b-41d4-a716-446655440000","type":"RENEWABLE","status":"SUCCESS","value":10.5,"capture_at":"2026-05-22T09:00:00Z"},{"id":"2d3f4b8a-1c12-4e6f-9b7a-3f5d2e1c8a9b","type":"ONE_TIME_CHARGE","status":"PENDING","value":25,"capture_at":"2026-06-01T09:00:00Z","description":"add-on charge","key":"add-on-2026-06-01"}],"metadata":{"next_cursor":"lL_j7ilk7rc","count":2}},"key":"First page","summary":"First page of cycles with a next cursor","id":"paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/First page"},"paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/Last page":{"value":{"data":[{"id":"7a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d","type":"RENEWABLE","status":"SUCCESS","value":10.5,"capture_at":"2026-03-22T09:00:00Z"}],"metadata":{"next_cursor":"","count":1}},"key":"Last page","summary":"Final page — empty next_cursor signals no further results","id":"paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/Last page"},"paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/No cycles":{"value":{"data":[],"metadata":{"next_cursor":"","count":0}},"key":"No cycles","summary":"The subscription exists but has no cycles matching the filter","id":"paths/~1subscription~1{id}~1cycle/get/responses/200/content/application~1json/examples/No cycles"},"paths/~1subscription~1{id}~1cycle/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription~1{id}~1cycle/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription~1{id}~1cycle/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription~1{id}~1cycle/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription~1{id}~1cycle/get/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1subscription~1{id}~1cycle/get/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1subscription~1{id}~1cycle/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1subscription~1{id}~1cycle/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1subscription~1{id}~1cycle/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1subscription~1{id}~1cycle/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1subscription~1{id}~1cycle/post/requestBody/content/application~1json/examples/Capture now":{"value":{"value":10.5,"description":"extra subscription charge","key":"one-time-charge-key"},"key":"Capture now","summary":"Charge the subscription immediately","id":"paths/~1subscription~1{id}~1cycle/post/requestBody/content/application~1json/examples/Capture now"},"paths/~1subscription~1{id}~1cycle/post/requestBody/content/application~1json/examples/Schedule for later":{"value":{"value":25,"capture_at":"2037-12-12 09:00","description":"Add-on charge","key":"add-on-2037-12-12"},"key":"Schedule for later","summary":"Schedule the charge for a specific moment","id":"paths/~1subscription~1{id}~1cycle/post/requestBody/content/application~1json/examples/Schedule for later"},"paths/~1subscription~1{id}~1cycle/post/responses/201/content/application~1json/examples/One-time charge created":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"550e8400-e29b-41d4-a716-446655440000"},"key":"One-time charge created","summary":"A new cycle has been queued on the subscription","id":"paths/~1subscription~1{id}~1cycle/post/responses/201/content/application~1json/examples/One-time charge created"},"paths/~1subscription~1{id}~1cycle/post/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription~1{id}~1cycle/post/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription~1{id}~1cycle/post/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription~1{id}~1cycle/post/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription~1{id}~1cycle/post/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1subscription~1{id}~1cycle/post/responses/404/content/application~1json/examples/Resource not found"},"paths/~1subscription~1{id}~1cycle/post/responses/409/content/application~1json/examples/conflict":{"value":{"status":"409","message":"Conflict - Resource already exists or state conflict","id":"00000000-0000-0000-0000-000000000000"},"key":"conflict","summary":"Resource conflict example","id":"paths/~1subscription~1{id}~1cycle/post/responses/409/content/application~1json/examples/conflict"},"paths/~1subscription~1{id}~1cycle/post/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1subscription~1{id}~1cycle/post/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1subscription~1{id}~1cycle/post/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1subscription~1{id}~1cycle/post/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1subscription~1{id}~1cycle/post/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1subscription~1{id}~1cycle/post/responses/500/content/application~1json/examples/Internal error"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/200/content/application~1json/examples/Pending one-off charge":{"value":{"id":"550e8400-e29b-41d4-a716-446655440000","type":"ONE_TIME_CHARGE","status":"PENDING","value":10.5,"capture_at":"2026-05-22T09:00:00Z","description":"monthly charge","key":"my-key"},"key":"Pending one-off charge","summary":"A one-off cycle that has not been captured yet","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/200/content/application~1json/examples/Pending one-off charge"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/200/content/application~1json/examples/Successful renewal":{"value":{"id":"2d3f4b8a-1c12-4e6f-9b7a-3f5d2e1c8a9b","type":"RENEWABLE","status":"SUCCESS","value":25,"capture_at":"2026-04-01T08:00:00Z"},"key":"Successful renewal","summary":"A regular renewal cycle that has been captured","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/200/content/application~1json/examples/Successful renewal"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/requestBody/content/application~1json/examples/Update amount":{"value":{"value":99.99},"key":"Update amount","summary":"Override the cycle's charge value","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/requestBody/content/application~1json/examples/Update amount"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/200/content/application~1json/examples/Cycle updated":{"value":{"status":"ok","message":["Your request was successfully updated"],"id":"550e8400-e29b-41d4-a716-446655440000"},"key":"Cycle updated","summary":"The cycle's amount has been overridden","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/200/content/application~1json/examples/Cycle updated"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/404/content/application~1json/examples/Resource not found"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/409/content/application~1json/examples/conflict":{"value":{"status":"409","message":"Conflict - Resource already exists or state conflict","id":"00000000-0000-0000-0000-000000000000"},"key":"conflict","summary":"Resource conflict example","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/409/content/application~1json/examples/conflict"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1subscription~1{id}~1cycle~1{cycle_id}/patch/responses/500/content/application~1json/examples/Internal error"},"paths/~1capture/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1capture/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1capture/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1capture/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1capture/get/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1capture/get/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1capture/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1capture/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1capture/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1capture/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1capture~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1capture~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1capture~1{id}/post/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1capture~1{id}/post/responses/404/content/application~1json/examples/Resource not found"},"paths/~1capture~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1capture~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1capture~1{id}/post/responses/422/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Unprocessable Entity"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1capture~1{id}/post/responses/422/content/application~1json/examples/Rate limit exceeded"},"paths/~1capture~1{id}/post/responses/428/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value is required"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1capture~1{id}/post/responses/428/content/application~1json/examples/Domain constraint failed"},"paths/~1capture~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1capture~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1capture~1{id}/post/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1capture~1{id}/post/responses/500/content/application~1json/examples/Internal error"},"paths/~1capture~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1capture~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1capture~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1capture~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1capture~1{id}/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1capture~1{id}/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1capture~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1capture~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1capture~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1capture~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1capture~1{id}/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1capture~1{id}/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1capture~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1capture~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1capture~1{id}/delete/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1capture~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"},"paths/~1capture~1{id}/delete/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1capture~1{id}/delete/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1capture~1{id}/delete/responses/422/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Unprocessable Entity"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1capture~1{id}/delete/responses/422/content/application~1json/examples/Rate limit exceeded"},"paths/~1capture~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1capture~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1capture~1{id}/delete/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1capture~1{id}/delete/responses/500/content/application~1json/examples/Internal error"},"paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/428/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value is required"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/428/content/application~1json/examples/Domain constraint failed"},"paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1capture~1{capture-uuid}~1splits~1{capture-split-uuid}/patch/responses/500/content/application~1json/examples/Internal error"},"paths/~1authorisation~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1authorisation~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1authorisation~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1authorisation~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1authorisation~1{id}/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1authorisation~1{id}/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1authorisation~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1authorisation~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1authorisation~1{id}/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1authorisation~1{id}/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1void~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1void~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1void~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1void~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1void~1{id}/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1void~1{id}/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1void~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1void~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1void~1{id}/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1void~1{id}/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1void~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1void~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1void~1{id}/post/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1void~1{id}/post/responses/404/content/application~1json/examples/Resource not found"},"paths/~1void~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1void~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1void~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1void~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1void~1{id}/post/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1void~1{id}/post/responses/500/content/application~1json/examples/Internal error"},"paths/~1refund/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1refund/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1refund/get/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1refund/get/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1refund/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1refund/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund":{"value":{"transaction_key":"transaction key Example","value":17.5},"key":"Refund","summary":"Refund","id":"paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund"},"paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Total Revert":{"value":{"transaction_key":"transaction key Example","value":100,"revert":{"mode":"total"}},"key":"Refund with Total Revert","summary":"Refund with Total Revert","id":"paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Total Revert"},"paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Partial Revert":{"value":{"transaction_key":"transaction key Example","value":70,"revert":{"mode":"partial","splits":[{"id":"c6056234-a3f9-42de-b944-3ed793fcb6bb"}]}},"key":"Refund with Partial Revert","summary":"Refund with Partial Revert","id":"paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Partial Revert"},"paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Partial Revert and Reward Redemption Reversal":{"value":{"transaction_key":"transaction key Example","value":70,"revert":{"mode":"partial","reward_redemption_reversal":7,"splits":[{"id":"c6056234-a3f9-42de-b944-3ed793fcb6bb"}]}},"key":"Refund with Partial Revert and Reward Redemption Reversal","summary":"Refund with Partial Revert and Reward Redemption Reversal","id":"paths/~1refund~1{id}/post/requestBody/content/application~1json/examples/Refund with Partial Revert and Reward Redemption Reversal"},"paths/~1refund~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1refund~1{id}/post/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1refund~1{id}/post/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1refund~1{id}/post/responses/404/content/application~1json/examples/Resource not found"},"paths/~1refund~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1refund~1{id}/post/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1refund~1{id}/post/responses/422/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Unprocessable Entity"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1refund~1{id}/post/responses/422/content/application~1json/examples/Rate limit exceeded"},"paths/~1refund~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1refund~1{id}/post/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1refund~1{id}/post/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1refund~1{id}/post/responses/500/content/application~1json/examples/Internal error"},"paths/~1refund~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1refund~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1refund~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1refund~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1refund~1{id}/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1refund~1{id}/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1refund~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1refund~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1refund~1{id}/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1refund~1{id}/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1chargeback/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1chargeback/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1chargeback/get/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1chargeback/get/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1chargeback/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1chargeback/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1chargeback~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1chargeback~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1chargeback~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1chargeback~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1chargeback~1{id}/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1chargeback~1{id}/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1chargeback~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1chargeback~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1chargeback~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1chargeback~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1chargeback~1{id}/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1chargeback~1{id}/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1report~1ledger/get/responses/200/content/application~1json/examples/Example 1":{"value":{"metadata":{"next_cursor":"lL_j7ilk7rc","count":10},"data":[{"id":"dc0f1e47-4510-4058-8119-31b8f80b5a02","created_at":"2019-08-24T14:15:22Z","transaction_timestamp":"2019-08-24T14:15:22Z","transaction_type":"CP","amount_details":{"requested_amount":{"amount":"13.5","currency":"EUR"},"payed_amount":{"amount":"13.5","currency":"EUR"},"fixed_fee":{"amount":"0.07","currency":"EUR"},"variable_fee":{"amount":"0.1","currency":"EUR"},"tax_amount":{"amount":"0.04","currency":"EUR"},"transfered_amount":{"amount":"13.29","currency":"EUR"}},"transfer_batch_date":"2019-08-24","transfer_batch":"string","descriptive":"some descriptive","details":{"operation_id":"79921588-12fb-44c8-87c2-207362a8e467","operation_key":"transaction key associated with operation","method":"MBW","payment_id":"1717d252-7a25-43e9-a272-f1ae07a0f2d7","payment_type":"single","payment_key":"Merchant identification key associated with payment"}},{"id":"5b8a2d1f-9c3e-4f6a-8b7d-2e4c6a8f0d13","created_at":"2019-08-24T14:15:22Z","transaction_timestamp":"2019-08-24T14:15:22Z","transaction_type":"RW","amount_details":{"requested_amount":{"amount":"0.68","currency":"EUR"},"payed_amount":{"amount":"0.68","currency":"EUR"}},"descriptive":"reward earned on capture","details":{"operation_id":"79921588-12fb-44c8-87c2-207362a8e467","operation_key":"transaction key associated with operation","method":"MBW","payment_id":"1717d252-7a25-43e9-a272-f1ae07a0f2d7","payment_type":"single","payment_key":"Merchant identification key associated with payment"}},{"id":"9d4f7c2a-1e8b-4a5c-b3f6-7c9e1a3d5f28","created_at":"2019-08-30T10:02:47Z","transaction_timestamp":"2019-08-30T10:02:47Z","transaction_type":"RR","amount_details":{"requested_amount":{"amount":"1.50","currency":"EUR"},"payed_amount":{"amount":"1.50","currency":"EUR"}},"descriptive":"reward credits redeemed on capture","details":{"operation_id":"3c1f9a6e-5d2b-48e7-a9c4-8b0d2f6e4a91","operation_key":"transaction key associated with operation","method":"CC","payment_id":"84f0b3c7-2a9d-4e16-b5c8-1d7f3a9e6b42","payment_type":"single","payment_key":"Merchant identification key associated with payment"}},{"id":"2f8e6b4d-9a1c-4e7f-8d3b-5c0a7e9f1b64","created_at":"2019-09-15T00:05:00Z","transaction_timestamp":"2019-09-15T00:05:00Z","transaction_type":"RX","amount_details":{"requested_amount":{"amount":"0.30","currency":"EUR"},"payed_amount":{"amount":"0.30","currency":"EUR"}},"descriptive":"expired reward credits paid out"}]},"key":"Example 1","summary":"Example 1","id":"paths/~1report~1ledger/get/responses/200/content/application~1json/examples/Example 1"},"paths/~1report~1ledger/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1report~1ledger/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1report~1ledger/get/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1report~1ledger/get/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1report~1ledger/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1report~1ledger/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1report~1transactions/get/responses/200/content/application~1json/examples/Response":{"value":{"meta":{"page":{"current":1,"total":47},"records":{"total":231,"per_page":5},"links":{"first":"?page=1","prev":"","next":"?page=2","last":"?page=47"}},"data":[{"id":"b41921f1-a255-41bc-9e92-9a28d266d378","key":"Merchant identification key","date":"2022-11-16T16:45:19Z","created_at":"2022-11-16T16:45:19Z","values":{"requested":44,"paid":44,"fixed_fee":0.25,"variable_fee":0.66,"tax":1.5,"transfer":42.88},"transfer_date":"2022-11-21T00:00:00Z","transfer_batch":"","method":"DD","document_number":"MARCEL0208220452011220221116164519","payment_type":"single","payment_id":"2a9112fe-6510-4366-b55e-24a3ae188d67","payment_account":{"id":"76f190b9-2b8a-4bd0-9490-411241a9dc81"},"payment_key":"Merchant identification key","payment_transaction_key":"Merchant identification key","descriptive":"Descriptive Josefa"},{"id":"b3fad7da-69bf-4320-b3ad-ccfaecaf8d16","key":"Robertos Key","date":"2022-11-16T11:46:58Z","values":{"requested":100,"paid":100,"fixed_fee":0,"variable_fee":0,"tax":0,"transfer":100},"transfer_date":"2022-11-18T00:00:00Z","transfer_batch":"","method":"MBW","document_number":"MARCEL0208220451979520221116114658","payment_type":"single","payment_id":"0cccc05d-1964-4648-a32b-fe7107746881","payment_account":{"id":"76f190b9-2b8a-4bd0-9490-411241a9dc81"},"payment_key":"Robertos Key","payment_transaction_key":"","descriptive":"Description of Roberto"},{"id":"65196366-3afe-45b6-be79-0f1025c9e2d5","key":"Merchant identification key","date":"2022-11-15T10:06:19Z","values":{"requested":44,"paid":44,"fixed_fee":0.25,"variable_fee":0.66,"tax":1.5,"transfer":42.88},"transfer_date":"2022-11-17T00:00:00Z","transfer_batch":"","method":"DD","document_number":"MARCEL0208220451822420221115100619","payment_type":"single","payment_id":"8798e233-43c8-4a73-8e24-e440a083b157","payment_account":{"id":"76f190b9-2b8a-4bd0-9490-411241a9dc81"},"payment_key":"Merchant identification key","payment_transaction_key":"Merchant identification key","descriptive":"Descriptive Josefa"},{"id":"a03c6452-ae7a-4495-993d-b6608d999edb","key":"Merchant identification key","date":"2022-11-15T10:06:19Z","values":{"requested":44,"paid":44,"fixed_fee":0.25,"variable_fee":0.66,"tax":1.5,"transfer":42.88},"transfer_date":"2022-11-17T00:00:00Z","transfer_batch":"","method":"DD","document_number":"MARCEL0208220451822320221115100619","payment_type":"single","payment_id":"b81d392b-b0d0-47ae-b76a-94ded2de404b","payment_account":{"id":"76f190b9-2b8a-4bd0-9490-411241a9dc81"},"payment_key":"Merchant identification key","payment_transaction_key":"Merchant identification key","descriptive":"Descriptive Josefa"},{"id":"5b145b82-8ff1-4caf-bb5e-f72dccfff376","key":"Merchant identification key","date":"2022-11-15T10:06:19Z","values":{"requested":44,"paid":44,"fixed_fee":0.25,"variable_fee":0.66,"tax":1.5,"transfer":42.88},"transfer_date":"2022-11-17T00:00:00Z","transfer_batch":"","method":"DD","document_number":"MARCEL0208220451822220221115100619","payment_type":"single","payment_id":"e605e589-ccf8-4739-8fdb-8502a609bda4","payment_account":{"id":"76f190b9-2b8a-4bd0-9490-411241a9dc81"},"payment_key":"Merchant identification key","payment_transaction_key":"Merchant identification key","descriptive":"Descriptive Josefa"}]},"key":"Response","summary":"Response","id":"paths/~1report~1transactions/get/responses/200/content/application~1json/examples/Response"},"paths/~1report~1transactions/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1report~1transactions/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1report~1transactions/get/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1report~1transactions/get/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1report~1transactions/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1report~1transactions/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1settlement/get/responses/200/content/application~1json/examples/First page":{"value":{"data":[{"id":"f6a7b8c9-d0e1-2345-fabc-456789012306","created_at":"2026-02-05T09:30:00Z","updated_at":null,"name":"1006","description":"EASYPAY-6-8895-1006-CIN002","status":"IN_TRANSIT","total_amount":{"currency":"EUR","amount":"99.99"},"number_of_items":2,"destination":{"type":"IBAN","details":{"iban":"PT50000201236666666666666"}}}],"metadata":{"next_cursor":"lL_j7ilk7rc","count":1}},"key":"First page","summary":"First page of settlements with a next cursor","id":"paths/~1settlement/get/responses/200/content/application~1json/examples/First page"},"paths/~1settlement/get/responses/200/content/application~1json/examples/Last page":{"value":{"data":[{"id":"e5f6a7b8-c9d0-1234-efab-345678901205","created_at":"2026-02-01T11:00:00Z","updated_at":null,"name":"1005","description":"EASYPAY-5-8895-1005-CIN002","status":"SUCCEEDED","total_amount":{"currency":"EUR","amount":"320.75"},"number_of_items":7,"destination":{"type":"IBAN","details":{"iban":"PT50000201235555555555555"}}}],"metadata":{"next_cursor":"","count":1}},"key":"Last page","summary":"Final page — empty next_cursor signals no further results","id":"paths/~1settlement/get/responses/200/content/application~1json/examples/Last page"},"paths/~1settlement/get/responses/200/content/application~1json/examples/No settlements":{"value":{"data":[],"metadata":{"next_cursor":"","count":0}},"key":"No settlements","summary":"No settlements match the filter","id":"paths/~1settlement/get/responses/200/content/application~1json/examples/No settlements"},"paths/~1settlement/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1settlement/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1settlement/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1settlement/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1settlement/get/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1settlement/get/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1settlement/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1settlement/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1settlement/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1settlement/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1settlement~1{id}/get/responses/200/content/application~1json/examples/Settlement":{"value":{"id":"e5f6a7b8-c9d0-1234-efab-345678901205","created_at":"2026-02-01T11:00:00Z","updated_at":null,"name":"1005","description":"EASYPAY-5-8895-1005-CIN002","status":"SUCCEEDED","total_amount":{"currency":"EUR","amount":"320.75"},"number_of_items":7,"destination":{"type":"IBAN","details":{"iban":"PT50000201235555555555555"}}},"key":"Settlement","summary":"A succeeded settlement","id":"paths/~1settlement~1{id}/get/responses/200/content/application~1json/examples/Settlement"},"paths/~1settlement~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1settlement~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1settlement~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1settlement~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1settlement~1{id}/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1settlement~1{id}/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1settlement~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed":{"value":{"status":"error","message":["Min value can't be higher than max's"]},"key":"Domain constraint failed","summary":"Domain constraint failed","id":"paths/~1settlement~1{id}/get/responses/412/content/application~1json/examples/Domain constraint failed"},"paths/~1settlement~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1settlement~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1settlement~1{id}/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1settlement~1{id}/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1out_payment/get/responses/200/content/application~1json/examples/Response":{"value":{"meta":{"page":{"current":1,"total":0},"records":{"total":0,"per_page":1},"links":{"first":"?page=1","prev":"","next":"?page=2","last":"?page=0"}},"data":[{"id":"20efcd82-be96-4aa0-89a1-c6365633a72e","status":"success","type":"normal","method":"transfer","customer":{"id":"09dbe8e2-5703-401e-9adc-6317f67a4fd9"},"account":{"id":"76f190b9-2b8a-4bd0-9490-411241a9dc81"},"out_account":{"id":"bcd387ca-1835-4c95-9003-2da45f39e396"},"key":"","value":50,"schedule_at":"2022-09-15 20:28:58","transactions":[{"id":"20efcd82-be96-4aa0-89a1-c6365633a72e","key":"","date":"2022-09-15T21:28:58Z","values":{"requested":-50,"paid":-50,"fixed_fee":1,"variable_fee":0,"tax":0.23,"transfer":-51.23},"transfer_date":"2022-09-15T00:00:00Z","transfer_batch":"","method":"transfer","document_number":"MARCEL0208220435165820220915212858","descriptive":""}],"created_at":"2022-09-15 20:28:58","timestamp":""},{"id":"12f21a3c-52a6-4274-ad1e-5e774093f7dd","status":"success","type":"normal","method":"transfer","customer":{"id":"b586685e-4e56-472b-b469-9b365c62d223"},"account":{"id":"76f190b9-2b8a-4bd0-9490-411241a9dc81"},"out_account":{"id":"898d3a41-8013-4262-a432-0bd09e301dff"},"key":"","value":50,"schedule_at":"2022-09-16 08:03:25","transactions":[{"id":"12f21a3c-52a6-4274-ad1e-5e774093f7dd","key":"","date":"2022-09-16T09:03:27Z","values":{"requested":-50,"paid":-50,"fixed_fee":1,"variable_fee":0,"tax":0.23,"transfer":-51.23},"transfer_date":"2022-09-16T00:00:00Z","transfer_batch":"","method":"transfer","document_number":"MARCEL0208220435236620220916090327","descriptive":""}],"created_at":"2022-09-16 08:03:27","timestamp":""}]},"key":"Response","summary":"Response","id":"paths/~1out_payment/get/responses/200/content/application~1json/examples/Response"},"paths/~1out_payment/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1out_payment/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1out_payment/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1out_payment/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1out_payment/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1out_payment/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1out_payment/post/requestBody/content/application~1json/examples/Create with new customer":{"value":{"customer":{"name":"Customer Example","email":"user@example.com","phone":"911234567","phone_indicative":"+351","fiscal_number":"PT123456789","key":"Example Key","language":"PT"},"key":"Example Key","value":0.5,"type":"normal","schedule_at":"2026-04-24 16:25","descriptive":"Descriptive Example","out_account":{"account_holder":"Acount Name Example","iban":"PT50002700000001234567833","email":"customer@example.com","phone":"351911234567","key":"Key Example","country_code":"PT"},"method":"transfer","timestamp":"1696642539"},"key":"Create with new customer","summary":"Create with new customer","id":"paths/~1out_payment/post/requestBody/content/application~1json/examples/Create with new customer"},"paths/~1out_payment/post/responses/201/content/application~1json/examples/Example 1":{"value":{"status":"ok","message":["Your request was successfully created"],"id":"c6056234-a3f9-42de-b944-3ed793fcb6bb","method":{"type":"transfer","status":"pending"},"customer":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08"},"out_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}},"key":"Example 1","summary":"Example 1","id":"paths/~1out_payment/post/responses/201/content/application~1json/examples/Example 1"},"paths/~1out_payment/post/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1out_payment/post/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1out_payment/post/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1out_payment/post/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1out_payment/post/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1out_payment/post/responses/500/content/application~1json/examples/Internal error"},"paths/~1out_payment~1{id}/get/responses/200/content/application~1json/examples/Response":{"value":{"id":"760d105e-950d-4b41-8017-cad840ca3baa","status":"success","type":"normal","method":"transfer","descriptive":"descriptive","customer":{"id":"7e47c256-4bea-41a8-b578-727d60004c7a"},"account":{"id":"76f190b9-2b8a-4bd0-9490-411241a9dc81"},"out_account":{"id":"343a8a78-8deb-4d4a-aa41-0a9140c95346"},"key":"Example Key","value":1,"schedule_at":"2022-11-25 10:30:11","transactions":[{"id":"760d105e-950d-4b41-8017-cad840ca3baa","key":"Example Key","date":"2022-11-25T10:30:14Z","values":{"requested":-1,"paid":-1,"fixed_fee":1,"variable_fee":0,"tax":0.23,"transfer":-2.23},"transfer_date":"2022-11-25T00:00:00Z","transfer_batch":"","method":"transfer","document_number":"MARCEL0208220453362220221125103014","descriptive":""}],"created_at":"2022-11-25 10:30:14"},"key":"Response","summary":"Response","id":"paths/~1out_payment~1{id}/get/responses/200/content/application~1json/examples/Response"},"paths/~1out_payment~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1out_payment~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1out_payment~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1out_payment~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1out_payment~1{id}/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1out_payment~1{id}/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1out_payment~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1out_payment~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1out_payment~1{id}/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1out_payment~1{id}/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1out_payment~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1out_payment~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1out_payment~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1out_payment~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1out_payment~1{id}/delete/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1out_payment~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"},"paths/~1out_payment~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1out_payment~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1out_payment~1{id}/delete/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1out_payment~1{id}/delete/responses/500/content/application~1json/examples/Internal error"},"paths/~1config/get/responses/200/content/application~1json/examples/Response":{"value":{"generic":"https://www.easypay.pt/generic","authorisation":"https://www.easypay.pt/authorisation","transaction":"https://www.easypay.pt/transaction","visa_fwd":"https://www.easypay.pt/visa_fwd","visa_detail":"https://www.easypay.pt/visa_detail","account":"b2080452-bad1-4455-8ae7-9f5ea552a274","client_id":"EASYP030002","payment_methods":["MB"]},"key":"Response","summary":"Response","id":"paths/~1config/get/responses/200/content/application~1json/examples/Response"},"paths/~1config/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1config/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1config/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1config/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1config/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1config/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1config/patch/requestBody/content/application~1json/examples/Example 1":{"value":{"generic":"https://www.easypay.pt/generic","authorisation":"https://www.easypay.pt/authorisation","transaction":"https://www.easypay.pt/transaction","visa_fwd":"https://www.easypay.pt/visa_fwd","visa_detail":"https://www.easypay.pt/visa_detail"},"key":"Example 1","summary":"Example 1","id":"paths/~1config/patch/requestBody/content/application~1json/examples/Example 1"},"paths/~1config/patch/responses/200/content/application~1json/examples/Response":{"value":{"generic":"https://www.easypay.pt/generic","authorisation":"https://www.easypay.pt/authorisation","transaction":"https://www.easypay.pt/transaction","visa_fwd":"https://www.easypay.pt/visa_fwd","visa_detail":"https://www.easypay.pt/visa_detail","account":"b2080452-bad1-4455-8ae7-9f5ea552a274","client_id":"EASYP030002","payment_methods":["MB"]},"key":"Response","summary":"Response","id":"paths/~1config/patch/responses/200/content/application~1json/examples/Response"},"paths/~1config/patch/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1config/patch/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1config/patch/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1config/patch/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1config/patch/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1config/patch/responses/500/content/application~1json/examples/Internal error"},"paths/~1checkout~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1checkout~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1checkout~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1checkout~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1checkout~1{id}/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1checkout~1{id}/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1checkout~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1checkout~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1checkout~1{id}/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1checkout~1{id}/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1checkout~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1checkout~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1checkout~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1checkout~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1checkout~1{id}/delete/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1checkout~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"},"paths/~1checkout~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1checkout~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1checkout~1{id}/delete/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1checkout~1{id}/delete/responses/500/content/application~1json/examples/Internal error"},"paths/~1checkout/post/requestBody/content/application~1json/examples/Create Checkout":{"value":{"type":["single"],"payment":{"methods":["MB","CC","MBW","DD","VI","AP","GP","SW"],"type":"sale","capture":{"descriptive":"Descriptive Example"},"expiration_time":"2025-06-12 11:24","currency":"EUR","key":"Example Key","sdd_mandate":{"iban":"PT50002700000001234567833","name":"Name Example","email":"customer@example.com","phone":"911234567","account_holder":"Account Name Example"},"max_value":20,"min_value":2,"unlimited_payments":false,"frequency":"1W","max_captures":10,"start_time":"2025-06-12 11:24","failover":true,"capture_now":true,"retries":2,"multibanco":{"product":"SPG","start_time":"2025-07-25T10:22:53Z","expiration_time":"2025-08-24T10:22:52Z"}},"order":{"items":[{"description":"Item in Shopping Cart","quantity":2,"key":"Example Key","value":17.5}],"key":"Example Key","value":17.5},"customer":{"name":"Customer Example","email":"customer@example.com","phone":"911234567"}},"key":"Create Checkout","summary":"Create Checkout","id":"paths/~1checkout/post/requestBody/content/application~1json/examples/Create Checkout"},"paths/~1checkout/post/requestBody/content/application~1json/examples/Alternative Example":{"value":{"type":"single","payment":{"methods":["MBW"],"type":"sale","capture":{"transaction_key":"string","capture_date":"2026-05-15","account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08"},"splits":{"split_key":"01J1PKR2RPHJNJQGFWGDYXY0KM","split_descriptive":"Payment of Invoice Nº 1982652","value":15.32,"account":{"id":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"margin_value":0,"margin_account":{"id":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"clearing_period":"7D"},"descriptive":"Small description of the capture"},"expiration_time":"2027-12-12 16:05","currency":"EUR","key":"string","max_value":0.5,"min_value":0.5,"unlimited_payments":true,"frequency":"1D","max_captures":0,"start_time":"2019-08-24","failover":true,"capture_now":true,"retries":0,"multibanco":{"expiration_time":"string","start_time":"string","product":"CHECKDIGIT"}},"order":{"items":[{"description":"Description Example","quantity":2,"key":"Key Example","value":10.55}],"key":"Example Key","value":50.78},"customer":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"John Doe","email":"example@easypay.pt","phone":"911234567","phone_indicative":"+351","language":"EN","fiscal_number":"PT268826145","key":"Key Example"}},"key":"Alternative Example","summary":"Alternative Example","id":"paths/~1checkout/post/requestBody/content/application~1json/examples/Alternative Example"},"paths/~1checkout/post/responses/201/content/application~1json/examples/Create Checkout with Success":{"value":{"id":"10d3a41a-c9c4-486e-8da7-9490e5f097b7","session":"XkhRqoQtbBakUnjEJA4lYSCtboITWSb-ijxRMWKj7C9ormZ_4JubSB3qjy4XuORJFSrR0OsQ0ypE2Ws9Zl0N2REmR0CMNewH8ghyR1NBnPzDJ1AAuj9LvAhdv9SS-MXRh20_jmVz0MTcaD6E9WfHMiGSyej8eLMaE2hbSHn8DAO7kUSy8nzIIIUbR3pbpEpwxeO6fgHB3hdLGWrGUjeRq-Dq1Q_RF_ZWDPOGPwehXb3YRTatcjBG_2yoyGWWBaABOlkOx_uLaZIdrHMRXaDwLFDoN-eiu3BH1KKrut6pcE_Gc6laTf2AINBQIuSzKHLT4MFpTkrxdfPiD67w8aENm2HuzFc08I46KxdQG-2dSN522jZWDC2z4r4HFZ8LWVlDPuLbpui-WoWOJrJAnW3nPhyaKfUeu4KuU3BKYtJrtOoqs5ingkKWen0jm6AuFeZDeYRlRtj19S6d3P4q7Om3PVwil7c0K0brq31SmLHZdvsG_gHOPSZ6qrQy_95NZO0x934tBIUK91C1Bnm1Z9wA2Pp2hIeprOXMuZXkuanODro=","config":null},"key":"Create Checkout with Success","summary":"Create Checkout with Success","id":"paths/~1checkout/post/responses/201/content/application~1json/examples/Create Checkout with Success"},"paths/~1checkout/post/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1checkout/post/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1checkout/post/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1checkout/post/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1checkout/post/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1checkout/post/responses/404/content/application~1json/examples/Resource not found"},"paths/~1checkout/post/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1checkout/post/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1checkout/post/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1checkout/post/responses/500/content/application~1json/examples/Internal error"},"paths/~1link/post/requestBody/content/application~1json/examples/Create Single payment Pay-by-link with several payment methods and sms and email communication channel":{"value":{"type":"SINGLE","expiration_time":"2023-12-29T23:59:59.999Z","payment":{"single":{"requested_amount":"21.55"},"methods":["CC","MBW","MB","DD","VI","UF"],"capture":{"descriptive":"string","key":"string"}},"customer":{"name":"pedro barros","email":"barros@gmail.com","phone":"+351911234567","language":"PT"},"communication_channels":["SMS","EMAIL"],"notification":{"customer_method_instructions_email":true}},"key":"Create Single payment Pay-by-link with several payment methods and sms and email communication channel","summary":"Create Single payment Pay-by-link with several payment methods and sms and email communication channel","id":"paths/~1link/post/requestBody/content/application~1json/examples/Create Single payment Pay-by-link with several payment methods and sms and email communication channel"},"paths/~1link/post/requestBody/content/application~1json/examples/Create Single payment Pay-by-link with one payment method and no communication channel":{"value":{"type":"SINGLE","expiration_time":"2033-12-29T23:59:59.999Z","payment":{"single":{"requested_amount":"31.55"},"methods":["CC","MBW","MB","DD","VI","UF"],"capture":{"descriptive":"string","key":"string"}},"customer":{"name":"pedro barros","email":"barros@gmail.com","phone":"+351911234567","language":"PT"},"notification":{"customer_method_instructions_email":true}},"key":"Create Single payment Pay-by-link with one payment method and no communication channel","summary":"Create Single payment Pay-by-link with one payment method and no communication channel","id":"paths/~1link/post/requestBody/content/application~1json/examples/Create Single payment Pay-by-link with one payment method and no communication channel"},"paths/~1link/post/responses/400/content/application~1json/examples/Example 1":{"value":{"type":"https://docs.easypay.pt/docs/error-handling#invalid-params-error-400","title":"Invalid payload provided","detail":"Your request parameters didn't validate","status":400,"invalid_params":{"name":"expiration_time","reason":"expiration_time should be formated as RFC 3339 and in the future"}},"key":"Example 1","summary":"Example 1","id":"paths/~1link/post/responses/400/content/application~1json/examples/Example 1"},"paths/~1link/get/responses/400/content/application~1json/examples/Example 1":{"value":{"type":"https://docs.easypay.pt/docs/error-handling#invalid-params-error-400","title":"Invalid payload provided","detail":"Your request parameters didn't validate","status":400,"invalid_params":{"name":"expiration_time","reason":"expiration_time should be formated as RFC 3339 and in the future"}},"key":"Example 1","summary":"Example 1","id":"paths/~1link/get/responses/400/content/application~1json/examples/Example 1"},"paths/~1link~1{id}/get/responses/400/content/application~1json/examples/Example 1":{"value":{"type":"https://docs.easypay.pt/docs/error-handling#invalid-params-error-400","title":"Invalid payload provided","detail":"Your request parameters didn't validate","status":400,"invalid_params":{"name":"expiration_time","reason":"expiration_time should be formated as RFC 3339 and in the future"}},"key":"Example 1","summary":"Example 1","id":"paths/~1link~1{id}/get/responses/400/content/application~1json/examples/Example 1"},"paths/~1link~1{id}/delete/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1link~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"},"paths/~1link~1{id}/delete/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1link~1{id}/delete/responses/500/content/application~1json/examples/Internal error"},"paths/~1link~1{id}/patch/responses/400/content/application~1json/examples/Example 1":{"value":{"type":"https://docs.easypay.pt/docs/error-handling#invalid-params-error-400","title":"Invalid payload provided","detail":"Your request parameters didn't validate","status":400,"invalid_params":{"name":"expiration_time","reason":"expiration_time should be formated as RFC 3339 and in the future"}},"key":"Example 1","summary":"Example 1","id":"paths/~1link~1{id}/patch/responses/400/content/application~1json/examples/Example 1"},"paths/~1customer~1{id}/get/responses/200/content/application~1json/examples/Success":{"value":{"id":"649e88cf-0b78-4c36-8f99-33f5ebb812a1","name":"John Doe","email":"john.doe@example.com","phone":"911234567","phone_indicative":"+351","fiscal_number":"PT123456789","key":"customer Key Example","language":"PT","reward_balances":[{"account_id":"458b2fc4-3092-4de3-abd4-fe1600c09420","available_balance":12.5},{"account_id":"569c3ad5-4103-5ef4-cbe5-af2711d10531","available_balance":3}]},"key":"Success","summary":"Success","description":"Success","id":"paths/~1customer~1{id}/get/responses/200/content/application~1json/examples/Success"},"paths/~1customer~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1customer~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1customer~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1customer~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1customer~1{id}/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1customer~1{id}/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1customer~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1customer~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1customer~1{id}/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1customer~1{id}/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1customer~1{id}~1rewards/get/responses/200/content/application~1json/examples/Success":{"value":{"metadata":{"next_cursor":"lL_j7ilk7rc","count":6},"data":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","account_id":"458b2fc4-3092-4de3-abd4-fe1600c09420","type":"REWARD","amount":10,"expiration_date":"2027-01-15","capture":{"id":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"created_at":"2026-01-15T10:30:00Z"},{"id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","account_id":"458b2fc4-3092-4de3-abd4-fe1600c09420","type":"REDEMPTION","amount":1.5,"capture":{"id":"e8267345-c5a0-4fa9-d166-5af905bec8dd"},"created_at":"2026-02-10T14:22:00Z"},{"id":"c3d4e5f6-a7b8-9012-cdef-012345678902","account_id":"458b2fc4-3092-4de3-abd4-fe1600c09420","type":"REWARD","amount":5,"expiration_date":"2027-06-01","created_at":"2026-02-15T09:00:00Z"},{"id":"d4e5f6a7-b8c9-0123-def0-123456789013","account_id":"458b2fc4-3092-4de3-abd4-fe1600c09420","type":"REWARD_EXPIRATION","amount":8.5,"expiration_date":"2027-01-15","capture":{"id":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"created_at":"2027-01-16T03:00:00Z"},{"id":"e5f6a7b8-c9d0-1234-ef01-234567890124","account_id":"458b2fc4-3092-4de3-abd4-fe1600c09420","type":"REWARD_REVERSAL","amount":5,"capture":{"id":"c6056234-a3f9-42de-b944-3ed793fcb6bb"},"created_at":"2026-03-02T11:05:00Z"},{"id":"f6a7b8c9-d0e1-2345-f012-345678901235","account_id":"458b2fc4-3092-4de3-abd4-fe1600c09420","type":"REWARD_RESTORATION","amount":1.5,"expiration_date":"2027-01-15","capture":{"id":"e8267345-c5a0-4fa9-d166-5af905bec8dd"},"created_at":"2026-03-02T11:05:00Z"}]},"key":"Success","summary":"Success","description":"Success","id":"paths/~1customer~1{id}~1rewards/get/responses/200/content/application~1json/examples/Success"},"paths/~1customer~1{id}~1rewards/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1customer~1{id}~1rewards/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1customer~1{id}~1rewards/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1customer~1{id}~1rewards/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1customer~1{id}~1rewards/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1customer~1{id}~1rewards/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1customer~1{id}~1rewards/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1customer~1{id}~1rewards/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1customer~1{id}~1rewards/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1customer~1{id}~1rewards/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1terminal/get/responses/200/content/application~1json/examples/Success":{"value":{"metadata":{"next_cursor":"lL_j7ilk7rc","count":2},"data":[{"id":"458b2fc4-3092-4de3-abd4-fe1600c09420","serial_number":"123-456-789","name":"Terminal Checkout 1","status":"ACTIVE","acquirer":"VERIFONE","model":"V240m","last_transaction_at":"2025-08-05T13:44:29Z","created_at":"2025-08-01T10:00:00Z"},{"id":"569c3ad5-4103-5ef4-cbe5-af2711d10531","serial_number":"SN987654321","name":"Terminal Bar 1","status":"INACTIVE","acquirer":"VERIFONE","model":"V400m","last_transaction_at":"2025-08-04T18:30:00Z","created_at":"2025-08-02T14:00:00Z"}]},"key":"Success","summary":"Success","description":"Success","id":"paths/~1terminal/get/responses/200/content/application~1json/examples/Success"},"paths/~1terminal/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1terminal/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1terminal/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1terminal/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1terminal/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1terminal/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1terminal/post/requestBody/content/application~1json/examples/Create a Terminal":{"value":{"serial_number":"123-456-789","name":"Terminal Checkout 1","acquirer":"VERIFONE"},"key":"Create a Terminal","summary":"Create a Terminal","id":"paths/~1terminal/post/requestBody/content/application~1json/examples/Create a Terminal"},"paths/~1terminal/post/responses/201/content/application~1json/examples/Success":{"value":{"id":"458b2fc4-3092-4de3-abd4-fe1600c09420","serial_number":"123-456-789","name":"Terminal Checkout 1","status":"ACTIVE","acquirer":"VERIFONE","model":"V240m","last_transaction_at":null,"created_at":"2025-08-05T13:44:29Z"},"key":"Success","summary":"Success","description":"Success","id":"paths/~1terminal/post/responses/201/content/application~1json/examples/Success"},"paths/~1terminal/post/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1terminal/post/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1terminal/post/responses/409/content/application~1json/examples/conflict":{"value":{"status":"409","message":"Conflict - Resource already exists or state conflict","id":"00000000-0000-0000-0000-000000000000"},"key":"conflict","summary":"Resource conflict example","id":"paths/~1terminal/post/responses/409/content/application~1json/examples/conflict"},"paths/~1terminal/post/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1terminal/post/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1terminal/post/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1terminal/post/responses/500/content/application~1json/examples/Internal error"},"paths/~1terminal~1{id}/get/responses/200/content/application~1json/examples/Success":{"value":{"id":"458b2fc4-3092-4de3-abd4-fe1600c09420","serial_number":"123-456-789","name":"Terminal Checkout 1","status":"ACTIVE","acquirer":"VERIFONE","model":"V240m","last_transaction_at":"2025-08-05T13:44:29Z","created_at":"2025-08-01T10:00:00Z"},"key":"Success","summary":"Success","description":"Success","id":"paths/~1terminal~1{id}/get/responses/200/content/application~1json/examples/Success"},"paths/~1terminal~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1terminal~1{id}/get/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1terminal~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1terminal~1{id}/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1terminal~1{id}/get/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1terminal~1{id}/get/responses/404/content/application~1json/examples/Resource not found"},"paths/~1terminal~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1terminal~1{id}/get/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1terminal~1{id}/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1terminal~1{id}/get/responses/500/content/application~1json/examples/Internal error"},"paths/~1terminal~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1terminal~1{id}/delete/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1terminal~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1terminal~1{id}/delete/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1terminal~1{id}/delete/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1terminal~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"},"paths/~1terminal~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1terminal~1{id}/delete/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1terminal~1{id}/delete/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1terminal~1{id}/delete/responses/500/content/application~1json/examples/Internal error"},"paths/~1terminal~1{id}/patch/requestBody/content/application~1json/examples/Update Terminal name":{"value":{"name":"Terminal Checkout 2"},"key":"Update Terminal name","summary":"Update Terminal name","id":"paths/~1terminal~1{id}/patch/requestBody/content/application~1json/examples/Update Terminal name"},"paths/~1terminal~1{id}/patch/responses/200/content/application~1json/examples/Success":{"value":{"id":"458b2fc4-3092-4de3-abd4-fe1600c09420","serial_number":"123-456-789","name":"Terminal Checkout 2","status":"ACTIVE","acquirer":"VERIFONE","model":"V240m","last_transaction_at":"2025-08-05T13:44:29Z","created_at":"2025-08-01T10:00:00Z"},"key":"Success","summary":"Success","description":"Success","id":"paths/~1terminal~1{id}/patch/responses/200/content/application~1json/examples/Success"},"paths/~1terminal~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1terminal~1{id}/patch/responses/401/content/application~1json/examples/Wrong credentials provided"},"paths/~1terminal~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1terminal~1{id}/patch/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1terminal~1{id}/patch/responses/404/content/application~1json/examples/Resource not found":{"value":{"status":"error","message":["Resource not found"]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1terminal~1{id}/patch/responses/404/content/application~1json/examples/Resource not found"},"paths/~1terminal~1{id}/patch/responses/409/content/application~1json/examples/conflict":{"value":{"status":"409","message":"Conflict - Resource already exists or state conflict","id":"00000000-0000-0000-0000-000000000000"},"key":"conflict","summary":"Resource conflict example","id":"paths/~1terminal~1{id}/patch/responses/409/content/application~1json/examples/conflict"},"paths/~1terminal~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded":{"value":{"status":"error","message":["Rate limit exceeded"]},"key":"Rate limit exceeded","summary":"Rate limit exceeded","id":"paths/~1terminal~1{id}/patch/responses/429/content/application~1json/examples/Rate limit exceeded"},"paths/~1terminal~1{id}/patch/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1terminal~1{id}/patch/responses/500/content/application~1json/examples/Internal error"},"paths/~1system~1ping/get/responses/403/content/application~1json/examples/Wrong credentials provided":{"value":{"status":"error","message":["Authentication failed"]},"key":"Wrong credentials provided","summary":"Wrong credentials provided","id":"paths/~1system~1ping/get/responses/403/content/application~1json/examples/Wrong credentials provided"},"paths/~1system~1ping/get/responses/500/content/application~1json/examples/Internal error":{"value":{"status":"error","message":["Internal Error"]},"key":"Internal error","summary":"Internal error","id":"paths/~1system~1ping/get/responses/500/content/application~1json/examples/Internal error"}},"securitySchemeStore":{"accountId":{"id":"accountId","type":"apiKey","description":"This is the identification for the Easypay Client Account","in":"header","paramName":"AccountId"},"apiKey":{"id":"apiKey","type":"apiKey","description":"This is the counter key for the used Account Id","in":"header","paramName":"ApiKey"},"signatureAuth":{"id":"signatureAuth","type":"apiKey","description":"RSA signature Base64 generated with algorithm SHA256 using a account strong authentication private Key on the raw body or id.","in":"header","paramName":"Signature"},"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://api.test.easypay.pt/2.0","description":"Sandbox"},{"url":"https://api.prod.easypay.pt/2.0","description":"Production"}],"logo":{"imageUrl":"https://easypay-cdn-delivery.s3.eu-central-1.amazonaws.com/logo.png","altText":"easypay"}},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/@l10n/pt/openapi.json?download"},{"url":"/_bundle/@l10n/pt/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Easypay Payments API","description":"<a href='https://www.easypay.pt/en/legal-terms-and-conditions/' class='item'>Terms conditions and legal terms</a><br><a href='https://www.easypay.pt/en/privacy-and-data-protection-policy/' class='item'>Privacy Policy</a>","summary":""}},"baseSlug":"/pt/openapi","routesMapping":{}}