### Example Error Response (Generic) Source: https://context7.com/spayd/paylibo-restapi/llms.txt Illustrates the typical JSON error response structure for API endpoints when validation fails or exceptions occur, such as an invalid IBAN format. ```bash curl -X GET "http://localhost:8080/paylibo/generator/string?iban=INVALID" ``` -------------------------------- ### GET /paylibo/generator/czech/spayd Source: https://context7.com/spayd/paylibo-restapi/llms.txt Creates a downloadable SPAYD file for Czech bank account payments. ```APIDOC ## GET /paylibo/generator/czech/spayd ### Description Generates a downloadable .spayd file for payment information. ### Method GET ### Endpoint /paylibo/generator/czech/spayd ### Parameters #### Query Parameters - **accountNumber** (string) - Required - The recipient's account number - **bankCode** (string) - Required - The bank code - **amount** (number) - Optional - Payment amount - **currency** (string) - Optional - Currency code - **vs** (string) - Optional - Variable symbol - **message** (string) - Optional - Payment message ### Response #### Success Response (200) - **Content-Type** (application/x-shortpaymentdescriptor) - The SPAYD file content ``` -------------------------------- ### Example Error Response (Multiple Validation Errors) Source: https://context7.com/spayd/paylibo-restapi/llms.txt Demonstrates the JSON error response format when multiple validation errors occur, such as invalid account number and amount formats in a SPAYD string. ```bash curl -X GET "http://localhost:8080/paylibo/validator/string?paymentString=SPD*1.0*ACC:INVALID*AM:abc" ``` -------------------------------- ### GET /paylibo/generator/czech/image Source: https://context7.com/spayd/paylibo-restapi/llms.txt Generates a Czech payment QR code image based on provided account details and payment information. ```APIDOC ## GET /paylibo/generator/czech/image ### Description Generates a QR code image for Czech bank payments. ### Method GET ### Endpoint /paylibo/generator/czech/image ### Parameters #### Query Parameters - **accountNumber** (string) - Required - The recipient's account number - **accountPrefix** (string) - Optional - The account prefix - **bankCode** (string) - Required - The bank code - **amount** (number) - Optional - Payment amount - **currency** (string) - Optional - Currency code (e.g., CZK) - **vs** (string) - Optional - Variable symbol - **ks** (string) - Optional - Constant symbol - **ss** (string) - Optional - Specific symbol - **message** (string) - Optional - Payment message - **size** (integer) - Optional - QR code size in pixels - **branding** (boolean) - Optional - Include branding in the QR code ### Response #### Success Response (200) - **Content-Type** (image/png) - The generated QR code image ``` -------------------------------- ### GET /paylibo/validator/string Source: https://context7.com/spayd/paylibo-restapi/llms.txt Validates a SPAYD payment string format and its required fields. ```APIDOC ## GET /paylibo/validator/string ### Description Validates a SPAYD string. Returns 'OK' if valid, or a list of errors if invalid. ### Method GET ### Endpoint /paylibo/validator/string ### Parameters #### Query Parameters - **paymentString** (string) - Required - The SPAYD string to validate ### Response #### Success Response (200) - **body** (string) - "OK" #### Error Response (400) - **description** (string) - Error summary - **errors** (array) - List of validation error objects ``` -------------------------------- ### GET /paylibo/validator/iban Source: https://context7.com/spayd/paylibo-restapi/llms.txt Performs an IBAN lookup to verify validity and retrieve associated bank information. ```APIDOC ## GET /paylibo/validator/iban ### Description Validates an IBAN and returns associated bank details. ### Method GET ### Endpoint /paylibo/validator/iban ### Parameters #### Query Parameters - **iban** (string) - Required - The IBAN to validate ### Response #### Success Response (200) - **result** (string) - Status of the lookup - **iban** (string) - The validated IBAN ``` -------------------------------- ### Generate Minimal Czech QR Code Source: https://context7.com/spayd/paylibo-restapi/llms.txt Generates a minimal Czech QR code image with essential payment details. This is useful for quick payment requests where fewer details are needed. ```bash curl -X GET "http://localhost:8080/paylibo/generator/czech/image?accountNumber=19012345&bankCode=0100&amount=150.00&size=250&branding=false" --output quick_payment.png ``` -------------------------------- ### Generate Czech Payment QR Code Source: https://context7.com/spayd/paylibo-restapi/llms.txt Generates a Czech payment QR code image with all specified details. Ensure all required parameters are provided for a complete payment request. ```bash curl -X GET "http://localhost:8080/paylibo/generator/czech/image?accountNumber=2000145399&accountPrefix=19&bankCode=0800&amount=999.00¤cy=CZK&vs=123456&ks=0558&ss=987654&message=Platba%20za%20sluzby&size=350&branding=true" --output czech_payment.png ``` -------------------------------- ### Download SPAYD Payment File Source: https://context7.com/spayd/paylibo-restapi/llms.txt Retrieves a .spayd file for use in compatible banking applications. ```bash # Download SPAYD payment file curl -X GET "http://localhost:8080/paylibo/generator/spayd?iban=CZ6508000000192000145399&bic=GIBACZPX&amount=750.00¤cy=CZK&recipientName=Supplier%20Ltd&message=Order%2045678" --output payment_info.spayd # Response headers: # Content-Type: application/x-shortpaymentdescriptor # Content-Disposition: attachment; filename="payment_info.spayd" # Access-Control-Allow-Origin: * # File contents: # SPD*1.0*ACC:CZ6508000000192000145399*BIC:GIBACZPX*AM:750.00*CC:CZK*RN:Supplier Ltd*MSG:Order 45678 ``` -------------------------------- ### Download Czech SPAYD File Source: https://context7.com/spayd/paylibo-restapi/llms.txt Creates a downloadable payment file in SPAYD format for Czech bank account payments. This endpoint is useful for offline payment processing or distribution. ```bash curl -X GET "http://localhost:8080/paylibo/generator/czech/spayd?accountNumber=2000145399&bankCode=0800&amount=3500.00¤cy=CZK&vs=2024000123&message=Najem%20unor%202024" --output najem.spayd ``` -------------------------------- ### Generate IBAN SPAYD Payment String Source: https://context7.com/spayd/paylibo-restapi/llms.txt Use these endpoints to generate a SPAYD-formatted string from IBAN details. The response is returned as plain text. ```bash # Generate a basic SPAYD payment string with IBAN curl -X GET "http://localhost:8080/paylibo/generator/string?iban=CZ6508000000192000145399&bic=GIBACZPX&amount=450.00¤cy=CZK&recipientName=Jan%20Novak&message=Invoice%20123" # Response (text/plain): # SPD*1.0*ACC:CZ6508000000192000145399*BIC:GIBACZPX*AM:450.00*CC:CZK*RN:Jan Novak*MSG:Invoice 123 # Generate payment string with due date and sender reference curl -X GET "http://localhost:8080/paylibo/generator/string?iban=DE89370400440532013000&bic=COBADEFFXXX&amount=1500.50¤cy=EUR&date=2024-03-15&sendersReference=REF-2024-001&recipientName=Deutsche%20Company&message=Payment%20for%20services" # Response (text/plain): # SPD*1.0*ACC:DE89370400440532013000*BIC:COBADEFFXXX*AM:1500.50*CC:EUR*DT:20240315*RF:REF-2024-001*RN:Deutsche Company*MSG:Payment for services ``` -------------------------------- ### Generate SPAYD QR Code Image Source: https://context7.com/spayd/paylibo-restapi/llms.txt Generates a PNG image containing a QR code. Use the --output flag to save the binary response to a file. ```bash # Generate QR code image with default size (returns PNG image) curl -X GET "http://localhost:8080/paylibo/generator/image?iban=CZ6508000000192000145399&amount=250.00¤cy=CZK&message=Donation" --output payment_qr.png # Generate larger QR code (size in pixels) with SPAYD branding curl -X GET "http://localhost:8080/paylibo/generator/image?iban=CZ6508000000192000145399&bic=GIBACZPX&amount=1000.00¤cy=CZK&recipientName=Charity%20Org&message=Monthly%20donation&size=400&branding=true" --output donation_qr.png # Generate QR code without SPAYD branding curl -X GET "http://localhost:8080/paylibo/generator/image?iban=SK3112000000198742637541&amount=99.99¤cy=EUR&size=300&branding=false&compress=true" --output simple_qr.png # Content-Type: image/png # Access-Control-Allow-Origin: * ``` -------------------------------- ### Generator API - Downloadable SPAYD File Source: https://context7.com/spayd/paylibo-restapi/llms.txt Creates a downloadable .spayd file containing the payment descriptor. This file can be opened by compatible banking applications to initiate a payment. ```APIDOC ## GET /paylibo/generator/spayd ### Description Creates a downloadable .spayd file containing the payment descriptor. This file can be opened by compatible banking applications to initiate a payment. ### Method GET ### Endpoint /paylibo/generator/spayd ### Query Parameters - **iban** (string) - Required - The IBAN of the recipient's bank account. - **bic** (string) - Optional - The BIC (SWIFT) code of the recipient's bank. - **amount** (number) - Required - The payment amount. - **currency** (string) - Required - The currency code (e.g., CZK, EUR). - **recipientName** (string) - Optional - The name of the recipient. - **message** (string) - Optional - A message or payment reference. - **date** (string) - Optional - The due date for the payment in YYYY-MM-DD format. - **sendersReference** (string) - Optional - A reference provided by the sender. ### Request Example ```bash curl -X GET "http://localhost:8080/paylibo/generator/spayd?iban=CZ6508000000192000145399&bic=GIBACZPX&amount=750.00¤cy=CZK&recipientName=Supplier%20Ltd&message=Order%2045678" --output payment_info.spayd ``` ### Response #### Success Response (200) - **application/x-shortpaymentdescriptor** - A downloadable .spayd file. ``` -------------------------------- ### Generate Czech Format SPAYD Payment String Source: https://context7.com/spayd/paylibo-restapi/llms.txt Generates payment strings using the Czech bank account format, including support for variable, constant, and specific symbols. ```bash # Generate Czech payment string with all symbols curl -X GET "http://localhost:8080/paylibo/generator/czech/string?accountNumber=2000145399&accountPrefix=19&bankCode=0800&amount=1250.00¤cy=CZK&vs=1234567890&ks=0308&ss=9876543210&message=Faktura%20c.%20123" # Response (text/plain): # SPD*1.0*ACC:CZ6508000000192000145399*AM:1250.00*CC:CZK*X-VS:1234567890*X-KS:0308*X-SS:9876543210*MSG:Faktura c. 123 # Generate payment string with due date curl -X GET "http://localhost:8080/paylibo/generator/czech/string?accountNumber=123456789&bankCode=0100&amount=500.00¤cy=CZK&vs=2024001&date=2024-02-28" # Response (text/plain): # SPD*1.0*ACC:CZ....*AM:500.00*CC:CZK*DT:20240228*X-VS:2024001 ``` -------------------------------- ### Czech Generator API - Payment String with Local Account Format Source: https://context7.com/spayd/paylibo-restapi/llms.txt Generates SPAYD payment strings using Czech bank account format (prefix-accountNumber/bankCode) with support for variable symbol (VS), constant symbol (KS), and specific symbol (SS). ```APIDOC ## GET /paylibo/generator/czech/string ### Description Generates SPAYD payment strings using Czech bank account format (prefix-accountNumber/bankCode) with support for variable symbol (VS), constant symbol (KS), and specific symbol (SS). ### Method GET ### Endpoint /paylibo/generator/czech/string ### Query Parameters - **accountNumber** (string) - Required - The Czech bank account number. - **accountPrefix** (string) - Required - The prefix of the Czech bank account number. - **bankCode** (string) - Required - The bank code for the Czech bank account. - **amount** (number) - Required - The payment amount. - **currency** (string) - Required - The currency code (e.g., CZK). - **vs** (string) - Optional - The variable symbol for the payment. - **ks** (string) - Optional - The constant symbol for the payment. - **ss** (string) - Optional - The specific symbol for the payment. - **message** (string) - Optional - A message or payment reference. - **date** (string) - Optional - The due date for the payment in YYYY-MM-DD format. ### Request Example ```bash curl -X GET "http://localhost:8080/paylibo/generator/czech/string?accountNumber=2000145399&accountPrefix=19&bankCode=0800&amount=1250.00¤cy=CZK&vs=1234567890&ks=0308&ss=9876543210&message=Faktura%20c.%20123" ``` ### Response #### Success Response (200) - **text/plain** - A SPAYD formatted payment string. ``` -------------------------------- ### Czech Generator API - QR Code Image Source: https://context7.com/spayd/paylibo-restapi/llms.txt Generates QR code images for Czech bank account payments including variable, constant, and specific symbols. ```APIDOC ## GET /paylibo/generator/czech/image ### Description Generates QR code images for Czech bank account payments including variable, constant, and specific symbols. ### Method GET ### Endpoint /paylibo/generator/czech/image ### Query Parameters - **accountNumber** (string) - Required - The Czech bank account number. - **accountPrefix** (string) - Required - The prefix of the Czech bank account number. - **bankCode** (string) - Required - The bank code for the Czech bank account. - **amount** (number) - Required - The payment amount. - **currency** (string) - Required - The currency code (e.g., CZK). - **vs** (string) - Optional - The variable symbol for the payment. - **ks** (string) - Optional - The constant symbol for the payment. - **ss** (string) - Optional - The specific symbol for the payment. - **message** (string) - Optional - A message or payment reference. - **date** (string) - Optional - The due date for the payment in YYYY-MM-DD format. - **size** (integer) - Optional - The desired size of the QR code image in pixels. Defaults to a standard size. - **branding** (boolean) - Optional - Whether to include SPAYD branding in the QR code. Defaults to true. - **compress** (boolean) - Optional - Whether to compress the QR code data. Defaults to false. ### Request Example ```bash curl -X GET "http://localhost:8080/paylibo/generator/czech/image?accountNumber=2000145399&accountPrefix=19&bankCode=0800&amount=1250.00¤cy=CZK&vs=1234567890&message=Faktura%20c.%20123" --output czech_payment_qr.png ``` ### Response #### Success Response (200) - **image/png** - A PNG image file containing the QR code. ``` -------------------------------- ### Generator API - IBAN Payment String Source: https://context7.com/spayd/paylibo-restapi/llms.txt Generates a SPAYD-formatted payment string from international IBAN bank account details. The string contains encoded payment information including recipient account, amount, currency, and optional message. ```APIDOC ## GET /paylibo/generator/string ### Description Generates a SPAYD-formatted payment string from international IBAN bank account details. The string contains encoded payment information including recipient account, amount, currency, and optional message. ### Method GET ### Endpoint /paylibo/generator/string ### Query Parameters - **iban** (string) - Required - The IBAN of the recipient's bank account. - **bic** (string) - Optional - The BIC (SWIFT) code of the recipient's bank. - **amount** (number) - Required - The payment amount. - **currency** (string) - Required - The currency code (e.g., CZK, EUR). - **recipientName** (string) - Optional - The name of the recipient. - **message** (string) - Optional - A message or payment reference. - **date** (string) - Optional - The due date for the payment in YYYY-MM-DD format. - **sendersReference** (string) - Optional - A reference provided by the sender. ### Request Example ```bash curl -X GET "http://localhost:8080/paylibo/generator/string?iban=CZ6508000000192000145399&bic=GIBACZPX&amount=450.00¤cy=CZK&recipientName=Jan%20Novak&message=Invoice%20123" ``` ### Response #### Success Response (200) - **text/plain** - A SPAYD formatted payment string. ``` -------------------------------- ### Generator API - Payment QR Code Image Source: https://context7.com/spayd/paylibo-restapi/llms.txt Generates a PNG image containing a QR code with embedded SPAYD payment information. The QR code can be scanned by mobile banking applications to automatically populate payment forms. ```APIDOC ## GET /paylibo/generator/image ### Description Generates a PNG image containing a QR code with embedded SPAYD payment information. The QR code can be scanned by mobile banking applications to automatically populate payment forms. ### Method GET ### Endpoint /paylibo/generator/image ### Query Parameters - **iban** (string) - Required - The IBAN of the recipient's bank account. - **bic** (string) - Optional - The BIC (SWIFT) code of the recipient's bank. - **amount** (number) - Required - The payment amount. - **currency** (string) - Required - The currency code (e.g., CZK, EUR). - **recipientName** (string) - Optional - The name of the recipient. - **message** (string) - Optional - A message or payment reference. - **size** (integer) - Optional - The desired size of the QR code image in pixels. Defaults to a standard size. - **branding** (boolean) - Optional - Whether to include SPAYD branding in the QR code. Defaults to true. - **compress** (boolean) - Optional - Whether to compress the QR code data. Defaults to false. - **date** (string) - Optional - The due date for the payment in YYYY-MM-DD format. - **sendersReference** (string) - Optional - A reference provided by the sender. ### Request Example ```bash curl -X GET "http://localhost:8080/paylibo/generator/image?iban=CZ6508000000192000145399&amount=250.00¤cy=CZK&message=Donation" --output payment_qr.png ``` ### Response #### Success Response (200) - **image/png** - A PNG image file containing the QR code. ``` -------------------------------- ### Look Up IBAN Information Source: https://context7.com/spayd/paylibo-restapi/llms.txt Performs an IBAN number lookup to check its validity and retrieve associated bank information. Note that the IBAN lookup currently returns an 'unknown' status. ```bash curl -X GET "http://localhost:8080/paylibo/validator/iban?iban=CZ6508000000192000145399" ``` -------------------------------- ### Validate Correct SPAYD String Source: https://context7.com/spayd/paylibo-restapi/llms.txt Validates a SPAYD payment string to ensure it adheres to the correct format and includes all required fields. A successful validation returns 'OK'. ```bash curl -X GET "http://localhost:8080/paylibo/validator/string?paymentString=SPD*1.0*ACC:CZ6508000000192000145399*AM:100.00*CC:CZK" ``` -------------------------------- ### Validate Invalid SPAYD String (Missing Field) Source: https://context7.com/spayd/paylibo-restapi/llms.txt Validates a SPAYD payment string that is missing a required field. This will result in an error response detailing the missing field. ```bash curl -X GET "http://localhost:8080/paylibo/validator/string?paymentString=SPD*1.0*AM:100.00" ``` -------------------------------- ### Validate Malformed SPAYD String Source: https://context7.com/spayd/paylibo-restapi/llms.txt Validates a SPAYD payment string that has an invalid format. This will return an error indicating that the payment string format is not valid. ```bash curl -X GET "http://localhost:8080/paylibo/validator/string?paymentString=INVALID_STRING" ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.