Bulk Payment

As a SasaPay merchant, you can efficiently distribute funds to multiple clients simultaneously through various channels. This feature is ideal for scenarios such as salary payments, loan disbursements, promotional payouts, and any other situations requiring bulk disbursements.

Endpoint: https://sandbox.sasapay.app/api/v1/payments/bulk-payments/

Request Parameters

Field	Type	Description	Example
merchant_code	String	Unique code assigned to the merchant	"600980"
bulk_payment_reference	String	Reference for the bulk payment	"BULK_REF_001"
description	String	Description of the bulk payment	"May Salary Payment Batch 1"
debit_account_number	String	Account number to debit the payment amount from	"600980"
charges_account_number	String	Account number to charge any associated fees	"600980"
callback_url	String	URL to call back once the bulk payment process is complete	"http://localhost"
payment_details	Array	List of payment details	See below
├── receiver_name	String	Name of the payment receiver	"John Doe"
├── account_number	String	Receiver's account number	"1234567890"
├── channel_code	String	Code representing the payment channel	"01"
├── amount	String	Amount to be paid	"1000.00"
├── payment_reference	String	Unique reference for the payment	"PAY_REF_001"
├── payment_reason	String	Reason for the payment	"May Salary"

Sample request

Headers
    Key: Authorization
    Value: Bearer cFJZcjZ6anEwaThMMXp6d1FETUxwWkIzeVBDa2hNc2M6UmYyMkJmWm9nMHFRR2xWOQ==
Body:
   
{
  "merchant_code": "600980",
  "bulk_payment_reference": "BULK_REF_001",
  "description": "May Salary Payment Batch 1",
  "debit_account_number":"600980",
  "charges_account_number":"600980",
  "callback_url":"http://localhost",
  "payment_details": [
    {
      "receiver_name": "John Doe",
      "account_number": "1234567890",
      "channel_code": "01",
      "amount": "1000.00",
      "payment_reference": "PAY_REF_001",
      "payment_reason": "May Salary"
    },
    {
      "receiver_name": "Jane Smith",
      "account_number": "0987654321",
      "channel_code": "63902",
      "amount": "2000.00",
      "payment_reference": "PAY_REF_002",
      "payment_reason": "May Salary"
    }
  ]
}

Bulk Payment Status Query:

Endpoint: https://sandbox.sasapay.app/api/v1/payments/bulk-payments/status/

Request Parameters

Field	Type	Description	Example
merchant_code	String	Unique code assigned to the merchant	"600980"
bulk_payment_reference	String	Reference for the bulk payment	"421"
description	String	Description of the bulk payment	"Manzana Tz Tests"
debit_account_number	String	Account number to debit the payment amount from	"99407"
charges_account_number	String	Account number to charge any associated fees	"99407"
callback_url	String	URL to call back once the bulk payment process is complete	"https://webhook.site/67120d68-c598-4f6c-9c37-ecee3fc16a16"
payment_details	Array	List of payment details	See below
├── receiver_name	String	Name of the payment receiver	"John Doe"
├── account_number	String	Receiver's account number	"2547511655"
├── channel_code	String	Code representing the payment channel	"00"
├── amount	String	Amount to be paid	"100.00"
├── charge	String	Charge for the payment	"0.00"
├── payment_reference	String	Unique reference for the payment	"4925"
├── payment_reason	String	Reason for the payment	"Gift"
├── status	String	Current status of the payment	"PROCESSING"
├── sasapay_transaction_code	String	SasaPay transaction code for tracking	"SPE011383838X"
├── third_party_transaction_code	String	Third party transaction code for tracking	"MPEF00023DFFG"
├── updated_on	String	Last updated timestamp of the payment	"2024-06-06T19:50:21.261607+03:00"
├── created_on	String	Creation timestamp of the payment	"2024-06-06T19:50:17.761281+03:00"

Sample request

Headers
    Key: Authorization
    Value: Bearer cFJZcjZ6anEwaThMMXp6d1FETUxwWkIzeVBDa2hNc2M6UmYyMkJmWm9nMHFRR2xWOQ==
Body:
{
    "merchant_code": "600980",
    "bulk_payment_reference":"421"
}

Response:

{
    "status": true,
    "message": "Bulk Payment Details",
    "data": {
        "merchant_code": "99407",
        "bulk_payment_reference": "421",
        "debit_account_number": "99407",
        "charges_account_number": "99407",
        "total_records": 1,
        "total_records_processed": 0,
        "totals_payable": "100.00",
        "totals_paid": "0.00",
        "total_charge": "0.00",
        "description": "Manzana Tz Tests",
        "status": "PROCESSING",
        "created_on": "2024-06-06T19:50:17.772843+03:00",
        "callback_url": "https://webhook.site/67120d68-c598-4f6c-9c37-ecee3fc16a16",
        "payment_details": [
            {
                "payment_reference": "4925",
                "receiver_name": "john doe",
                "account_number": "2547511655",
                "channel_code": "00",
                "amount": "100.00",
                "charge": "0.00",
                "payment_reason": "Gift",
                "status": "PROCESSING",
                "sasapay_transaction_code": "SPE011383838X",
                "third_party_transaction_code": "MPEF00023DFFG",
                "updated_on": "2024-06-06T19:50:21.261607+03:00",
                "created_on": "2024-06-06T19:50:17.761281+03:00"
            }
        ]
    }
}