Skip to main content

Bulk Payment

POST /api/payments/bulk-payment

Bulk Payment Transfer

Header Parameters
  • api-key string required
  • api-secret string required
Request Body required
  • balanceId int64 required

    Wallet Id of the account to send from

  • balanceIdCharge int64

    Wallet Id to charge, if left empty the balance that is being debited from will be charged

  • currency string required

    Currency

  • bulkPayments object[] required

    List of bulk payments to be processed

  • Array [
  • amount double required

    Amount being sent

  • transferType string required

    Possible values: [BANK, B2B, B2C, BUSINESS_PAY_BILL, BUSINESS_BUY_GOODS, COUNTER_PARTY_TRANSFER]

    Type of transfer

  • phoneNumber string

    Phone number of receiver

  • reference string required

    Reference for the payment

  • recipient string required

    Recipient Name

  • recipientIdNumber string

    Recipient ID number

  • bankId int64

    Pesawise Bank identifier

  • accountNumber string

    Account Number

  • paybillNumber string

    Paybill Number

  • tillNumber string

    Till Number

  • beneficiaryId int64

    Beneficiary ID

  • uniqueReference string

    Unique Reference

  • walletIdTo int64

    Wallet ID To (Pesawise to Pesawise wallet)

  • ]
  • virtual boolean
Responses

Bulk Payment Response

Response Headers
  • x-request-id any

    Request Id for traceability

Schema
  • batchId uuid required

    Unique identifier used to query the batch transfer status

  • success boolean

    Indicates whether the payment was staged or not

  • bulkResponseStatus string required

    Possible values: [INSUFFICIENT_FUNDS, MALFORMED_REQUEST, ERROR, SUCCESS, INVALID_API_KEYS, API_NOT_ENABLED, INTERNAL_ERROR, NON_UNIQUE_CLIENT_REFERENCE]

    Status of the bulk operation.

  • message string required

    Message related to the bulk operation status.

Loading...