README

执行以下命令以在您的laravel项目中安装此包。

composer require spiritsaint/laravel-bacs:dev-master

要求

• Laravel 10或更高版本
• PHP 8.1或更高版本

使用方法

安装后，包将注册/api/bacs端点。可以使用php artisan serve

只接受GET请求，需要serial_number和sun或marker作为必需参数。

对于快速支付，使用此参数为true，否则您应定义creation_date和expiration_date。

创建日期可以是今天或未来的某天。过期日期必须晚于创建日期。

必须包含值为application/json的Accept头。

OpenAPI

为了了解API，您应使用Swagger Editor查看文档。

openapi: 3.0.0
info:
  title: 'BACS - Swagger Documentation'
  version: 1.0.0
servers:
  - url: https://:8000
paths:
  /api/bacs:
    get:
      operationId: bdfd7b90fc16856aad8db2a99ae14e6f
      parameters:
        -
          name: serial_number
          in: query
          required: true
          schema:
            description: 'Must be a 6 alphanumeric characters.'
            type: string
        -
          name: sun
          in: query
          required: false
          schema:
            description: "Must be a 6 characters if marker isn't defined."
            type: string
        -
          name: marker
          in: query
          required: false
          schema:
            description: "Must be hsbc or sage if sun isn't defined."
            type: string
            enum:
              - hsbc
              - sage
        -
          name: generation_number
          in: query
          required: false
          schema:
            description: 'Must be a number of 4 characters.'
            type: number
        -
          name: generation_version_number
          in: query
          required: false
          schema:
            description: 'Must be a number of 2 characters.'
            type: number
        -
          name: fast_payment
          in: query
          required: false
          schema:
            description: 'Indicates if must be fast payment.'
            type: string
        -
          name: creation_date
          in: query
          required: false
          schema:
            description: "Must be a date in format Y-m-d and explicit defined if fast_payment isn't defined. (ie: 2023-12-03)"
            type: string
        -
          name: expiration_date
          in: query
          required: false
          schema:
            description: "Must be a date in format Y-m-d and explicit defined if fast_payment isn't defined. (ie: 2023-12-03)"
            type: string
        -
          name: Accept
          in: header
          required: true
          schema:
            description: 'Must be application/json'
            type: string
            default: application/json
      responses:
        '200':
          description: Success
          content:
                application/json: {}