{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-documentation/get_started/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Authorisation","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"authorisation","__idx":0},"children":["Authorisation"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authorisation"]}," is the process by which the card issuer verifies the cardholder’s payment details and, if there are no reasons to decline (e.g. insufficient funds), reserves the amount for a set period."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authorise-only","__idx":2},"children":["Authorise Only"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An authorised payment can usually be handled in one of two ways:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Voided"]},": the hold is cancelled and the funds are released back to the cardholder."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Captured"]},": the funds are submitted for clearing and claimed from the cardholder’s account."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The example shown below demonstrates a Payment Session creation request that will automatically capture funds once the payment is authorised. This is the default behaviour."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"Automatic Capture - Payload Example","header":{"title":"Automatic Capture - Payload Example","controls":{"copy":{}}},"source":"{\n  \"amount\": 54550,\n  \"currency\": \"GBP\",\n  \"customerEmail\": \"test@mail.com\",\n  \"captureFlow\": \"Automatic\"  // Or omit this field entirely as Automatic is the default\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["However, for certain business models, it may be preferable, or necessary, to delay capture."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a payment is authorised but not yet captured, the funds remain in the cardholder’s account. This offers greater flexibility to address scenarios such as fraud, stock issues, or order cancellations."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To create an authorise-only Payment Session, set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["captureFlow"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Manual"]}," via the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/api/reference/openapi#operation/paymentSessionCreate"},"children":["paymentSessionCreate"]}," endpoint as shown below:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"Manual Capture - Payload Example","header":{"title":"Manual Capture - Payload Example","controls":{"copy":{}}},"source":"{\n  \"amount\": 54550,\n  \"currency\": \"GBP\",\n  \"customerEmail\": \"test@mail.com\",\n  \"captureFlow\": \"Manual\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authorisation-validity","__idx":3},"children":["Authorisation Validity"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["duration"]}," for which funds remain reserved depends on the card scheme involved. The following table shows how this varies per scheme:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Card Scheme"},"children":["Card Scheme"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Authorisation validity"},"children":["Authorisation validity"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Visa"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["7 days / 5 days for Merchant-initiated transactions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Mastercard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["7 Days"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["American Express"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["7 Days"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the payment is not captured within this timeframe, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["the authorisation will expire"]},", and the reserved funds will be released back to the cardholder."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"next-steps","__idx":4},"children":["Next Steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["process"]}," an authorise-only payment, you can follow the steps outlined in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/get_started/process_payments"},"children":["Initial Setup"]}," guide. Authorising payments does not require any particular SDK configuration."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["capture"]}," an authorised payment, you can follow the steps outlined in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/get_started/manage_payments/capture"},"children":["Capture"]}," guide."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["void"]}," an authorised payment, you can follow the steps outlined in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/get_started/manage_payments/void"},"children":["Void"]}," guide."]}]}]},"headings":[{"value":"Authorisation","id":"authorisation","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Authorise Only","id":"authorise-only","depth":2},{"value":"Authorisation Validity","id":"authorisation-validity","depth":3},{"value":"Next Steps","id":"next-steps","depth":3}],"frontmatter":{"seo":{"title":"Authorisation"}},"lastModified":"2026-03-13T08:30:00.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/documentation/get_started/initiate_payments/additional_settings/authorisation","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}