{"items":[{"type":"link","label":"Spense Partner APIs","link":"/apis/partner","routeSlug":"/apis/partner","content":{"contentType":"overview","meta":{"name":"Spense Partner APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"partner.json","url":"/_bundle/apis/partner.json?download"},{"kind":"download","label":"partner.yaml","url":"/_bundle/apis/partner.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Spense Partner APIs (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":" "}],"sectionId":"/apis/partner"}],"sectionId":"/apis/partner"}]}]}},{"type":"group","label":"Authentication","link":"/apis/partner/authentication","routeSlug":"/apis/partner/authentication","items":[{"label":"Get OAuth2 access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/partner/authentication/login","routeSlug":"/apis/partner/authentication/login","metadata":{"seo":{"title":"Get OAuth2 access token","description":"Get OAuth2 access token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"login","name":"Get OAuth2 access token","isWebhook":false,"pointer":"/paths/~1auth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get OAuth2 access token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/Body_login"}},"schemaId":"components/schemas/Body_login","pointer":"/paths/~1auth~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/token","servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/Body_login"}},"responseCodes":["200","401","422"],"pointer":"/auth/token","href":"authentication/login","openApiOperationId":"login","summary":"Get OAuth2 access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"schemaId":"components/schemas/Body_login","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/Body_login"}},"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenResponse"}},"schemaId":"components/schemas/TokenResponse"},{"code":"401","description":"Incorrect client id or secret","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1auth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenResponse"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/login"}],"panels":[]}]},"httpPath":"/auth/token"},{"label":"Verify that the bearer token is valid.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/partner/authentication/ping","routeSlug":"/apis/partner/authentication/ping","metadata":{"seo":{"title":"Verify that the bearer token is valid.","description":"Verify that the bearer token is valid."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ping","name":"Verify that the bearer token is valid.","isWebhook":false,"pointer":"/paths/~1auth~1ping/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify that the bearer token is valid.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["me:ping"],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/ping","servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}],"scopes":["me:ping"]}],"responseCodes":["200","401"],"pointer":"/auth/ping","href":"authentication/ping","openApiOperationId":"ping","summary":"Verify that the bearer token is valid."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_17"}},"schemaId":"schema_17"},{"code":"401","description":"Not authenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1auth~1ping/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_17","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_17"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/ping"}],"panels":[]}]},"httpPath":"/auth/ping"},{"label":"Get the list of organizations you have access to.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/partner/authentication/get_organizations","routeSlug":"/apis/partner/authentication/get_organizations","metadata":{"seo":{"title":"Get the list of organizations you have access to.","description":"Get the list of organizations the user has access to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_organizations","name":"Get the list of organizations you have access to.","isWebhook":false,"pointer":"/paths/~1auth~1organizations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the list of organizations you have access to.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the list of organizations the user has access to."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["me:ping"],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/organizations","servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}],"scopes":["me:ping"]}],"responseCodes":["200","401"],"pointer":"/auth/organizations","href":"authentication/get_organizations","openApiOperationId":"get_organizations","summary":"Get the list of organizations you have access to."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18"}},"schemaId":"schema_18"},{"code":"401","description":"Not authenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1auth~1organizations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_18","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/get_organizations"}],"panels":[]}]},"httpPath":"/auth/organizations"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/token","summary":"Get OAuth2 access token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/login","deprecated":false},{"title":"/auth/ping","summary":"Verify that the bearer token is valid.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authentication/ping","deprecated":false},{"title":"/auth/organizations","summary":"Get the list of organizations you have access to.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authentication/get_organizations","deprecated":false}]}]}]}]}},{"type":"group","label":"Settlements","link":"/apis/partner/settlements","routeSlug":"/apis/partner/settlements","items":[{"label":"Generate Csv","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/partner/settlements/generate_csv","routeSlug":"/apis/partner/settlements/generate_csv","metadata":{"seo":{"title":"Generate Csv","description":"Generate a CSV file for the given date range and format."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generate_csv","name":"Generate Csv","isWebhook":false,"pointer":"/paths/~1settlements~1generate_csv/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate Csv","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":"Generate a CSV file for the given date range and format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remember: use the header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Organization-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the organization ID if you are using a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partner token which has access to multiple organizations."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["organization:accounting:read"],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Organization-Id","in":"header","schemaId":"schema_19","description":"Required if the account is part of multiple organizations. If the account only has access to one organization, this header is not required."}],"pointer":"/paths/~1settlements~1generate_csv/get/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SettlementGenerateCSVRequest"}},"schemaId":"components/schemas/SettlementGenerateCSVRequest","pointer":"/paths/~1settlements~1generate_csv/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settlements/generate_csv","servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Organization-Id","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}],"scopes":["organization:accounting:read"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SettlementGenerateCSVRequest"}},"responseCodes":["200","422"],"pointer":"/settlements/generate_csv","href":"settlements/generate_csv","openApiOperationId":"generate_csv","summary":"Generate Csv"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"schemaId":"components/schemas/SettlementGenerateCSVRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SettlementGenerateCSVRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CSV file generated successfully","mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"exampleIds":["paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/transactions","paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/payouts","paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/machine_readable"]}},"exampleIds":["paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/transactions","paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/payouts","paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/machine_readable"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1settlements~1generate_csv/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/transactions","paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/payouts","paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/machine_readable"],"mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"exampleIds":["paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/transactions","paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/payouts","paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/machine_readable"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/generate_csv"}],"panels":[]}]},"httpPath":"/settlements/generate_csv"}],"content":{"contentType":"group","meta":{"name":"Settlements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settlements","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settlements/generate_csv","summary":"Generate Csv","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/generate_csv","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Methods","link":"/apis/partner/payment-methods","routeSlug":"/apis/partner/payment-methods","items":[{"label":"Get Payment Methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/partner/payment-methods/get_payment_methods","routeSlug":"/apis/partner/payment-methods/get_payment_methods","metadata":{"seo":{"title":"Get Payment Methods","description":"Get a list of available payment methods, which can be used to specify which payment method to use whencreating a payment. The list of payment methods may change over time, so it is recommended to fetch this listdynamically when creating a payment, to allow the user select the payment method they want to use."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_payment_methods","name":"Get Payment Methods","isWebhook":false,"pointer":"/paths/~1payment-methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Payment Methods","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 a list of available payment methods, which can be used to specify which payment method to use when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creating a payment. The list of payment methods may change over time, so it is recommended to fetch this list"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dynamically when creating a payment, to allow the user select the payment method they want to use."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of payment methods is not guaranteed to be exhaustive, and special configuration is needed for most"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the possible methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default method which is a payment link, will always be available with the string ID "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"000000000000000000000000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["organization:payflow:create"],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"test_mode","in":"query","schemaId":"schema_20"}],"pointer":"/paths/~1payment-methods/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Organization-Id","in":"header","schemaId":"schema_19","description":"Required if the account is part of multiple organizations. If the account only has access to one organization, this header is not required."}],"pointer":"/paths/~1payment-methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-methods","servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"test_mode","in":"query","required":false,"schemaId":"schema_20"}],"querystring":[],"header":[{"name":"X-Organization-Id","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}],"scopes":["organization:payflow:create"]}],"responseCodes":["200","422"],"pointer":"/payment-methods","href":"payment-methods/get_payment_methods","openApiOperationId":"get_payment_methods","summary":"Get Payment Methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of available payment methods","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21","exampleIds":["paths/~1payment-methods/get/responses/200/content/application~1json/examples/basic","paths/~1payment-methods/get/responses/200/content/application~1json/examples/with_terminals"]}},"schemaId":"schema_21","exampleIds":["paths/~1payment-methods/get/responses/200/content/application~1json/examples/basic","paths/~1payment-methods/get/responses/200/content/application~1json/examples/with_terminals"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1payment-methods/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_21","exampleIds":["paths/~1payment-methods/get/responses/200/content/application~1json/examples/basic","paths/~1payment-methods/get/responses/200/content/application~1json/examples/with_terminals"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21","exampleIds":["paths/~1payment-methods/get/responses/200/content/application~1json/examples/basic","paths/~1payment-methods/get/responses/200/content/application~1json/examples/with_terminals"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/get_payment_methods"}],"panels":[]}]},"httpPath":"/payment-methods"},{"label":"Resend To Payment Method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/partner/payment-methods/resend_to_payment_method","routeSlug":"/apis/partner/payment-methods/resend_to_payment_method","metadata":{"seo":{"title":"Resend To Payment Method","description":"Attempt to re-send the payment method for a payment.This will not create a new payment,but re-send the payment to the specified payment method.This can be used many times and have different behaviourdepending on the type of method used."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resend_to_payment_method","name":"Resend To Payment Method","isWebhook":false,"pointer":"/paths/~1payment-methods~1resend/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend To Payment Method","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":"Attempt to re-send the payment method for a payment.This will not create a new payment,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but re-send the payment to the specified payment method."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This can be used many times and have different behaviour"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"depending on the type of method used."},"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":"If a payment link method is used, the payment link will be sent again."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a terminal method is used, the payment will be sent to the specified terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a invoice method is used, we will send a invoice to the specified invoice type."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rely on webhooks to get notified about the result of the action."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["organization:payflow:create"],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Organization-Id","in":"header","schemaId":"schema_19","description":"Required if the account is part of multiple organizations. If the account only has access to one organization, this header is not required."}],"pointer":"/paths/~1payment-methods~1resend/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResendRequest"}},"schemaId":"components/schemas/ResendRequest","pointer":"/paths/~1payment-methods~1resend/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-methods/resend","servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Organization-Id","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}],"scopes":["organization:payflow:create"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ResendRequest"}},"responseCodes":["200","422"],"pointer":"/payment-methods/resend","href":"payment-methods/resend_to_payment_method","openApiOperationId":"resend_to_payment_method","summary":"Resend To Payment Method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"schemaId":"components/schemas/ResendRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResendRequest"}},"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1payment-methods~1resend/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/resend_to_payment_method"}],"panels":[]}]},"httpPath":"/payment-methods/resend"}],"content":{"contentType":"group","meta":{"name":"Payment Methods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Methods","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payment-methods","summary":"Get Payment Methods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-methods/get_payment_methods","deprecated":false},{"title":"/payment-methods/resend","summary":"Resend To Payment Method","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/resend_to_payment_method","deprecated":false}]}]}]}]}},{"type":"group","label":"Payments","link":"/apis/partner/payments","routeSlug":"/apis/partner/payments","items":[{"label":"Print receipt on terminal when payment is PAID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/partner/payments/print_receipt","routeSlug":"/apis/partner/payments/print_receipt","metadata":{"seo":{"title":"Print receipt on terminal when payment is PAID","description":"Print receipt on terminal when payment is PAID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"print_receipt","name":"Print receipt on terminal when payment is PAID","isWebhook":false,"pointer":"/paths/~1payments~1{payment_id}~1receipts~1terminal~1print/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Print receipt on terminal when payment is PAID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["organization:payflow:create"],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_23","required":true}],"pointer":"/paths/~1payments~1{payment_id}~1receipts~1terminal~1print/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Organization-Id","in":"header","schemaId":"schema_19","description":"Required if the account is part of multiple organizations. If the account only has access to one organization, this header is not required."}],"pointer":"/paths/~1payments~1{payment_id}~1receipts~1terminal~1print/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{payment_id}/receipts/terminal/print","servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[{"name":"X-Organization-Id","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}],"scopes":["organization:payflow:create"]}],"responseCodes":["200","400","401","422"],"pointer":"/payments/{payment_id}/receipts/terminal/print","href":"payments/print_receipt","openApiOperationId":"print_receipt","summary":"Print receipt on terminal when payment is PAID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"401","description":"Not authenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1payments~1{payment_id}~1receipts~1terminal~1print/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}}},{"code":"400","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/print_receipt"}],"panels":[]}]},"httpPath":"/payments/{payment_id}/receipts/terminal/print"},{"label":"Manually trigger payment as PAID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/partner/payments/mark_payment_as_paid","routeSlug":"/apis/partner/payments/mark_payment_as_paid","metadata":{"seo":{"title":"Manually trigger payment as PAID","description":"Mark a payment as PAID manually, for example when receiving a bank transfer or cash payment. The payment must not already be in a final status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mark_payment_as_paid","name":"Manually trigger payment as PAID","isWebhook":false,"pointer":"/paths/~1payments~1{payment_id}~1manual-paid/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manually trigger payment as PAID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Mark a payment as PAID manually, for example when receiving a bank transfer or cash payment. The payment must not already be in a final status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["organization:payflow:create"],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_23","required":true}],"pointer":"/paths/~1payments~1{payment_id}~1manual-paid/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Organization-Id","in":"header","schemaId":"schema_19","description":"Required if the account is part of multiple organizations. If the account only has access to one organization, this header is not required."}],"pointer":"/paths/~1payments~1{payment_id}~1manual-paid/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayflowPaymentMarkAsPaidRequest"}},"schemaId":"components/schemas/PayflowPaymentMarkAsPaidRequest","pointer":"/paths/~1payments~1{payment_id}~1manual-paid/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{payment_id}/manual-paid","servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[{"name":"X-Organization-Id","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}],"scopes":["organization:payflow:create"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PayflowPaymentMarkAsPaidRequest"}},"responseCodes":["200","400","401","422"],"pointer":"/payments/{payment_id}/manual-paid","href":"payments/mark_payment_as_paid","openApiOperationId":"mark_payment_as_paid","summary":"Manually trigger payment as PAID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"schemaId":"components/schemas/PayflowPaymentMarkAsPaidRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayflowPaymentMarkAsPaidRequest"}},"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"401","description":"Not authenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1payments~1{payment_id}~1manual-paid/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}}},{"code":"400","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"401","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/mark_payment_as_paid"}],"panels":[]}]},"httpPath":"/payments/{payment_id}/manual-paid"}],"content":{"contentType":"group","meta":{"name":"Payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payments","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payments/{payment_id}/receipts/terminal/print","summary":"Print receipt on terminal when payment is PAID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/print_receipt","deprecated":false},{"title":"/payments/{payment_id}/manual-paid","summary":"Manually trigger payment as PAID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/mark_payment_as_paid","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/apis/partner/webhooks","routeSlug":"/apis/partner/webhooks","items":[],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks"}],"panels":[]}]}}],"store":{"schemaStore":{"components/schemas/APIErrorResponse":{"id":"components/schemas/APIErrorResponse","kind":"json-schema","title":"APIErrorResponse","data":{"properties":{"detail":{"anyOf":[{"type":"string"},{"items":{"additionalProperties":true,"type":"object"},"type":"array"}],"title":"Detail"}},"type":"object","required":["detail"],"title":"APIErrorResponse"}},"components/schemas/AuthOrganizationsResponseItem":{"id":"components/schemas/AuthOrganizationsResponseItem","kind":"json-schema","title":"AuthOrganizationsResponseItem","data":{"properties":{"id":{"type":"string","pattern":"^[a-fA-F0-9]{24}$","title":"Id"},"name":{"type":"string","title":"Name"},"vat_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat Number"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"},"payment_profiles":{"items":{"$ref":"#/components/schemas/AuthOrganizationsResponseItemPaymentProfile"},"type":"array","title":"Payment Profiles","default":[]}},"type":"object","required":["id","name"],"title":"AuthOrganizationsResponseItem","description":"Response model for the list of organizations."}},"components/schemas/AuthOrganizationsResponseItemPaymentProfile":{"id":"components/schemas/AuthOrganizationsResponseItemPaymentProfile","kind":"json-schema","title":"AuthOrganizationsResponseItemPaymentProfile","data":{"properties":{"id":{"type":"string","pattern":"^[a-fA-F0-9]{24}$","title":"Id"},"name":{"type":"string","title":"Name"},"currency":{"anyOf":[{"$ref":"#/components/schemas/Currency"},{"type":"null"}]},"department":{"$ref":"#/components/schemas/PaymentDepartment"},"active":{"type":"boolean","title":"Active","default":true},"test_mode":{"type":"boolean","title":"Test Mode","default":false}},"type":"object","required":["id","name"],"title":"AuthOrganizationsResponseItemPaymentProfile","description":"Response model for the payment profile of an organization."}},"components/schemas/Body_login":{"id":"components/schemas/Body_login","kind":"json-schema","title":"Body_login","data":{"properties":{"grant_type":{"type":"string","pattern":"^(client_credentials|refresh_token)$","title":"Grant Type","default":"client_credentials"},"scope":{"type":"string","title":"Scope","default":""},"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id","examples":["your_client_id"]},"client_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Secret","examples":["your_client_secret"]}},"type":"object","title":"Body_login"}},"components/schemas/Currency":{"id":"components/schemas/Currency","kind":"json-schema","title":"Currency","data":{"type":"string","enum":["NOK","DKK","EUR","SEK","USD","GBP","QAR","PLN"],"title":"Currency","description":"Add currency here if we need to support more currencies.\n\nNote: Great care needs to be applied, as currently we only support currencies that have\n      a double digit decimal point as their lowest denomination."}},"components/schemas/HTTPValidationError":{"id":"components/schemas/HTTPValidationError","kind":"json-schema","title":"HTTPValidationError","data":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}},"components/schemas/MarkAsPaidPaymentMethod":{"id":"components/schemas/MarkAsPaidPaymentMethod","kind":"json-schema","title":"MarkAsPaidPaymentMethod","data":{"type":"string","enum":["bank_terminal","bank_transfer","cash"],"title":"MarkAsPaidPaymentMethod"}},"components/schemas/PartnerPaymentMethod":{"id":"components/schemas/PartnerPaymentMethod","kind":"json-schema","title":"PartnerPaymentMethod","data":{"properties":{"id":{"type":"string","pattern":"^[a-fA-F0-9]{24}$","title":"Id"},"name":{"type":"string","title":"Name"},"profile_ids":{"items":{"type":"string"},"type":"array","title":"Profile Ids","description":"The IDs of the profiles that the payment method belongs to.","default":[]},"type":{"$ref":"#/components/schemas/PartnerPaymentMethodType","description":"The type of payment method. Can be extended to other types in the future."},"active":{"type":"boolean","title":"Active","description":"Whether the payment method is active. Recommend to display in-active payments, but as disabled. Can for example be inactive if a terminal is turned off.","default":true}},"type":"object","required":["id","name","type"],"title":"PartnerPaymentMethod"}},"components/schemas/PartnerPaymentMethodType":{"id":"components/schemas/PartnerPaymentMethodType","kind":"json-schema","title":"PartnerPaymentMethodType","data":{"type":"string","enum":["payment_link","terminal","invoice"],"title":"PartnerPaymentMethodType"}},"components/schemas/PayflowPaymentMarkAsPaidRequest":{"id":"components/schemas/PayflowPaymentMarkAsPaidRequest","kind":"json-schema","title":"PayflowPaymentMarkAsPaidRequest","data":{"properties":{"payment_method":{"$ref":"#/components/schemas/MarkAsPaidPaymentMethod"},"user_email":{"type":"string","format":"email","title":"User Email"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","required":["payment_method","user_email"],"title":"PayflowPaymentMarkAsPaidRequest"}},"components/schemas/PaymentDepartment":{"id":"components/schemas/PaymentDepartment","kind":"json-schema","title":"PaymentDepartment","data":{"type":"string","enum":["UNKNOWN","CARSALE","SERVICE","PARTS","OTHER"],"title":"PaymentDepartment"}},"components/schemas/ResendRequest":{"id":"components/schemas/ResendRequest","kind":"json-schema","title":"ResendRequest","data":{"properties":{"payflow_id":{"type":"string","pattern":"^[a-fA-F0-9]{24}$","title":"Payflow Id"},"payment_method_id":{"type":"string","pattern":"^[a-fA-F0-9]{24}$","title":"Payment Method Id"}},"type":"object","required":["payflow_id","payment_method_id"],"title":"ResendRequest"}},"components/schemas/SettlementCSVType":{"id":"components/schemas/SettlementCSVType","kind":"json-schema","title":"SettlementCSVType","data":{"type":"string","enum":["transactions","payouts","machine_readable"],"title":"SettlementCSVType"}},"components/schemas/SettlementGenerateCSVRequest":{"id":"components/schemas/SettlementGenerateCSVRequest","kind":"json-schema","title":"SettlementGenerateCSVRequest","data":{"properties":{"from_date":{"type":"string","format":"date","title":"From Date","examples":["2023-01-01","2023-06-15"]},"to_date":{"type":"string","format":"date","title":"To Date","examples":["2023-01-31","2023-06-30"]},"format":{"$ref":"#/components/schemas/SettlementCSVType","description":"The format of the CSV file to generate.","default":"transactions","examples":["transactions","payouts","machine_readable"]},"test_mode":{"type":"boolean","title":"Test Mode","default":false},"payout_type":{"$ref":"#/components/schemas/SettlementPayoutType","default":"PSP"},"exclude_providers":{"items":{"$ref":"#/components/schemas/SettlementProviders"},"type":"array","title":"Exclude Providers","default":[]}},"type":"object","required":["from_date","to_date"],"title":"SettlementGenerateCSVRequest"}},"components/schemas/SettlementPayoutType":{"id":"components/schemas/SettlementPayoutType","kind":"json-schema","title":"SettlementPayoutType","data":{"type":"string","enum":["PSP","SPENSE"],"title":"SettlementPayoutType"}},"components/schemas/SettlementProviders":{"id":"components/schemas/SettlementProviders","kind":"json-schema","title":"SettlementProviders","data":{"type":"string","enum":["bankaxept","camt053","camt054","cash_register","ccv_terminal","manual","mollie","neonomics","nets_easy","nets_terminal","resurs","riverty","seb_bgw","svea_checkout","swedbank_checkout","swedbank_terminal","worldline_bambora"],"title":"SettlementProviders"}},"components/schemas/TokenResponse":{"id":"components/schemas/TokenResponse","kind":"json-schema","title":"TokenResponse","data":{"properties":{"access_token":{"type":"string","title":"Access Token","description":"The access token (UUID)","examples":["123e4567-e89b-12d3-a456-426614174000"]},"token_type":{"type":"string","title":"Token Type","description":"The type of the token, typically 'bearer'.","default":"bearer","examples":["bearer"]},"expires_in":{"type":"integer","title":"Expires In","description":"The number of seconds until the token expires.","examples":[3600]}},"type":"object","required":["access_token","expires_in"],"title":"TokenResponse","description":"An OAuth2 Token response."}},"components/schemas/ValidationError":{"id":"components/schemas/ValidationError","kind":"json-schema","title":"ValidationError","data":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"schema_17":{"kind":"json-schema","data":{"additionalProperties":true,"type":"object","title":"Response Ping"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AuthOrganizationsResponseItem"},"type":"array","title":"Response Get Organizations"},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"string","description":"Required if the account is part of multiple organizations. If the account only has access to one organization, this header is not required.","title":"X-Organization-Id"},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"boolean","default":false,"title":"Test Mode"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PartnerPaymentMethod"},"title":"Response Get Payment Methods"},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"object","additionalProperties":true,"title":"Response Resend To Payment Method"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"string","title":"Payment Id"},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"object","additionalProperties":true,"title":"Response Print Receipt"},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","additionalProperties":true,"title":"Response Mark Payment As Paid"},"id":"schema_25"}},"exampleStore":{"paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/transactions":{"value":"Date of transaction,Payment provider,Settlement reference,Settlement paid at,Reference,Currency,Gross amount,Fees,Net amount,Payment type,Payment method\n2025-07-09 00:00:00+00:00,Worldline Bambora,12345678-20250710,2025-07-10 00:00:00+00:00,100000,NOK,1200.99,,,Debit,Visa\n2025-07-09 00:00:00+00:00,Worldline Bambora,12345678-20250710,2025-07-10 00:00:00+00:00,100001,NOK,9000.00,,,Credit,Mastercard\n","key":"transactions","summary":"Transactions CSV","id":"paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/transactions"},"paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/payouts":{"value":"Date of payout,Payment provider,Reference,Currency,Gross Amount,Fees,Net Amount","key":"payouts","summary":"Payouts CSV","id":"paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/payouts"},"paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/machine_readable":{"value":"A,142,142,6639578.85,66395.7885,6573183.0615,6573183.0615,0\nR,TEST_MODE,142,142,6639578.85,66395.7885,6573183.0615,0\nP,TEST_MODE,2025-03-13 08:23:09.314000+00:00,test-payout-2025-03-13,67d3e41cb549716390b54557,1,1.25,0.0125,1.2375,1.2375,0\nP,TEST_MODE,2025-03-12 10:18:23.495000+00:00,test-payout-2025-03-12,67d3e41db549716390b54559,1,1250.00,12.50,1237.50,1237.50,0\nP,TEST_MODE,2025-02-26 11:38:48.226000+00:00,test-payout-2025-02-26,67d3e41db549716390b5455b,1,1.25,0.0125,1.2375,1.2375,0\nP,TEST_MODE,2025-02-25 10:27:41.182000+00:00,test-payout-2025-02-25,67d3e41db549716390b5455d,1,6943.75,69.4375,6874.3125,6874.3125,0\nP,TEST_MODE,2025-02-20 09:38:48.861000+00:00,test-payout-2025-02-20,67d3e41db549716390b5455f,1,125.00,1.25,123.75,123.75,0\nP,TEST_MODE,2025-02-18 11:25:05.330000+00:00,test-payout-2025-02-18,67d3e41db549716390b54561,1,906.25,9.0625,897.1875,897.1875,0\nP,TEST_MODE,2025-02-18 09:20:47.886000+00:00,test-payout-2025-02-18,67d3e41db549716390b54563,1,125000.00,1250.00,123750.00,123750.00,0\nT,67d2930eab66aeaa3798bda5,,test-payout-2025-03-13,2025-03-13 08:23:09.314000+00:00,NET,123456789,,1.25,0.0125,1.2375,SETTLED,NOK,2025-03-13 08:23,\nT,67d15f3972cff55014d7db79,,test-payout-2025-03-12,2025-03-12 10:18:23.495000+00:00,NET,dfgds,,1250.00,12.50,1237.50,SETTLED,NOK,2025-03-12 10:18,\nT,67befd119d9096a7397167b7,,test-payout-2025-02-26,2025-02-26 11:38:48.226000+00:00,NET,Test,,1.25,0.0125,1.2375,SETTLED,NOK,2025-02-26 11:38,\nT,67bd9aed08ec2fddd8da4ac1,,test-payout-2025-02-25,2025-02-25 10:27:41.182000+00:00,NET,gdsgfdfg,,6943.75,69.4375,6874.3125,SETTLED,NOK,2025-02-25 10:27,\nT,67b6f7ee77b06c1a9e7416de,,test-payout-2025-02-20,2025-02-20 09:38:48.861000+00:00,NET,qweqwewq,,125.00,1.25,123.75,SETTLED,NOK,2025-02-20 09:38,\nT,67b46d815895ee63a6d6b558,,test-payout-2025-02-18,2025-02-18 11:25:05.330000+00:00,NET,qwewqeqwe,,906.25,9.0625,897.1875,SETTLED,NOK,2025-02-18 11:25,\nT,67b45091c1fd4d79ff1264ab,,test-payout-2025-02-18,2025-02-18 09:20:47.886000+00:00,NET,qweqwe,,125000.00,1250.00,123750.00,SETTLED,NOK,2025-02-18 09:20,\nT,67b4479ebd41a5adc588226c,,test-payout-2025-02-18,2025-02-18 08:41:43.831000+00:00,NET,qwewqewqe,,906.25,9.0625,897.1875,SETTLED,NOK,2025-02-18 08:41,\nT,67ae173061e1970428a2610b,,test-payout-2025-02-13,2025-02-13 16:02:24.891000+00:00,NET,qweqwewqe,,1250.00,12.50,1237.50,SETTLED,NOK,2025-02-13 16:02,\nT,67ae0f8f0841b4703d7ed577,,test-payout-2025-02-13,2025-02-13 15:28:51.899000+00:00,NET,123123,,1250.00,12.50,1237.50,SETTLED,NOK,2025-02-13 15:28,\nT,67ac6497dd520588af6c7b95,,test-payout-2025-02-12,2025-02-12 09:08:03.261000+00:00,NET,1235,,125.00,1.25,123.75,SETTLED,NOK,2025-02-12 09:08,","key":"machine_readable","summary":"Machine Readable CSV","id":"paths/~1settlements~1generate_csv/get/responses/200/content/text~1csv/examples/machine_readable"},"paths/~1payment-methods/get/responses/200/content/application~1json/examples/basic":{"value":[{"id":"000000000000000000000000","name":"Payment link via SMS/Email","type":"payment_link","active":true}],"key":"basic","summary":"Basic payment methods","id":"paths/~1payment-methods/get/responses/200/content/application~1json/examples/basic"},"paths/~1payment-methods/get/responses/200/content/application~1json/examples/with_terminals":{"value":[{"id":"000000000000000000000000","name":"Payment link via SMS/Email","type":"payment_link","active":true},{"id":"68551872ae7439dd2523da78","name":"Terminal 1","type":"terminal","active":true},{"id":"68551872ae7439dd2523da79","name":"Terminal 2","type":"terminal","active":true}],"key":"with_terminals","summary":"Payment methods with terminals","id":"paths/~1payment-methods/get/responses/200/content/application~1json/examples/with_terminals"}},"securitySchemeStore":{"HTTPBasic":{"id":"HTTPBasic","type":"http","scheme":"basic"},"OAuth2ClientCredentials":{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/partner/auth/token"}}}},"servers":[{"url":"https://api.spensepay.com/partner","description":"Production API"}],"logo":{"imageUrl":"http://app.spensepay.com/assets/spense-logo.svg","altText":"Spense"}},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/partner.json?download"},{"url":"/_bundle/apis/partner.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Spense Partner APIs","description":" "}},"baseSlug":"/apis/partner","routesMapping":{}}