{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml","oas-apis/merchant-reconciliation.openapi.yaml":"oas-apis/merchant-reconciliation.openapi.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","json-schema","partial","openapi-code-sample"]},"type":"markdown"},"seo":{"title":"Reconciliation Guide","description":"Discover the API documentation to start developing your Bancontact Pro application","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"danger","name":"New payment URLs"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Following the decommissioning of the Payconiq brand in Belgium, these URL changes are essential to ensure compliance and"," ","mark the final phase in aligning our branding with the new Bancontact Pro identity."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Please implement adaptations ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/general/payloadurlupdate"},"children":["described here"]}," promptly to avoid service interruptions and guarantee the continued acceptance of mobile payments via Bancontact Pay and Wero."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Changes are already available in our pre-production environement and will be rolled out in production starting ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["11/05/2026"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"reconciliation-guide","__idx":0},"children":["Reconciliation Guide"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"introduction","__idx":1},"children":["Introduction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Our Reconciliation API helps you reconcile and match the payouts credited in your account and with the transactions"," ","and refund operations they relate to."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Three endpoints are available to help you with your reconciliation:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET Payout List"]},": will provide you with a list of all the payments credited into your payout account(s) by date."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET Payment List"]},": will provide you with a list of all the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUCCEEDED"]}," transactions by Payout ID or by date range."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET Refund List"]},": will provide you wirh a list of all the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUCCEEDED"]}," refunds by Payout ID or by date range."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Please note that all reconciliation data will only be made available on D+1 starting at 09:00CET. Recociliation"," ","data is available in both PREPROD and PROD environements."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the full endpoint documentation, please refer to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/merchant-reconciliation.openapi"},"children":["Reconciliation API"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information on Payouts and Remittance Information, please refer to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/general/payoutremittance052025"},"children":["this guide"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-payout-list","__idx":2},"children":["Get Payout List"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint allows you to retrieve a list of all the payments credited into your payout account(s) by date."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"path-parameters","__idx":3},"children":["Path Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["size"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The size of the page to be returned (Default is 10000)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Zero-based page index in list request (Default is 0)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["date"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The date for which the list of payouts should be returned. Format should be yyyy-MM-dd. (Default is current UTC date)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":4},"children":["Response"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../apis/merchant-reconciliation.openapi.yaml#/components/schemas/PayoutListResponse"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/PayoutListResponse"},"AbstractListResponse":{"type":"object","description":"Base paginated list response","required":["size","totalPages","totalElements","number"],"properties":{"size":{"type":"integer","description":"the total number of elements in the current page of this response","minimum":0},"totalPages":{"type":"integer","description":"the total number of pages in the response"},"totalElements":{"type":"integer","description":"the total number of elements in the response"},"number":{"type":"integer","description":"the current page number"}}},"PayoutStatus":{"type":"string","enum":["SUCCEEDED","FAILED"],"description":"* _SUCCEEDED_ - Payout was successfully processed\n* _FAILED_ - Payout failed."},"Currency":{"type":"string","enum":["EUR"],"default":"EUR","description":"currency code. Only EUR is supported [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217)"},"PayoutListItem":{"type":"object","description":"an individual object returned in the List response that contains the details of a payout\nassociated to a merchant","required":["payoutId","merchantId","bulkId","iban","payoutStatus","payoutDate","payoutCurrency","totalPayments","totalRefunds","totalPaymentAmount","totalRefundAmount","payoutAmount"],"properties":{"payoutId":{"type":"string","description":"The unique identifier associated with the payout if a pay-out was successfully created","minLength":24,"maxLength":24},"merchantId":{"type":"string","description":"The merchant id used during aggregation of the payout run","minLength":24,"maxLength":24},"bulkId":{"type":"string","description":"The bulk id used during aggregation of the of the payout run if available,\nif not `NONE` would be sent as default","minLength":1},"iban":{"type":"string","description":"The IBAN in (ISO 13616) format used during aggregation of the payout run and\nthis will be used to payout to the merchant","pattern":"^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$","examples":["BE68539007547034"],"minLength":1},"payoutStatus":{"$ref":"#/components/schemas/PayoutStatus"},"payoutDate":{"type":"string","format":"date-time","description":"timestamp, when payout was created in UTC"},"payoutCurrency":{"$ref":"#/components/schemas/Currency"},"totalPayments":{"type":"integer","description":"The total number of payments included in the payout"},"totalRefunds":{"type":"integer","description":"The total number of refunds included in the payout"},"totalPaymentAmount":{"description":"The total payment amount in cents contained in the payout.","type":"integer","format":"int64","minimum":1,"exclusiveMinimum":1},"totalRefundAmount":{"description":"The total refund amount in cents contained in the payout.","type":"integer","format":"int64","minimum":0,"exclusiveMinimum":0},"payoutAmount":{"type":"integer","description":"Total amount in cents paid out the to merchant","format":"int64","minimum":1,"exclusiveMinimum":1}}},"PayoutListResponse":{"description":"contains a paginated list of payouts associated with a merchant","allOf":[{"$ref":"#/components/schemas/AbstractListResponse"},{"type":"object","required":["payouts"],"properties":{"payouts":{"type":"array","description":"a list of payouts. If the list is empty, then there were no payouts made.","items":{"$ref":"#/components/schemas/PayoutListItem"}}}}]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"error-codes","__idx":5},"children":["Error Codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Status"},"children":["HTTP Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Code"},"children":["Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BAD_REQUEST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Some fields in the requests were not formatted correctly"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNAUTHORIZED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The JWS signature is not valid",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," the caller does not have valid authentication credentials"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["403"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCESS_DENIED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operation not allowed,",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," the caller doesnot have the required authorities"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["500"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TECHNICAL_ERROR"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal technical error in the payment service."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["503"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["//"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Service unavailable."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sample-request--getpayoutlist","__idx":6},"children":["Sample Request – ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["getPayoutList"]}]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/merchant-reconciliation.openapi.yaml","operationId":"getPayoutList","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-payment-list","__idx":7},"children":["Get Payment List"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint allows you to retrieve a list of all all the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUCCEEDED"]}," transactions by Payout ID or by date range."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"path-parameters-1","__idx":8},"children":["Path Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["size"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The size of the page to be returned (Defaul is 10000)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Zero-based page indew in list request (Default is 0)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start-date"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No, unless ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end-date"]}," provided"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The inclusive start date for the Payment list. Format should be yyyy-MM-dd. Maximum 30 days between ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start-date"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end-date"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end-date"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No, unless ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start-date"]}," provided"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The inclusive end date for the Payment list. Format should be yyyy-MM-dd. Maximum 30 days between ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start-date"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end-date"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payout-id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique payout identifier for which you wish to retrieve the Payment list."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-1","__idx":9},"children":["Response"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../apis/merchant-reconciliation.openapi.yaml#/components/schemas/PayoutPaymentsResponse"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/PayoutPaymentsResponse"},"AbstractListResponse":{"type":"object","description":"Base paginated list response","required":["size","totalPages","totalElements","number"],"properties":{"size":{"type":"integer","description":"the total number of elements in the current page of this response","minimum":0},"totalPages":{"type":"integer","description":"the total number of pages in the response"},"totalElements":{"type":"integer","description":"the total number of elements in the response"},"number":{"type":"integer","description":"the current page number"}}},"PaymentChannel":{"type":"string","enum":["ONLINE","INSTORE","INVOICE"],"description":"\"The  channel of the payment\""},"Currency":{"type":"string","enum":["EUR"],"default":"EUR","description":"currency code. Only EUR is supported [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217)"},"TransactionDetails":{"type":"object","description":"The details of a transaction","required":["paymentId","paymentProfileId","merchantName","paymentChannel","currency","amount","transactionDate"],"properties":{"paymentId":{"type":"string","description":"The id of the payment","minLength":24,"maxLength":24},"payoutId":{"type":"string","description":"The id of the payout","minLength":24,"maxLength":24},"paymentProfileId":{"type":"string","description":"The profile id of the merchant used in the transaction","minLength":24,"maxLength":24},"merchantName":{"type":"string","description":"The name of the merchant","minLength":1},"paymentChannel":{"$ref":"#/components/schemas/PaymentChannel"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"integer","description":"Total amount in cents of the transaction","format":"int64","minimum":1},"reference":{"description":"The reference provided by the merchant/partner during a payment/refund","type":"string","minLength":1},"description":{"description":"The description provided by the merchant/partner during a payment/refund","type":"string","minLength":1},"transactionDate":{"type":"string","format":"date-time","description":"timestamp, when transaction was created in UTC"}}},"PaymentDetails":{"description":"Details of a payment","allOf":[{"$ref":"#/components/schemas/TransactionDetails"}]},"PayoutPaymentsResponse":{"description":"list of payments associated with a payout","allOf":[{"$ref":"#/components/schemas/AbstractListResponse"},{"type":"object","required":["payments"],"properties":{"payments":{"type":"array","description":"a list of payments included in the payout.","items":{"$ref":"#/components/schemas/PaymentDetails"}}}}]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"error-codes-1","__idx":10},"children":["Error Codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Status"},"children":["HTTP Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Code"},"children":["Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BAD_REQUEST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Some fields in the requests were not formatted correctly"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNAUTHORIZED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The JWS signature is not valid",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," the caller does not have valid authentication credentials"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["403"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCESS_DENIED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operation not allowed,",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," the caller doesnot have the required authorities"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYOUT_NOT_FOUND"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Could not find a Payout with the prodivded ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["500"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TECHNICAL_ERROR"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal technical error in the payment service."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["503"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["//"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Service unavailable."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sample-request--getpayments","__idx":11},"children":["Sample Request – ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["getPayments"]}]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/merchant-reconciliation.openapi.yaml","operationId":"getPayments","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-refund-list","__idx":12},"children":["Get Refund List"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint allows you to retrieve a list of all all the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUCCEEDED"]}," refunds by Payout ID or by date range."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"path-parameters-2","__idx":13},"children":["Path Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["size"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The size of the page to be returned (Defaul is 10000)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Zero-based page indew in list request (Default is 0)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start-date"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No, unless ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end-date"]}," provided"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The inclusive start date for the Payment list. Format should be yyyy-MM-dd. Maximum 30 days between ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start-date"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end-date"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end-date"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No, unless ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start-date"]}," provided"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The inclusive end date for the Payment list. Format should be yyyy-MM-dd. Maximum 30 days between ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start-date"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end-date"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payout-id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique payout identifier for which you wish to retrieve the Payment list."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-2","__idx":14},"children":["Response"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../apis/merchant-reconciliation.openapi.yaml#/components/schemas/PayoutRefundsResponse"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/PayoutRefundsResponse"},"AbstractListResponse":{"type":"object","description":"Base paginated list response","required":["size","totalPages","totalElements","number"],"properties":{"size":{"type":"integer","description":"the total number of elements in the current page of this response","minimum":0},"totalPages":{"type":"integer","description":"the total number of pages in the response"},"totalElements":{"type":"integer","description":"the total number of elements in the response"},"number":{"type":"integer","description":"the current page number"}}},"PaymentChannel":{"type":"string","enum":["ONLINE","INSTORE","INVOICE"],"description":"\"The  channel of the payment\""},"Currency":{"type":"string","enum":["EUR"],"default":"EUR","description":"currency code. Only EUR is supported [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217)"},"TransactionDetails":{"type":"object","description":"The details of a transaction","required":["paymentId","paymentProfileId","merchantName","paymentChannel","currency","amount","transactionDate"],"properties":{"paymentId":{"type":"string","description":"The id of the payment","minLength":24,"maxLength":24},"payoutId":{"type":"string","description":"The id of the payout","minLength":24,"maxLength":24},"paymentProfileId":{"type":"string","description":"The profile id of the merchant used in the transaction","minLength":24,"maxLength":24},"merchantName":{"type":"string","description":"The name of the merchant","minLength":1},"paymentChannel":{"$ref":"#/components/schemas/PaymentChannel"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"integer","description":"Total amount in cents of the transaction","format":"int64","minimum":1},"reference":{"description":"The reference provided by the merchant/partner during a payment/refund","type":"string","minLength":1},"description":{"description":"The description provided by the merchant/partner during a payment/refund","type":"string","minLength":1},"transactionDate":{"type":"string","format":"date-time","description":"timestamp, when transaction was created in UTC"}}},"RefundDetails":{"description":"Details of a refund","allOf":[{"$ref":"#/components/schemas/TransactionDetails"},{"type":"object","required":["refundId"],"properties":{"refundId":{"type":"string","description":"The id of the refund","minLength":24,"maxLength":24}}}]},"PayoutRefundsResponse":{"description":"list of refunds associated with a payout","allOf":[{"$ref":"#/components/schemas/AbstractListResponse"},{"type":"object","required":["refunds"],"properties":{"refunds":{"type":"array","description":"a list of refunds included in the payout.","items":{"$ref":"#/components/schemas/RefundDetails"}}}}]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"error-codes-2","__idx":15},"children":["Error Codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Status"},"children":["HTTP Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Code"},"children":["Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BAD_REQUEST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Some fields in the requests were not formatted correctly"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNAUTHORIZED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The JWS signature is not valid",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," the caller does not have valid authentication credentials"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["403"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCESS_DENIED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operation not allowed,",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," the caller doesnot have the required authorities"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYOUT_NOT_FOUND"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Could not find a Payout with the prodivded ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["500"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TECHNICAL_ERROR"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal technical error in the payment service."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["503"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["//"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Service unavailable."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sample-request--getrefunds","__idx":16},"children":["Sample Request – ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["getRefunds"]}]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/merchant-reconciliation.openapi.yaml","operationId":"getRefunds","parameters":{},"environments":{}},"children":[]}]},"headings":[{"value":"Reconciliation Guide","id":"reconciliation-guide","depth":1},{"value":"Introduction","id":"introduction","depth":2},{"value":"Get Payout List","id":"get-payout-list","depth":2},{"value":"Path Parameters","id":"path-parameters","depth":3},{"value":"Response","id":"response","depth":3},{"value":"Error Codes","id":"error-codes","depth":3},{"value":"Sample Request – getPayoutList","id":"sample-request--getpayoutlist","depth":3},{"value":"Get Payment List","id":"get-payment-list","depth":2},{"value":"Path Parameters","id":"path-parameters-1","depth":3},{"value":"Response","id":"response-1","depth":3},{"value":"Error Codes","id":"error-codes-1","depth":3},{"value":"Sample Request – getPayments","id":"sample-request--getpayments","depth":3},{"value":"Get Refund List","id":"get-refund-list","depth":2},{"value":"Path Parameters","id":"path-parameters-2","depth":3},{"value":"Response","id":"response-2","depth":3},{"value":"Error Codes","id":"error-codes-2","depth":3},{"value":"Sample Request – getRefunds","id":"sample-request--getrefunds","depth":3}],"frontmatter":{"seo":{"title":"Reconciliation Guide"}},"lastModified":"2026-03-16T13:20:15.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/general/reconciliation052025","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}