openapi: 3.0.3 info: title: 'FlexiQash API Reference' description: '' version: 1.0.0 servers: - url: 'https://flexiqash.com' paths: /api/payments: get: summary: '' operationId: getApiPayments description: '' parameters: [] responses: 200: description: '' content: application/json: schema: type: array items: type: object example: - guid: 12345678-1234-1234-1234-123456789012 name: Membership amount: 123.99 link: 'https://flexiqash/payment/12345678-1234-1234-1234-123456789012/request' payee: guid: 12345678-1234-1234-1234-123456789012 name: 'Carib Guide Inc' reference: 12345678-1234-1234-1234-123456789012 payer: name: 'John Smith' email: john.smith@test.com reference: 12345678-1234-1234-1234-123456789012 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Payments '/api/payments/{guid}/view': get: summary: '' operationId: getApiPaymentsGuidView description: '' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: guid: 12345678-1234-1234-1234-123456789012 name: Membership amount: 123.99 link: 'https://flexiqash/payment/12345678-1234-1234-1234-123456789012/request' payee: guid: 12345678-1234-1234-1234-123456789012 name: 'Carib Guide Inc' reference: 12345678-1234-1234-1234-123456789012 payer: name: 'John Smith' email: john.smith@test.com reference: 12345678-1234-1234-1234-123456789012 properties: guid: type: string example: 12345678-1234-1234-1234-123456789012 name: type: string example: Membership amount: type: number example: 123.99 link: type: string example: 'https://flexiqash/payment/12345678-1234-1234-1234-123456789012/request' payee: type: object properties: guid: type: string example: 12345678-1234-1234-1234-123456789012 name: type: string example: 'Carib Guide Inc' reference: type: string example: 12345678-1234-1234-1234-123456789012 payer: type: object properties: name: type: string example: 'John Smith' email: type: string example: john.smith@test.com reference: type: string example: 12345678-1234-1234-1234-123456789012 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: text/plain: schema: type: string example: 'Payment not found' tags: - Payments parameters: - in: path name: guid description: '' example: 12345678-1234-1234-1234-123456789012 required: true schema: type: string /api/payments/new: post: summary: '' operationId: postApiPaymentsNew description: '' parameters: [] responses: 201: description: '' content: application/json: schema: type: object example: guid: 12345678-1234-1234-1234-123456789012 name: Membership amount: 123.99 link: 'https://flexiqash.com/payment/12345678-1234-1234-1234-123456789012/request' payee: guid: 12345678-1234-1234-1234-123456789012 name: 'Carib Guide Inc.' reference: Membership payer: name: 'John Smith' email: john.smith@test.com reference: Membership properties: guid: type: string example: 12345678-1234-1234-1234-123456789012 name: type: string example: Membership amount: type: number example: 123.99 link: type: string example: 'https://flexiqash.com/payment/12345678-1234-1234-1234-123456789012/request' payee: type: object properties: guid: type: string example: 12345678-1234-1234-1234-123456789012 name: type: string example: 'Carib Guide Inc.' reference: type: string example: Membership payer: type: object properties: name: type: string example: 'John Smith' email: type: string example: john.smith@test.com reference: type: string example: Membership 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Payments requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: null payer_email: type: string description: '' example: null payer_name: type: string description: '' example: null amount: type: number description: '' example: null payer_reference: type: string description: '' example: null payee_reference: type: string description: '' example: null required: - name '/api/payments/{guid}/update': patch: summary: '' operationId: patchApiPaymentsGuidUpdate description: '' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: success: true properties: success: type: boolean example: true 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: text/plain: schema: type: string example: 'Payment not found' tags: - Payments requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: '' example: null payer_email: type: string description: '' example: null payer_name: type: string description: '' example: null amount: type: number description: '' example: null payer_reference: type: string description: '' example: null payee_reference: type: string description: '' example: null parameters: - in: path name: guid description: '' example: 12345678-1234-1234-1234-123456789012 required: true schema: type: string '/api/payments/{guid}/delete': delete: summary: '' operationId: deleteApiPaymentsGuidDelete description: '' parameters: [] responses: 204: description: '' 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: text/plain: schema: type: string example: 'Payment not found' tags: - Payments parameters: - in: path name: guid description: '' example: 12345678-1234-1234-1234-123456789012 required: true schema: type: string '/api/payments/{guid}/archive': patch: summary: '' operationId: patchApiPaymentsGuidArchive description: '' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: success: true properties: success: type: boolean example: true 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: text/plain: schema: type: string example: 'Payment not found' tags: - Payments parameters: - in: path name: guid description: '' example: 12345678-1234-1234-1234-123456789012 required: true schema: type: string '/api/payments/{guid}/unarchive': patch: summary: '' operationId: patchApiPaymentsGuidUnarchive description: '' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: success: true properties: success: type: boolean example: true 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: text/plain: schema: type: string example: 'Payment not found' tags: - Payments parameters: - in: path name: guid description: '' example: 12345678-1234-1234-1234-123456789012 required: true schema: type: string '/api/payments/{guid}/transactions': get: summary: '' operationId: getApiPaymentsGuidTransactions description: '' parameters: [] responses: 200: description: '' content: text/plain: schema: type: string example: "[\n {\n \"guid\": \"12345678-1234-1234-1234-123456789012\",\n \"payer\": {\n \"payer_email\": \"john.smith@test.com\",\n \"payer_name\": \"John Smith\",\n \"payer_reference\": \"Membership\"\n },\n \"payee\": {\n \"payee_reference\": \"Membership\"\n },\n \"amount_defined\": 123.12,\n \"is_paid\": true,\n \"paid_at\": \"2024-04-17 19:21:02\",\n \"status\": {\n \"code\": \"success\",\n \"message\": \"APPROVED\",\n },\n \"created_at\": \"2024-04-17 19:20:56\"\n }\n]" 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: text/plain: schema: type: string example: 'Payment not found' tags: - Payments parameters: - in: path name: guid description: '' example: 12345678-1234-1234-1234-123456789012 required: true schema: type: string tags: - name: Payments description: '' components: securitySchemes: default: type: http scheme: bearer description: 'You can retrieve your token by visiting your account and clicking Generate API token.' security: - default: []