{"components":{"parameters":{"outbox.OutboxQueryParams.createdFrom":{"description":"Start timestamp (inclusive) for filtering by the creation time of the outbox entry.","explode":false,"in":"query","name":"createdFrom","schema":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"outbox.OutboxQueryParams.createdTo":{"description":"End timestamp (inclusive) for filtering by the creation time of the outbox entry.","explode":false,"in":"query","name":"createdTo","schema":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"outbox.OutboxQueryParams.from":{"description":"Start timestamp (inclusive) for filtering outbox entries based on the status timestamp.","explode":false,"in":"query","name":"from","schema":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"outbox.OutboxQueryParams.to":{"description":"End timestamp (inclusive) for filtering outbox entries based on the status timestamp.","explode":false,"in":"query","name":"to","schema":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}}},"schemas":{"Amount":{"description":"Monetary amount with currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","examples":[23.56],"type":"number"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["amount","currency"],"type":"object"},"BillingGroupIdent":{"description":"Ident of the billing group.","examples":["613c060c-52bc-472e-bb2f-16cd431fef7b"],"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"ClientError":{"allOf":[{"$ref":"#/components/schemas/CommonError"}],"description":"Client error","type":"object"},"CommonError":{"description":"Common error","properties":{"errors":{"description":"Optional list of multiple errors occurred.\nMust not be null.","items":{"type":"object"},"type":"array"},"message":{"description":"Message describing the error.\nMust not be null.","type":"string"},"path":{"description":"URL path where the error occurred.\nMust not be null.","type":"string"},"status":{"description":"Textual representation of http status code, e.g. 'BAD_REQUEST' for status code 400.\nMust not be null.","type":"string"},"timestamp":{"description":"Timestamp in UTC when the error occurred.\nMust not be null.","format":"date-time","type":"string"},"uuid":{"description":"UUID generated by the server to identify the error occurred, should be stated in case of any inquiries.\nMust not be null.","type":"string"}},"required":["status","message","timestamp","path","uuid","errors"],"type":"object"},"CurrencyCode":{"description":"Currency code. Three letters ISO-4217 format.\n","examples":["EUR"],"type":"string"},"DocumentIdent":{"description":"Ident of a document a.k.a. document number.","examples":["613c060c-52bc-472e-bb2f-16cd431fef7b"],"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~/ -]*$","type":"string"},"Ident":{"description":"Unique identifier.","examples":["613c060c-52bc-472e-bb2f-16cd431fef7b"],"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"Page":{"description":"Pagination metadata","properties":{"number":{"description":"Page number of total pages available.\nMust not be null.","format":"uint32","type":"integer"},"size":{"description":"Size of the page as specified by the query.\nMust not be null.","format":"uint32","type":"integer"},"totalElements":{"description":"Total count of all elements available for the query.\nMust not be null.","format":"uint32","type":"integer"},"totalPages":{"description":"Total count of all pages available for the query.\nMust not be null.","format":"uint32","type":"integer"}},"required":["size","number","totalElements","totalPages"],"type":"object"},"Property":{"description":"Key/value property used in extensible property lists.","properties":{"key":{"description":"Key of the property, unique within a property list.\nMust not be null.\nSize must be greater than or equal to 1.","minLength":1,"type":"string"},"value":{"description":"Value of the property.\nMust not be null.","type":"string"}},"required":["key","value"],"type":"object"},"ServerError":{"allOf":[{"$ref":"#/components/schemas/CommonError"}],"description":"Server error","type":"object"},"StrictIdent":{"description":"Strict unique identifier limited to alphanumeric characters, underscore, and hyphen.","examples":["613c060c-52bc-472e-bb2f-16cd431fef7b"],"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_-]*$","type":"string"},"Versions":{"description":"Supported versions of the payment API.\nOne of:\n|             |                                                       |\n| ----------- | ----------------------------------------------------- |\n| payment-2.0 | Payment API version 2.0, the current public baseline. |\n| payment-3.0 | Payment API version 3.0.                              |","type":"string"},"authorization.CreatePaymentAuthorizationRequest":{"description":"Create Payment Authorization Request","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"authorizationReference":{"description":"The authorization reference from the payment service provider (e.g. Adyen `pspReference`).\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^\\S(.*\\S)?$.","maxLength":255,"minLength":1,"pattern":"^\\S(.*\\S)?$","type":"string"},"reference":{"$ref":"#/components/schemas/authorization.Reference"}},"required":["authorizationReference","reference","amount"],"type":"object"},"authorization.PagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/authorization.PaymentAuthorizationResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"Paged payment authorizations","type":"object"},"authorization.PaymentAuthorizationResponse":{"description":"Payment Authorisation","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"authorizationReference":{"description":"The authorization reference from the payment service provider (e.g. Adyen `pspReference`).\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^\\S(.*\\S)?$.","maxLength":255,"minLength":1,"pattern":"^\\S(.*\\S)?$","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"ident":{"$ref":"#/components/schemas/Ident"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"merchantPaymentAccountIdent":{"$ref":"#/components/schemas/Ident"},"reference":{"$ref":"#/components/schemas/authorization.Reference"}},"required":["ident","authorizationReference","reference","amount","createdAt","lastModifiedAt","merchantPaymentAccountIdent"],"type":"object"},"authorization.Reference":{"description":"The reference points to an entity for which this authorization is associated with","properties":{"ident":{"$ref":"#/components/schemas/Ident"},"type":{"$ref":"#/components/schemas/authorization.ReferenceType"}},"required":["type","ident"],"type":"object"},"authorization.ReferenceType":{"description":"The reference type.\nOne of:\n|          |          |\n| -------- | -------- |\n| ORDER    | Order    |\n| CONTRACT | Contract |","type":"string"},"outbox.OutboxEntryResponse":{"description":"Outbox Entry","properties":{"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"deleteAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"The delete timestamp"},"failures":{"description":"Number of failures.\nMust not be null.","format":"int32","minimum":0,"type":"integer"},"id":{"description":"The ID of the outbox entry.\nMust not be null.\nSize must be between 1 and 26.\nMust match the regular expression ^\\S(.*\\S)?$.","maxLength":26,"minLength":1,"pattern":"^\\S(.*\\S)?$","type":"string"},"ident":{"description":"The ident of the outbox entry. An entry does not necessarily require an ident. It serves as a convenience feature only.","type":["string","null"]},"lastFailureMessage":{"description":"Last failure message","type":["string","null"]},"nextRetryAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"The next retry timestamp"},"payload":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"The payload"},"status":{"$ref":"#/components/schemas/outbox.QueueStatus"},"statusHistory":{"description":"The status history.\nMust not be null.","items":{"$ref":"#/components/schemas/outbox.StatusHistory"},"type":"array"},"statusTimestamp":{"description":"The timestamp of the last status change.\nMust not be null.","format":"date-time","type":"string"},"tracingAttributes":{"additionalProperties":{"type":"string"},"description":"Tracing attributes.\nMust not be null.","type":"object"}},"required":["id","status","statusTimestamp","failures","createdAt","statusHistory","tracingAttributes"],"type":"object"},"outbox.QueueStatus":{"description":"One of:\n|            |\n| ---------- |\n| ENQUEUED   |\n| PROCESSING |\n| WAITING    |\n| PROCESSED  |\n| FAILED     |","type":"string"},"outbox.StatusHistory":{"description":"Status history entry","properties":{"status":{"$ref":"#/components/schemas/outbox.QueueStatus"},"timestamp":{"description":"The timestamp when the status occurred.\nMust not be null.","format":"date-time","type":"string"}},"required":["status","timestamp"],"type":"object"},"outbox.entry.PagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/outbox.OutboxEntryResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"Page of Outbox Entries","type":"object"},"payment_intent.AcceptedResponse":{"description":"Acknowledgement that a Payment Intent was accepted for processing.","properties":{"ident":{"description":"Ident of the Payment Intent.\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^[a-zA-Z0-9_.~-]*$.","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"status":{"$ref":"#/components/schemas/payment_intent.ProcessingStatus"}},"required":["ident","status"],"type":"object"},"payment_intent.AuthorizeAndCaptureChargeRequest":{"description":"Authorize the payment method and capture the amount. Uses the customer payment account ident. The payment service provider is taken from the merchant payment account resolved for that account and the charge currency.","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"chargeVariant":{"description":"Must be `AUTHORIZE_AND_CAPTURE`.\nMust not be null.","type":"string"},"customerPaymentAccountIdent":{"$ref":"#/components/schemas/Ident"},"ident":{"description":"Ident of the Payment Intent.\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^[a-zA-Z0-9_.~-]*$.","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"reference":{"$ref":"#/components/schemas/payment_intent.Reference"},"statementDescriptor":{"description":"Text shown on the customer's payment statement.\nMust not be null.","type":"string"}},"required":["ident","amount","reference","statementDescriptor","chargeVariant","customerPaymentAccountIdent"],"type":"object"},"payment_intent.CaptureOnlyChargeRequest":{"description":"Capture a previously authorized amount. Uses the merchant payment account ident.","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"chargeVariant":{"description":"Must be `CAPTURE_ONLY`.\nMust not be null.","type":"string"},"ident":{"description":"Ident of the Payment Intent.\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^[a-zA-Z0-9_.~-]*$.","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"merchantPaymentAccountIdent":{"$ref":"#/components/schemas/Ident"},"reference":{"$ref":"#/components/schemas/payment_intent.Reference"},"statementDescriptor":{"description":"Text shown on the customer's payment statement.\nMust not be null.","type":"string"}},"required":["ident","amount","reference","statementDescriptor","chargeVariant","merchantPaymentAccountIdent"],"type":"object"},"payment_intent.ChargeRequest":{"description":"Request body for a charge Payment Intent. `chargeVariant` selects the request shape.","discriminator":{"mapping":{"AUTHORIZE_AND_CAPTURE":"#/components/schemas/payment_intent.AuthorizeAndCaptureChargeRequest","CAPTURE_ONLY":"#/components/schemas/payment_intent.CaptureOnlyChargeRequest"},"propertyName":"chargeVariant"},"oneOf":[{"$ref":"#/components/schemas/payment_intent.AuthorizeAndCaptureChargeRequest"},{"$ref":"#/components/schemas/payment_intent.CaptureOnlyChargeRequest"}],"type":"object"},"payment_intent.ChargeVariant":{"description":"How a charge Payment Intent collects the amount, and which account ident that flow requires.\nOne of:\n|                       |                                                                                                                          |\n| --------------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| AUTHORIZE_AND_CAPTURE | Authorize the customer's payment method and capture the amount in one step. Requires the customer payment account ident. |\n| CAPTURE_ONLY          | Capture an amount that was authorized earlier. Requires the merchant payment account ident.                              |","type":"string"},"payment_intent.CustomerPaymentAccount":{"description":"Customer payment account charged or refunded at the payment service provider.","properties":{"accountHolderName":{"description":"Name of the account holder.","type":["string","null"]},"customerIdent":{"description":"Ident of the customer who owns this payment account.\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^\\S(.*\\S)?$.","maxLength":255,"minLength":1,"pattern":"^\\S(.*\\S)?$","type":"string"},"displayName":{"description":"Name shown for this payment account, for example on invoices.","type":["string","null"]},"ident":{"$ref":"#/components/schemas/Ident"},"paymentMethodReference":{"description":"Reference of the authorization or mandate for this payment method at the payment service provider.","type":["string","null"]},"paymentProviderReference":{"description":"Reference of the account at the payment service provider, for example the IBAN for direct debit.\nMust not be null.","type":"string"},"properties":{"description":"Custom key-value properties stored on the customer payment account.\nMust not be null.","items":{"$ref":"#/components/schemas/Property"},"type":"array"}},"required":["ident","customerIdent","paymentProviderReference","accountHolderName","displayName","properties"],"type":"object"},"payment_intent.MerchantPaymentAccount":{"description":"Merchant payment account at the payment service provider that collects a charge or returns a refund for a Payment Intent.","properties":{"ident":{"$ref":"#/components/schemas/Ident"}},"required":["ident"],"type":"object"},"payment_intent.OperationType":{"description":"Whether the Payment Intent collects an amount or returns funds from an earlier charge.\nOne of:\n|        |                                                                                                                                     |\n| ------ | ----------------------------------------------------------------------------------------------------------------------------------- |\n| CHARGE | Collects an amount. The merchant can start the collection, or the customer can start it, for example by paying through pay-by-link. |\n| REFUND | Returns funds to a customer for a prior charge.                                                                                     |","type":"string"},"payment_intent.PagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/payment_intent.Response"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"One page of Payment Intents.","type":"object"},"payment_intent.PaymentServiceProviderPagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/payment_intent.PaymentServiceProviderResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"One page of responses recorded from the payment service provider for a Payment Intent.","type":"object"},"payment_intent.PaymentServiceProviderResponse":{"description":"A response received after a PaymentServiceProvider (PSP) processed a PaymentIntent","properties":{"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"ident":{"description":"Ident of this provider response.\nMust not be null.","type":"string"},"recipient":{"description":"Recipient account or reference reported by the payment service provider.","type":["string","null"]},"sender":{"description":"Sender account or reference reported by the payment service provider.","type":["string","null"]},"statusMessage":{"description":"Status or error message returned by the payment service provider.","type":["string","null"]},"transactionAmounts":{"anyOf":[{"$ref":"#/components/schemas/payment_intent.PaymentServiceProviderTransactionAmounts"},{"type":"null"}],"description":"Amounts processed by the payment service provider."}},"required":["ident","createdAt"],"type":"object"},"payment_intent.PaymentServiceProviderTransactionAmounts":{"description":"Amounts processed by the payment service provider.","properties":{"baseAmount":{"$ref":"#/components/schemas/Amount"},"exchangeRate":{"description":"Rate used to convert `originalAmount` into `baseAmount`.\nMust not be null.","type":"number"},"originalAmount":{"$ref":"#/components/schemas/Amount"}},"required":["baseAmount","originalAmount","exchangeRate"],"type":"object"},"payment_intent.PaymentVariant":{"description":"One of:\n|                       |                                                                                                                          |\n| --------------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| AUTHORIZE_AND_CAPTURE | Authorize the customer's payment method and capture the amount in one step. Requires the customer payment account ident. |\n| CAPTURE_ONLY          | Capture an amount that was authorized earlier. Requires the merchant payment account ident.                              |\n| PAY_BY_LINK           | Payment Intent created when the customer pays through a pay-by-link.                                                     |","type":"string"},"payment_intent.ProcessingStatus":{"description":"Processing status of a Payment Intent.\nOne of:\n|                     |                                                                                                                               |\n| ------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| PENDING             | The Payment Intent is waiting to be processed, or processing is already underway.                                             |\n| SCHEDULED_FOR_RETRY | Processing hit a retryable error, such as insufficient funds, and another attempt is scheduled.                               |\n| FAILED              | Processing failed and no further automatic retry is scheduled. The Payment Intent can still be retried with the retry action. |\n| SUBMITTED           | The Payment Intent was submitted to the payment service provider and is waiting for the provider result.                      |\n| CANCELLED           | The Payment Intent was cancelled. No further payment attempts will be made.                                                   |\n| PROCESSED           | The payment service provider processed the Payment Intent successfully.                                                       |","type":"string"},"payment_intent.Reference":{"description":"Reference to a document.","properties":{"ident":{"$ref":"#/components/schemas/DocumentIdent"},"type":{"description":"Must be `DOCUMENT`.\nMust not be null.","enum":["DOCUMENT"],"type":"string"}},"required":["type","ident"],"type":"object"},"payment_intent.RefundRequest":{"description":"Request body for a refund Payment Intent.","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"documentReferenceIdent":{"$ref":"#/components/schemas/DocumentIdent"},"ident":{"description":"Ident of the refund Payment Intent.\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^[a-zA-Z0-9_.~-]*$.","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"refundTargetIdent":{"description":"Ident of the processed charge Payment Intent to refund.\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^[a-zA-Z0-9_.~-]*$.","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"statementDescriptor":{"description":"Text shown on the customer's payment statement.\nMust not be null.","type":"string"}},"required":["ident","refundTargetIdent","documentReferenceIdent","statementDescriptor","amount"],"type":"object"},"payment_intent.ReplaceFailedPaymentIntentsActionRequest":{"description":"Customer payment accounts whose charge Payment Intents should be moved onto another customer payment account.","properties":{"customerPaymentAccountIdentsToReplace":{"description":"Customer payment accounts whose charge Payment Intents are replaced. At least one ident is required.\nMust not be null.\nSize must be greater than or equal to 1.","items":{"$ref":"#/components/schemas/Ident"},"minItems":1,"type":"array"},"targetCustomerPaymentAccountIdent":{"$ref":"#/components/schemas/Ident"}},"required":["targetCustomerPaymentAccountIdent","customerPaymentAccountIdentsToReplace"],"type":"object"},"payment_intent.Response":{"description":"A Payment Intent, including its processing status and the accounts involved.","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"attemptCount":{"description":"Number of times processing has been attempted with the payment service provider, including the first attempt.\nMust not be null.","format":"int16","type":"integer"},"billingGroupIdent":{"anyOf":[{"$ref":"#/components/schemas/BillingGroupIdent"},{"type":"null"}],"description":"Ident of the billing group. `null` before the document context is resolved, for example before processing of a newly created Payment Intent is started."},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"customerPaymentAccount":{"anyOf":[{"$ref":"#/components/schemas/payment_intent.CustomerPaymentAccount"},{"type":"null"}],"description":"Customer payment account charged or refunded. Absent when the Payment Intent does not use one."},"ident":{"description":"Ident of the Payment Intent.\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^[a-zA-Z0-9_.~-]*$.","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"lastAttemptAt":{"description":"Date and time of the latest processing attempt with the payment service provider.\nMust not be null.","format":"date-time","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"merchantPaymentAccount":{"$ref":"#/components/schemas/payment_intent.MerchantPaymentAccount"},"oposCaseIdent":{"anyOf":[{"$ref":"#/components/schemas/Ident"},{"type":"null"}],"description":"Ident of the open-items case this Payment Intent belongs to."},"paymentProviderType":{"$ref":"#/components/schemas/provider.PaymentServiceProviderType"},"paymentTransactionIdent":{"anyOf":[{"$ref":"#/components/schemas/Ident"},{"type":"null"}],"description":"Ident of the payment transaction created for this Payment Intent."},"paymentVariant":{"anyOf":[{"$ref":"#/components/schemas/payment_intent.PaymentVariant"},{"type":"null"}],"description":"Set when type is `CHARGE`. Describes how the amount is collected. `null` when type is `REFUND`."},"reference":{"$ref":"#/components/schemas/payment_intent.Reference"},"retry":{"$ref":"#/components/schemas/payment_intent.Retry"},"statementDescriptor":{"description":"Text shown on the customer's payment statement.\nMust not be null.","type":"string"},"status":{"$ref":"#/components/schemas/payment_intent.ProcessingStatus"},"type":{"$ref":"#/components/schemas/payment_intent.OperationType"}},"required":["ident","amount","reference","statementDescriptor","billingGroupIdent","paymentProviderType","merchantPaymentAccount","status","type","retry","attemptCount","lastAttemptAt","createdAt","lastModifiedAt"],"type":"object"},"payment_intent.Retry":{"description":"Latest automatic retry of a Payment Intent.","properties":{"final":{"description":"True when this attempt is the last retry and no further retry will be scheduled.\nMust not be null.","type":"boolean"},"ident":{"$ref":"#/components/schemas/Ident"}},"required":["ident","final"],"type":"object"},"payment_link.CreateRequest":{"description":"Create Payment Link Request","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"documentReferenceIdent":{"$ref":"#/components/schemas/Ident"},"ident":{"$ref":"#/components/schemas/Ident"},"oposCaseIdent":{"$ref":"#/components/schemas/Ident"}},"required":["ident","amount","documentReferenceIdent","oposCaseIdent"],"type":"object"},"payment_link.PagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/payment_link.Response"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"Paged payment links","type":"object"},"payment_link.Response":{"description":"Payment link","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"documentReferenceIdent":{"$ref":"#/components/schemas/Ident"},"expiresAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Point in time when the payment link expires. Absent while the link is pending."},"ident":{"$ref":"#/components/schemas/Ident"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"merchantPaymentAccountIdent":{"$ref":"#/components/schemas/Ident"},"oposCaseIdent":{"$ref":"#/components/schemas/Ident"},"status":{"$ref":"#/components/schemas/payment_link.Status"},"url":{"description":"URL of the payment link. Absent while the link is pending.","type":["string","null"]}},"required":["ident","amount","documentReferenceIdent","oposCaseIdent","merchantPaymentAccountIdent","status","createdAt","lastModifiedAt"],"type":"object"},"payment_link.Status":{"description":"Status of a payment link","properties":{"name":{"$ref":"#/components/schemas/payment_link.StatusName"},"reason":{"anyOf":[{"$ref":"#/components/schemas/payment_link.StatusReason"},{"type":"null"}],"description":"Why the payment link has this status. Absent while the link is pending or active."}},"required":["name"],"type":"object"},"payment_link.StatusName":{"description":"Name of a payment link status.\nOne of:\n|           |                                                                |\n| --------- | -------------------------------------------------------------- |\n| PENDING   | The payment link is stored and not yet created at the provider |\n| ACTIVE    | The payment link can still be used                             |\n| INACTIVE  | The payment link can no longer be used                         |\n| COMPLETED | The payment link has been paid                                 |","type":"string"},"payment_link.StatusReason":{"description":"Reason a payment link has its status.\nOne of:\n|             |                                     |\n| ----------- | ----------------------------------- |\n| DEACTIVATED | The payment link was deactivated    |\n| EXPIRED     | The payment link is past its expiry |","type":"string"},"provider.Environment":{"description":"Environment.\nOne of:\n|             |                     |\n| ----------- | ------------------- |\n| DEVELOPMENT | Testing Environment |\n| PRODUCTION  | Live Environment    |","type":"string"},"provider.PaymentServiceProviderType":{"description":"Type of the PaymentServiceProvider.\nOne of:\n|        |        |\n| ------ | ------ |\n| STRIPE | Stripe |\n| ADYEN  | Adyen  |\n| SBA    | SBA    |","type":"string"},"provider.Polling":{"description":"Polling schedule","properties":{"enabled":{"description":"Enables or disables the schedule.\nMust not be null.","type":"boolean"},"type":{"$ref":"#/components/schemas/provider.PollingScheduleType"},"value":{"description":"The value of the schedule.\nMust not be null.","type":"string"}},"required":["enabled","value","type"],"type":"object"},"provider.PollingScheduleType":{"description":"Type of the polling schedule.\nOne of:\n|                     |                                                                      |\n| ------------------- | -------------------------------------------------------------------- |\n| DAY_OF_MONTH        | Define a day of month when the schedule is triggered. Value: 1 to 31 |\n| INTERVAL_IN_MINUTES | Define interval in minutes after which the schedule is triggered.    |\n| INTERVAL_IN_HOURS   | Define interval in hours after which the schedule is triggered.      |\n| INTERVAL_IN_DAYS    | Define interval in days after which the schedule is triggered.       |","type":"string"},"provider.Retry":{"description":"Retry schedule","properties":{"maxAttempts":{"description":"Max retry attempts.\nMust not be null.","format":"int8","type":"integer"},"schedule":{"$ref":"#/components/schemas/provider.Schedule"}},"required":["maxAttempts","schedule"],"type":"object"},"provider.RetryScheduleType":{"description":"Type of the retry schedule.\nOne of:\n|                              |                                                                                                                          |\n| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| DAY_OF_MONTH                 | Define a day of month when the schedule is triggered. Value: 1 to 31                                                     |\n| DAY_OF_MONTH_UNTIL_MONTH_END | Define days of month when retries run. The attempt on the last configured day of the month is final. Value: 1 to 31 or L |\n| INTERVAL_IN_MINUTES          | Define interval in minutes after which the schedule is triggered.                                                        |\n| INTERVAL_IN_HOURS            | Define interval in hours after which the schedule is triggered.                                                          |\n| INTERVAL_IN_DAYS             | Define interval in days after which the schedule is triggered.                                                           |","type":"string"},"provider.Schedule":{"description":"Schedule","properties":{"enabled":{"description":"Enables or disables the schedule.\nMust not be null.","type":"boolean"},"type":{"$ref":"#/components/schemas/provider.RetryScheduleType"},"value":{"description":"The value of the schedule.\nMust not be null.","type":"string"}},"required":["enabled","value","type"],"type":"object"},"provider.TriggerRetryRequest":{"description":"Request to retry Payment Intents which are scheduled for retry","properties":{"attemptLessOrEqualThan":{"anyOf":[{"format":"int32","type":"integer"},{"type":"null"}],"description":"Only retry Payment Intents where attemptCount is less or equal than this value"},"lastAttemptBefore":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Only retry Payment Intents where lastAttempt is older than this timestamp"},"merchantPaymentAccountIdent":{"description":"Merchant payment account ident that scopes which Payment Intents to retry.\nMust not be null.","type":"string"},"paymentProviderType":{"$ref":"#/components/schemas/provider.PaymentServiceProviderType"}},"required":["paymentProviderType","merchantPaymentAccountIdent"],"type":"object"},"provider.adyen.configuration.ApiKeyResponse":{"description":"Adyen API-Key","properties":{"apiKey":{"description":"The API-Key for Adyen.\nMust not be null.\nSize must be less than or equal to 255.","format":"password","maxLength":255,"type":"string"}},"required":["apiKey"],"type":"object"},"provider.adyen.configuration.AuthorizationMode":{"description":"Defines how Adyen authorizations are handled for charges.\nOne of:\n|                        |                                                       |\n| ---------------------- | ----------------------------------------------------- |\n| PRE_AUTHORIZED         | Use existing authorization for capture.               |\n| AUTHORIZE_THEN_CAPTURE | Authorize and capture the payment in one charge flow. |","type":"string"},"provider.adyen.configuration.CreateOrUpdateApiKeyRequest":{"description":"Create or update a Adyen API-Key","properties":{"apiKey":{"description":"The API-Key for Adyen.\nMust not be null.\nSize must be less than or equal to 255.","format":"password","maxLength":255,"type":"string"}},"required":["apiKey"],"type":"object"},"provider.adyen.configuration.CreateOrUpdateRequest":{"description":"Request to create or update a Adyen configuration","properties":{"authorizationMode":{"anyOf":[{"$ref":"#/components/schemas/provider.adyen.configuration.AuthorizationMode"},{"type":"null"}],"description":"Adyen authorization mode."},"enabled":{"description":"Enables or disables the processing of Payment Intents.\nMust not be null.","type":"boolean"},"liveUrlPrefix":{"description":"Adyen live URL prefix see https://docs.adyen.com/development-resources/live-endpoints#live-url-prefix","type":["string","null"]},"merchantAccount":{"description":"Adyen merchant account.\nMust not be null.","type":"string"},"merchantPaymentAccountIdent":{"description":"Merchant payment account used to validate Payment Intents and store settlements.\nMust not be null.","type":"string"},"name":{"description":"Display name of the configuration.\nMust not be null.","type":"string"},"recurringProcessingModel":{"$ref":"#/components/schemas/provider.adyen.configuration.RecurringProcessingModel"},"retry":{"$ref":"#/components/schemas/provider.Retry"}},"required":["name","retry","enabled","merchantPaymentAccountIdent","merchantAccount","recurringProcessingModel"],"type":"object"},"provider.adyen.configuration.PagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/provider.adyen.configuration.Response"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"Page of Adyen configurations","type":"object"},"provider.adyen.configuration.RecurringProcessingModel":{"description":"Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nOne of:\n|                          |                                                                                                                                    |\n| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |\n| SUBSCRIPTION             | A transaction for a fixed or variable amount, which follows a fixed schedule.                                                      |\n| UNSCHEDULED_CARD_ON_FILE | An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/ or have variable amounts. |","type":"string"},"provider.adyen.configuration.Response":{"description":"Adyen configuration","properties":{"authorizationMode":{"$ref":"#/components/schemas/provider.adyen.configuration.AuthorizationMode"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"enabled":{"description":"Enables or disables the processing of Payment Intents.\nMust not be null.","type":"boolean"},"environment":{"$ref":"#/components/schemas/provider.Environment"},"ident":{"$ref":"#/components/schemas/StrictIdent"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"liveUrlPrefix":{"description":"Adyen live URL prefix see https://docs.adyen.com/development-resources/live-endpoints#live-url-prefix","type":["string","null"]},"merchantAccount":{"description":"Adyen merchant account.\nMust not be null.","type":"string"},"merchantPaymentAccountIdent":{"description":"Merchant payment account used to validate Payment Intents and store settlements.\nMust not be null.","type":"string"},"name":{"description":"Display name of the configuration.\nMust not be null.","type":"string"},"recurringProcessingModel":{"$ref":"#/components/schemas/provider.adyen.configuration.RecurringProcessingModel"},"retry":{"$ref":"#/components/schemas/provider.Retry"}},"required":["ident","environment","name","retry","enabled","createdAt","lastModifiedAt","merchantPaymentAccountIdent","liveUrlPrefix","merchantAccount","recurringProcessingModel","authorizationMode"],"type":"object"},"provider.sba.TransactionError":{"description":"Detailed error information","properties":{"adapter_advice_code":{"description":"Processor advice code (e.g. 54: Expired card)","type":["string","null"]},"adapter_code":{"description":"Adapter response code (e.g. 54)","type":["string","null"]},"adapter_message":{"description":"Adapter response message (e.g. Expired card)","type":["string","null"]},"code":{"description":"Error code","type":["string","null"]},"do_not_resubmit":{"description":"Indicates whether the request should not be retried","type":["boolean","null"]},"message":{"description":"High-level error message","type":["string","null"]}},"type":"object"},"provider.sba.TransactionStatus":{"description":"Transaction status.\nOne of:\n|         |                       |\n| ------- | --------------------- |\n| SUCCESS | Succeeded transaction |\n| FAILED  | Failed transaction    |\n| PENDING | Pending transaction   |","type":"string"},"provider.sba.TransactionType":{"description":"Transaction type.\nOne of:\n|        |                    |\n| ------ | ------------------ |\n| DEBIT  | Debit transaction  |\n| REFUND | Refund transaction |\n| OTHER  | Other transaction  |","type":"string"},"provider.sba.action.StatusRequest":{"description":"Transaction status request","properties":{"error":{"anyOf":[{"$ref":"#/components/schemas/provider.sba.TransactionError"},{"type":"null"}],"description":"Error information (if applicable)"},"status":{"$ref":"#/components/schemas/provider.sba.TransactionStatus"},"status_timestamp":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp when the status became effective"},"transaction_id":{"description":"SBA transaction ID identifying a specific transaction.\nSize must be between 1 and 255.","maxLength":255,"minLength":1,"type":["string","null"]},"transaction_ident":{"description":"External ID identifying a specific transaction.\nMust not be null.\nSize must be between 1 and 255.","maxLength":255,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/provider.sba.TransactionType"}},"required":["transaction_ident","status","type"],"type":"object"},"provider.sba.configuration.CreateOrUpdateRequest":{"description":"Request to create or update an SBA configuration","properties":{"baseUrl":{"description":"The base url.\nMust not be null.","examples":["https://int.retailservices.audi.de/ccsmtzsba/v1/api/"],"format":"uri","type":"string"},"enabled":{"description":"Enables or disables the processing of Payment Intents.\nMust not be null.","type":"boolean"},"name":{"description":"Display name of the configuration.\nMust not be null.","type":"string"},"retry":{"$ref":"#/components/schemas/provider.Retry"},"security":{"$ref":"#/components/schemas/provider.sba.configuration.SecurityConfiguration"}},"required":["name","retry","enabled","security","baseUrl"],"type":"object"},"provider.sba.configuration.PagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/provider.sba.configuration.Response"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"Page of SBA configurations","type":"object"},"provider.sba.configuration.Response":{"description":"SBA configuration","properties":{"baseUrl":{"description":"The base url.\nMust not be null.","examples":["https://int.retailservices.audi.de/ccsmtzsba/v1/api/"],"format":"uri","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"enabled":{"description":"Enables or disables the processing of Payment Intents.\nMust not be null.","type":"boolean"},"environment":{"$ref":"#/components/schemas/provider.Environment"},"ident":{"$ref":"#/components/schemas/StrictIdent"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"name":{"description":"Display name of the configuration.\nMust not be null.","type":"string"},"retry":{"$ref":"#/components/schemas/provider.Retry"},"security":{"$ref":"#/components/schemas/provider.sba.configuration.SecurityConfiguration"}},"required":["ident","environment","name","retry","enabled","createdAt","lastModifiedAt","security","baseUrl"],"type":"object"},"provider.sba.configuration.SecurityConfiguration":{"description":"Configuration required to authorize Payment Intent requests.","properties":{"audience":{"description":"Client audience. Required to generate secret.\nMust not be null.","type":"string"},"keyId":{"description":"Indicator of the key.\nMust not be null.","type":"string"},"subject":{"description":"Client subject. Required to generate secret.\nMust not be null.","type":"string"},"tokenUrl":{"description":"Url used to fetch the valid token used for requests.\nMust not be null.","type":"string"}},"required":["keyId","tokenUrl","audience","subject"],"type":"object"},"provider.stripe.configuration.ApiKeyCreateOrUpdateRequest":{"description":"Create or update a Stripe API-Key","properties":{"apiKey":{"description":"The API-Key for Stripe.\nMust not be null.\nSize must be less than or equal to 255.","format":"password","maxLength":255,"type":"string"}},"required":["apiKey"],"type":"object"},"provider.stripe.configuration.ApiKeyResponse":{"description":"Stripe API-Key","properties":{"apiKey":{"description":"The API-Key for Stripe.\nMust not be null.\nSize must be less than or equal to 255.","format":"password","maxLength":255,"type":"string"}},"required":["apiKey"],"type":"object"},"provider.stripe.configuration.CreateOrUpdateRequest":{"description":"Request to create or update a Stripe configuration","properties":{"enabled":{"description":"Enables or disables the processing of Payment Intents.\nMust not be null.","type":"boolean"},"merchantPaymentAccountIdent":{"description":"Merchant payment account used to validate Payment Intents and store settlements.\nMust not be null.","type":"string"},"name":{"description":"Display name of the configuration.\nMust not be null.","type":"string"},"retry":{"$ref":"#/components/schemas/provider.Retry"}},"required":["name","retry","enabled","merchantPaymentAccountIdent"],"type":"object"},"provider.stripe.configuration.PagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/provider.stripe.configuration.Response"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"Page of Stripe configurations","type":"object"},"provider.stripe.configuration.Response":{"description":"Stripe configuration","properties":{"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"enabled":{"description":"Enables or disables the processing of Payment Intents.\nMust not be null.","type":"boolean"},"environment":{"$ref":"#/components/schemas/provider.Environment"},"ident":{"$ref":"#/components/schemas/StrictIdent"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"merchantPaymentAccountIdent":{"description":"Merchant payment account used to validate Payment Intents and store settlements.\nMust not be null.","type":"string"},"name":{"description":"Display name of the configuration.\nMust not be null.","type":"string"},"retry":{"$ref":"#/components/schemas/provider.Retry"}},"required":["ident","environment","name","retry","enabled","createdAt","lastModifiedAt","merchantPaymentAccountIdent"],"type":"object"}},"securitySchemes":{"oauth2":{"description":"OAuth2 client-credentials authentication scheme.","flows":{"clientCredentials":{"scopes":{"accounts-receivable-management-read":"","accounts-receivable-management-write":"","custom-payment-provider-write":"","internal":"","tenant-management-read":"","tenant-management-write":""},"tokenUrl":"https://api.instellix.io/<tenant_short>/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"Endpoints regarding Payment Intents.","title":"Payment Intent API","version":"v2-4.22.9"},"openapi":"3.1.0","paths":{"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/payment-authorizations":{"get":{"description":"Query payment authorizations","operationId":"queryPaymentAuthorizations","parameters":[{"description":"Ident of a merchant payment account","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"$ref":"#/components/schemas/Ident"}},{"description":"Use RSQL query language.\nSee: https://aboullaite.me/rsql/.","explode":false,"in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Must be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100. Must be greater than or equal to 1.","in":"query","name":"size","schema":{"default":50,"maximum":100,"minimum":1,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.","in":"query","name":"sort","schema":{"default":["ident"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/authorization.PagedResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Query payment authorizations","tags":["Authorization"]},"post":{"description":"Create a payment authorization","operationId":"createPaymentAuthorization","parameters":[{"description":"Ident of a merchant payment account","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"$ref":"#/components/schemas/Ident"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/authorization.CreatePaymentAuthorizationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/authorization.PaymentAuthorizationResponse"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Create a payment authorization","tags":["Authorization"]}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/payment-authorizations/{ident}":{"delete":{"description":"Delete a payment authorization","operationId":"deletePaymentAuthorization","parameters":[{"description":"Ident of a merchant payment account","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"$ref":"#/components/schemas/Ident"}},{"in":"path","name":"ident","required":true,"schema":{"$ref":"#/components/schemas/Ident"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Delete a payment authorization.","tags":["Authorization"]},"get":{"description":"Retrieve a payment authorization","operationId":"retrievePaymentAuthorization","parameters":[{"description":"Ident of a merchant payment account","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"$ref":"#/components/schemas/Ident"}},{"in":"path","name":"ident","required":true,"schema":{"$ref":"#/components/schemas/Ident"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/authorization.PaymentAuthorizationResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Retrieve payment authorization.","tags":["Authorization"]}},"/v2/payment-authorizations":{"get":{"description":"Query all payment authorizations","operationId":"queryAllPaymentAuthorizations","parameters":[{"description":"Use RSQL query language.\nSee: https://aboullaite.me/rsql/.","explode":false,"in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Must be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100. Must be greater than or equal to 1.","in":"query","name":"size","schema":{"default":50,"maximum":100,"minimum":1,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.","in":"query","name":"sort","schema":{"default":["ident"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/authorization.PagedResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Query all payment authorizations","tags":["Authorization"]}}},"servers":[{"description":"Instellix Production","url":"https://api.instellix.io"}],"tags":[{"description":"Authorization API","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Authorization"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true},"x-tagGroups":[{"name":"Provider","tags":["SBA Configuration","SBA Action","Adyen Configuration","Stripe Configuration","Payment Providers"]},{"name":"Processing","tags":["Outbox Internal","Payment Intent","Payment Intent Support","Authorization","PaymentLink"]}]}