# Payout

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /gateway/base/biz:
    post:
      summary: Payout
      deprecated: false
      description: >-
        - beneficiaryAccountNumber: Beneficiary account number: CLABE number or
        bank account number.

        - paymentType: SPEI or NET_BANKING. When it is SPEI,
        beneficiaryAccountNumber must be a CLABE number; when it is NET_BANKING,
        beneficiaryAccountNumber should be filled with the bank card number.

        -  For Mexico payouts, the bank will default to a successful callback.
        If the account is abnormal or incorrect, the payout order will change
        from SUCCESS status to REVERSED status.
      tags:
        - Transaction APIs/North America/Mexico
        - 付款
      parameters:
        - name: method
          in: header
          description: interface method
          required: true
          example: payOut
          schema:
            type: string
        - name: signType
          in: header
          description: signature type
          required: true
          example: SHA512
          schema:
            type: string
        - name: serviceName
          in: header
          description: service name
          required: true
          example: api.pay
          schema:
            type: string
        - name: mchId
          in: header
          description: merchant ID
          required: true
          example: '1416010331032883200'
          schema:
            type: string
        - name: timestamp
          in: header
          description: timestamp (seconds)
          required: true
          example: '1631671670'
          schema:
            type: string
        - name: sign
          in: header
          description: signature
          required: true
          example: '32554324534545432543'
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                beneficiaryBankCode:
                  type: string
                  description: Bank Code
                  title: ''
                  enum:
                    - '37006'
                    - '37009'
                    - '37019'
                    - '37135'
                    - '37166'
                    - '37168'
                    - '40002'
                    - '40012'
                    - '40014'
                    - '40021'
                    - '40030'
                    - '40036'
                    - '40042'
                    - '40044'
                    - '40058'
                    - '40059'
                    - '40060'
                    - '40062'
                    - '40072'
                    - '40106'
                    - '40108'
                    - '40110'
                    - '40112'
                    - '40113'
                    - '40126'
                    - '40127'
                    - '40128'
                    - '40129'
                    - '40130'
                    - '40132'
                    - '40133'
                    - '40136'
                    - '40137'
                    - '40138'
                    - '40140'
                    - '40141'
                    - '40143'
                    - '40145'
                    - '40147'
                    - '40148'
                    - '40150'
                    - '40151'
                    - '40152'
                    - '40154'
                    - '40155'
                    - '40156'
                    - '40157'
                    - '40158'
                    - '40159'
                    - '40160'
                    - '90600'
                    - '90601'
                    - '90602'
                    - '90605'
                    - '90608'
                    - '90699'
                    - '90613'
                    - '90616'
                    - '90617'
                    - '90620'
                    - '90630'
                    - '90631'
                    - '90634'
                    - '90638'
                    - '90642'
                    - '90646'
                    - '90648'
                    - '90652'
                    - '90653'
                    - '90656'
                    - '90659'
                    - '90670'
                    - '90677'
                    - '90680'
                    - '90683'
                    - '90684'
                    - '90685'
                    - '90686'
                    - '90689'
                    - '90703'
                    - '90706'
                    - '90710'
                    - '90728'
                    - '90902'
                    - '90903'
                    - '2001'
                    - '91802'
                    - '90661'
                    - '90814'
                    - '91812'
                    - '91814'
                    - '91821'
                    - '91872'
                    - '91927'
                    - '86000'
                    - '90688'
                    - '90723'
                    - '90722'
                    - '90901'
                  x-apifox-enum:
                    - value: '37006'
                      name: BANCOMEXT
                      description: ''
                    - value: '37009'
                      name: BANOBRAS
                      description: ''
                    - value: '37019'
                      name: BANJERCITO
                      description: ''
                    - value: '37135'
                      name: NAFIN
                      description: ''
                    - value: '37166'
                      name: BaBien
                      description: ''
                    - value: '37168'
                      name: HIPOTECARIA FED
                      description: ''
                    - value: '40002'
                      name: BANAMEX
                      description: ''
                    - value: '40012'
                      name: BBVA MEXICO
                      description: ''
                    - value: '40014'
                      name: SANTANDER
                      description: ''
                    - value: '40021'
                      name: HSBC
                      description: ''
                    - value: '40030'
                      name: BAJIO
                      description: ''
                    - value: '40036'
                      name: INBURSA
                      description: ''
                    - value: '40042'
                      name: MIFEL
                      description: ''
                    - value: '40044'
                      name: SCOTIABANK
                      description: ''
                    - value: '40058'
                      name: BANREGIO
                      description: ''
                    - value: '40059'
                      name: INVEX
                      description: ''
                    - value: '40060'
                      name: BANSI
                      description: ''
                    - value: '40062'
                      name: AFIRME
                      description: ''
                    - value: '40072'
                      name: BANORTE
                      description: ''
                    - value: '40106'
                      name: BANK OF AMERICA
                      description: ''
                    - value: '40108'
                      name: MUFG
                      description: ''
                    - value: '40110'
                      name: JP MORGAN
                      description: ''
                    - value: '40112'
                      name: BMONEX
                      description: ''
                    - value: '40113'
                      name: VE POR MAS
                      description: ''
                    - value: '40126'
                      name: CREDIT SUISSE
                      description: ''
                    - value: '40127'
                      name: AZTECA
                      description: ''
                    - value: '40128'
                      name: AUTOFIN
                      description: ''
                    - value: '40129'
                      name: BARCLAYS
                      description: ''
                    - value: '40130'
                      name: COMPARTAMOS
                      description: ''
                    - value: '40132'
                      name: MULTIVA BANCO
                      description: ''
                    - value: '40133'
                      name: ACTINVER
                      description: ''
                    - value: '40136'
                      name: INTERCAM BANCO
                      description: ''
                    - value: '40137'
                      name: BANCOPPEL
                      description: ''
                    - value: '40138'
                      name: ABC CAPITAL
                      description: ''
                    - value: '40140'
                      name: CONSUBANCO
                      description: ''
                    - value: '40141'
                      name: VOLKSWAGEN
                      description: ''
                    - value: '40143'
                      name: CIBANCO
                      description: ''
                    - value: '40145'
                      name: BBASE
                      description: ''
                    - value: '40147'
                      name: BANKAOOL
                      description: ''
                    - value: '40148'
                      name: PAGATODO
                      description: ''
                    - value: '40150'
                      name: INMOBILIARIO
                      description: ''
                    - value: '40151'
                      name: DONDE.
                      description: ''
                    - value: '40152'
                      name: BANCREA
                      description: ''
                    - value: '40154'
                      name: BANCO COVALTO
                      description: ''
                    - value: '40155'
                      name: ICBC
                      description: ''
                    - value: '40156'
                      name: SABADELL
                      description: ''
                    - value: '40157'
                      name: SHINHAN
                      description: ''
                    - value: '40158'
                      name: MIZUHO BANK
                      description: ''
                    - value: '40159'
                      name: BANK OF CHINA
                      description: ''
                    - value: '40160'
                      name: BANCO S3
                      description: ''
                    - value: '90600'
                      name: MONEXCB
                      description: ''
                    - value: '90601'
                      name: GBM
                      description: ''
                    - value: '90602'
                      name: MASARI
                      description: ''
                    - value: '90605'
                      name: VALUE
                      description: ''
                    - value: '90608'
                      name: VECTOR
                      description: ''
                    - value: '90699'
                      name: FONDEADORA
                      description: ''
                    - value: '90613'
                      name: MULTIVA CBOLSA
                      description: ''
                    - value: '90616'
                      name: FINAMEX
                      description: ''
                    - value: '90617'
                      name: VALMEX
                      description: ''
                    - value: '90620'
                      name: PROFUTURO
                      description: ''
                    - value: '90630'
                      name: CB INTERCAM
                      description: ''
                    - value: '90631'
                      name: CI BOLSA
                      description: ''
                    - value: '90634'
                      name: FINCOMUN
                      description: ''
                    - value: '90638'
                      name: NU MEXICO
                      description: ''
                    - value: '90642'
                      name: REFORMA
                      description: ''
                    - value: '90646'
                      name: STP
                      description: ''
                    - value: '90648'
                      name: TACTIV CB
                      description: ''
                    - value: '90652'
                      name: CREDICAPITAL
                      description: ''
                    - value: '90653'
                      name: KUSPIT
                      description: ''
                    - value: '90656'
                      name: UNAGRA
                      description: ''
                    - value: '90659'
                      name: ASP INTEGRA OPC
                      description: ''
                    - value: '90670'
                      name: LIBERTAD
                      description: ''
                    - value: '90677'
                      name: CAJA POP MEXICA
                      description: ''
                    - value: '90680'
                      name: CRISTOBAL COLON
                      description: ''
                    - value: '90683'
                      name: CAJA TELEFONIST
                      description: ''
                    - value: '90684'
                      name: TRANSFER
                      description: ''
                    - value: '90685'
                      name: FONDO (FIRA)
                      description: ''
                    - value: '90686'
                      name: INVERCAP
                      description: ''
                    - value: '90689'
                      name: FOMPED
                      description: ''
                    - value: '90703'
                      name: TESORED
                      description: ''
                    - value: '90706'
                      name: ARCUS
                      description: ''
                    - value: '90710'
                      name: NVIO
                      description: ''
                    - value: '90728'
                      name: SPIN BY OXXO
                      description: ''
                    - value: '90902'
                      name: INDEVAL
                      description: ''
                    - value: '90903'
                      name: CoDi Valida
                      description: ''
                    - value: '2001'
                      name: BANXICO
                      description: ''
                    - value: '91802'
                      name: BANAMEX2
                      description: ''
                    - value: '90661'
                      name: KLAR
                      description: ''
                    - value: '90814'
                      name: SANTANDER2\*
                      description: ''
                    - value: '91812'
                      name: BBVA BANCOMER2
                      description: ''
                    - value: '91814'
                      name: SANTANDER2
                      description: ''
                    - value: '91821'
                      name: HSBC2
                      description: ''
                    - value: '91872'
                      name: BANORTE2
                      description: ''
                    - value: '91927'
                      name: AZTECA2
                      description: ''
                    - value: '86000'
                      name: TEST\*
                      description: ''
                    - value: '90688'
                      name: CREDICLUB
                      description: ''
                    - value: '90723'
                      name: Cuenca
                      description: ''
                    - value: '90722'
                      name: Mercado Pago W
                      description: ''
                    - value: '90901'
                      name: CLS
                      description: ''
                paymentType:
                  type: string
                  description: payment type;default SPEI
                  enum:
                    - SPEI
                    - NET_BANKING
                  x-apifox-enum:
                    - value: SPEI
                      name: CLABE number
                      description: ''
                    - value: NET_BANKING
                      name: bank card
                      description: ''
              x-apifox-orders:
                - 01K1MPFD2P11GF04ZBCVH7WDF1
                - beneficiaryBankCode
                - paymentType
              x-apifox-refs:
                01K1MPFD2P11GF04ZBCVH7WDF1:
                  $ref: '#/components/schemas/Payout%20Common%20Request%20Body'
              required:
                - beneficiaryBankCode
                - paymentType
              x--orders:
                - beneficiaryBankCode
                - paymentType
              x--ignore-properties: []
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        orderId:
                          type: string
                      x-apifox-orders:
                        - orderId
                      x--orders:
                        - orderId
                      x--ignore-properties: []
                x-apifox-orders:
                  - 01K1WQJZEFRFYDGDC20JAKGX5H
                  - data
                x-apifox-refs:
                  01K1WQJZEFRFYDGDC20JAKGX5H:
                    $ref: '#/components/schemas/Payout%20Common%20Response%20Body'
                required:
                  - data
                x--orders:
                  - data
                x--ignore-properties: []
          headers: {}
          x-apifox-name: Success
      security: []
      x-apifox-folder: Transaction APIs/North America/Mexico
      x-apifox-status: developing
      x-run-in-apifox: https://app.apifox.com/web/project/7059003/apis/api-491106976-run
components:
  schemas:
    Payout Common Request Body:
      type: object
      properties:
        mchOrderId:
          type: string
          title: ''
          description: Merchant order number (min 5 characters, max 32 characters)
          x-apifox-mock: '{{$string.uuid}}'
        amount:
          type: string
          title: ''
          description: Order amount, in currency units
        currency:
          type: string
          title: ''
          description: 'Order currency, three-letter code, e.g.: USD'
          x-apifox-mock: '{{$finance.currencyCode}}'
        purpose:
          type: string
          title: ''
          description: Product description
        paymentType:
          type: string
          title: ''
          description: Payment method
        beneficiaryName:
          type: string
          title: ''
          description: Beneficiary name
        beneficiaryEmail:
          type: string
          title: ''
          description: Beneficiary email
        beneficiaryMobile:
          type: string
          title: ''
          description: Beneficiary mobile number
        beneficiaryAccountNumber:
          type: string
          title: ''
          description: Beneficiary account number
        callbackUrl:
          type: string
          title: ''
          description: Webhook callback URL
      x-apifox-orders:
        - mchOrderId
        - amount
        - currency
        - purpose
        - paymentType
        - beneficiaryName
        - beneficiaryEmail
        - beneficiaryMobile
        - beneficiaryAccountNumber
        - callbackUrl
      required:
        - mchOrderId
        - amount
        - currency
        - purpose
        - paymentType
        - beneficiaryName
        - beneficiaryEmail
        - beneficiaryMobile
        - beneficiaryAccountNumber
        - callbackUrl
      x--orders:
        - mchOrderId
        - amount
        - currency
        - purpose
        - paymentType
        - beneficiaryName
        - beneficiaryEmail
        - beneficiaryMobile
        - beneficiaryAccountNumber
        - callbackUrl
      x--ignore-properties: []
      x-apifox-folder: ''
    Payout Common Response Body:
      type: object
      properties:
        resultCode:
          type: string
          description: Business code
        errorCode:
          type: string
          description: Error code
        errorMsg:
          type: string
          description: Error message
      x-apifox-orders:
        - resultCode
        - errorCode
        - errorMsg
      required:
        - resultCode
        - errorCode
        - errorMsg
      x--orders:
        - resultCode
        - errorCode
        - errorMsg
      x--ignore-properties: []
      x-apifox-folder: ''
  securitySchemes: {}
servers:
  - url: http://prod-cn.your-api-server.com
    description: Prod Env
security: []

```