# 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: >- - phone must contain the user’s real information, and beneficiaryId must be a valid existing ID. However, it can be generated randomly — try not to use a fixed value, as it may trigger risk control. - Phone number format: 03XXXXXXXX — must start with 03 and contain 11 digits in total. WALLET_JAZZCASH Phone Number - Phone number format: 03XXXXXXXX — starts with 03 and contains 11 digits. Mobile operator prefixes: - 364 – Instaphone (Previously 320) - 300, 301, 302, 303, 306, 307, 308 – Mobilink - 304 – Paktel GSM (Now converted to 314 ZONG) - 342, 343, 344, 345, 346 – Telenor - 321, 322, 323 – Warid Telecom - 333, 334, 335, 331, 332 – Ufone - 312, 313, 314 – ZONG ## When paymentType = WALLET, beneficiaryBankCode values: | **Bank Code** | Wallet Name | | --- | --- | | 033 | JAZZCASH | | 034 | EASYPAISA | tags: - Transaction APIs/Asia/Pakistan - 付款 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: 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 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 paymentType: type: string description: Payment type title: '' enum: - NET_BANKING - WALLET x-apifox-enum: - value: NET_BANKING name: NET_BANKING description: '' - value: WALLET name: WALLET description: '' beneficiaryBankCode: type: string description: Beneficiary bank code title: '' enum: - '001' - '002' - '003' - '004' - '005' - '006' - '007' - '008' - '009' - '010' - '011' - '012' - '013' - '014' - '015' - '016' - '017' - '018' - '019' - '020' - '021' - '022' - '023' - '024' - '025' - '026' - '027' - '028' - '029' - '030' - '031' - '032' x-apifox-enum: - value: '001' name: ALBARAKA_ISLAMIC_BANK description: '' - value: '002' name: ALLIED_BANK_LIMITED description: '' - value: '003' name: APNA_MICRO_FINANCE_BANK description: '' - value: '004' name: ASKARI_BANK_LIMITED description: '' - value: '005' name: BANK_AL_HABIB_LIMITED description: '' - value: '006' name: BANK_ALFALAH_LIMITED description: '' - value: '007' name: BANK_ISLAMI_PAKISTAN_LIMITED description: '' - value: '008' name: BANK_OF_KHYBER description: '' - value: '009' name: CITI_BANK_NA description: '' - value: '010' name: DUBAI_ISLAMIC_BANK_PAKISTAN_LIMITED description: '' - value: '011' name: FAYSAL_BANK_LIMITED description: '' - value: '012' name: FINCA_MICRO_FINANCE_BANK description: '' - value: '013' name: FIRST_WOMEN_BANK_LIMITED description: '' - value: '014' name: HABIB_BANK_LIMITED description: '' - value: '015' name: HABIB_METROPOLITAN_BANK_LIMITED description: '' - value: '016' name: JS_BANK_LIMITED description: '' - value: '017' name: MCB_BANK_LIMITED description: '' - value: '018' name: MCB_ISLAMIC description: '' - value: '019' name: MEEZAN_BANK description: '' - value: '020' name: NATIONAL_BANK_OF_PAKISTAN description: '' - value: '021' name: NRSP_MICRO_FINANCE_BANK description: '' - value: '022' name: NIB_BANK_LIMITED description: '' - value: '023' name: SAMBA_BANK_LIMITED description: '' - value: '024' name: SILK_BANK_LIMITED description: '' - value: '025' name: SINDH_BANK_LIMITED description: '' - value: '026' name: SONERI_BANK_LIMITED description: '' - value: '027' name: STANDARD_CHARTERED_BANK_LTD description: '' - value: '028' name: SUMMIT_BANK_LIMITED description: '' - value: '029' name: TELENOR_MICRO_FINANCE_BANK description: '' - value: '030' name: THE_BANK_OF_PUNJAB description: '' - value: '031' name: U_MICRO_FINANCE_BANK description: '' - value: '032' name: UNITED_BANK_LIMITED description: '' x-apifox-orders: - 01K1MPFD2P11GF04ZBCVH7WDF1 - paymentType - beneficiaryBankCode x-apifox-refs: 01K1MPFD2P11GF04ZBCVH7WDF1: $ref: '#/components/schemas/Payout%20Common%20Request%20Body' x-apifox-overrides: paymentType: null required: - mchOrderId - amount - currency - purpose - beneficiaryName - beneficiaryEmail - beneficiaryMobile - beneficiaryAccountNumber - callbackUrl - paymentType - beneficiaryBankCode x-apifox-ignore-properties: - mchOrderId - amount - currency - purpose - beneficiaryName - beneficiaryEmail - beneficiaryMobile - beneficiaryAccountNumber - callbackUrl examples: {} responses: '200': description: '' content: application/json: schema: type: object properties: {} x-apifox-orders: [] x-apifox-ignore-properties: [] headers: {} x-apifox-name: OK security: [] x-apifox-folder: Transaction APIs/Asia/Pakistan x-apifox-status: developing x-run-in-apifox: https://app.apifox.com/web/project/7059003/apis/api-491107004-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-apifox-ignore-properties: [] x-apifox-folder: '' securitySchemes: {} servers: - url: http://prod-cn.your-api-server.com description: Prod Env security: [] ```