API Bkpays Doc
english
  • english
  • 中文
  1. United Arab Emirates
API Bkpays Doc
english
  • english
  • 中文
  • Development Guide
    • Development Integration Guidelines
    • API Request Structure Definition
    • APIs Signature
    • Postman And SDK
    • APIs WebHook
    • Order Status
    • APIs Error Code List
    • PCI Compliance
    • Payment Process Explanation
  • Transaction APIs
    • North America
      • USA
        • Payment
        • Payout
      • Mexico
        • Payment
        • Payout
    • South America
      • Brazil
        • Payment
        • Payout
      • Colombia
        • Payment
        • Payout
      • Ecuador
        • Payment
        • Payout
      • Argentina
        • Payment
        • Payout
      • Peru
        • Payment
        • Payout
      • Chile
        • Payment
        • Payout
      • Venezuela
        • Payment
        • Payout
    • Asia
      • Indonesia
        • Payment
        • Payout
      • Philippines
        • Payment
        • Payout
      • Thailand
        • Payment
        • Payout
      • Malaysia
        • 收款
        • 出款
      • Bengal
        • Payment
        • Payout
      • India
        • Payment
        • Payout
      • Pakistan
        • Payment
        • Payout
    • Europe
      • Russia
        • Payment
        • Payout
    • Mid East
      • United Arab Emirates
        • Payment
          POST
        • Payout
          POST
      • Turkey
        • Payment
        • Payout
    • Africa
      • Kenya
        • Payment
        • Payout
      • Nigeria
        • Payment
        • Payout
      • South Africa
        • Payment
        • Payout
      • Tanzania
        • Payment
        • Payout
    • Global universal payment
      • Payment
      • Payout
  • Common APIs
    • Payout Voucher Query
      POST
    • Account Balance Query
      POST
    • Order Status Query
      POST
  • Payment of Video Case
    • Video Case
    • Payment method Logo
  • Dashboard Guide
    • Bind Google Authenticator 2FA
  • Schemas
    • Payment Common Request Body
    • Payment Common Response Body
    • Payout Common Request Body
    • Payout Common Response Body
  1. United Arab Emirates

Payout

Developing
POST
/gateway/base/biz
Amount supports up to 2 decimal places

WALLET Payout Parameters#

Parameter NameParameter TypeRequiredExample
paymentTypePayment TypeStringrequiredWALLET
beneficiaryTypeBeneficiary Account TypeStringrequiredPHONE / MEMBER
beneficiaryAccountNumberBeneficiary AccountStringrequiredFor PHONE type: enter phone number; for MEMBER type: enter member ID

IBAN 出款参数#

Parameter NameParameter TypeRequiredExample
paymentTypePayment TypeStringrequiredIBAN
beneficiaryAccountTypeBeneficiary Account TypeStringrequiredPersonal / Company
companyNameCompany NameStringoptionalRequired if beneficiaryAccountType is Company
beneficiaryNameBeneficiary Account NameStringrequired
beneficiaryAccountNumberBeneficiary Account NumberStringrequiredIBAN account
beneficiaryAddressBeneficiary Bank AddressStringrequired
beneficiaryBankNameBeneficiary Bank NameStringrequired
swiftCodeSWIFT CodeStringrequired

paymentType List#

paymentTypebeneficiaryTypeNotes
WALLETPHONEBOTIM-linked mobile number: +971-5xxxxxxxx, 5xxxxxxxx, or 05xxxxxxxx are all acceptable
MEMBERBOTIM member ID: 10001734xxx
IBAN-IBAN account

WALLET Payout Parameter Template#

{
  "amount": "10",
  "currency": "AED",
  "callbackUrl": "http://127.0.0.1:8082/india-merchant/core/callback",
  "beneficiaryEmail": "muazpe@gmail.com",
  "beneficiaryName": "SHUIPING Zhou",
  "beneficiaryAccountNumber": "+971-565800009", //565800009
  "beneficiaryAddress": "Liwa Street off Khaliffa Street",
  "beneficiaryType": "PHONE",
  "beneficiaryMobile": "+971-565800009",
  "mchOrderId": "aedtest119142",
  "paymentType": "WALLET"
}

IBAN Payout Parameter Template#

{
    "mchOrderId": "aedtest00941117",
    "amount": "10",
    "currency": "AED",
    "callbackUrl": "http://127.0.0.1:8082/india-merchant/core/callback",
    "beneficiaryEmail": "muazpe@gmail.com",
    "beneficiaryMobile": "+971-565806000",
    "beneficiaryAccountType": "Company", // If Company, companyName is required; If Personal, companyName is optional
    "companyName": "Test Company",
    "beneficiaryName": "Lucky Chou",
    "beneficiaryAccountNumber": "AE450860000006791000000",
    "beneficiaryAddress": "Etihad Airways Centre, Abu Dhabi, UAE",
    "beneficiaryBankName": "Wio Bank PJSC",
    "swiftCode": "WIOBAEADXXX",
    "paymentType": "IBAN"
}

Request

Header Params

Body Params application/json

Example
{
    "mchOrderId": "string",
    "amount": "string",
    "currency": "string",
    "purpose": "string",
    "beneficiaryName": "string",
    "beneficiaryEmail": "string",
    "beneficiaryMobile": "string",
    "beneficiaryAccountNumber": "string",
    "callbackUrl": "string",
    "paymentType": "WALLET",
    "beneficiaryType": "string",
    "beneficiaryAccountType": "string",
    "companyName": "string",
    "beneficiaryAddress": "string",
    "beneficiaryBankName": "string",
    "swiftCode": "string"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/gateway/base/biz' \
--header 'method: payOut' \
--header 'signType: SHA512' \
--header 'serviceName: api.pay' \
--header 'mchId: 1416010331032883200' \
--header 'timestamp: 1631671670' \
--header 'sign: 32554324534545432543' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mchOrderId": "string",
    "amount": "string",
    "currency": "string",
    "purpose": "string",
    "beneficiaryName": "string",
    "beneficiaryEmail": "string",
    "beneficiaryMobile": "string",
    "beneficiaryAccountNumber": "string",
    "callbackUrl": "string",
    "paymentType": "WALLET",
    "beneficiaryType": "string",
    "beneficiaryAccountType": "string",
    "companyName": "string",
    "beneficiaryAddress": "string",
    "beneficiaryBankName": "string",
    "swiftCode": "string"
}'

Responses

🟢200OK
application/json
Body

Example
{
    "resultCode": "78",
    "errorCode": "59",
    "errorMsg": null,
    "data": [
        {
            "orderId": "2",
            "currency": "mollit"
        },
        {
            "orderId": "31",
            "currency": "dolor labore"
        },
        {
            "orderId": "56",
            "currency": "exercitation veniam voluptate id"
        }
    ],
    "success": false
}
Modified at 2025-12-05 12:56:10
Previous
Payment
Next
Payment
Built with