Paymish Loading Docs Preparing guides, collections, and live API references...
Paymish Docs

Submit Bulk Transfer

Endpoint Overview

POST /api/transaction-service/external/v1/transfer/submit-bulk-transfer Requires authentication

Purpose

Use this endpoint to submit bulk transfer. It belongs to the Transfer collection and is designed for backend integrations.

Request shape

0 parameters and 3 documented body fields using application/json.

Implementation Guide

Recommended workflow

1

Authenticate first and inject a valid bearer token or secret key before calling the endpoint.

2

Validate the input data, identifiers, and account state in your application before making the request.

3

Send the POST request from your backend using the required headers and the expected content type (application/json).

4

Persist the important identifiers returned in the response so later lookups, webhooks, or support actions can be linked correctly.

Implementation notes

  • Validate the request payload on your backend before sending it, especially the 3 documented body fields.
  • Protect state-changing operations with strong validation, logging, and retry rules to avoid duplicate mutations.

Request Body

Content type: application/json

debitBankCode required
string
The bank code from which funds are debited Example: 998
debitAccountNumber required
string
The account number from which funds are debited Example: 0112345678
data required
array[object]
No description provided.

Responses

200 Successfully submitted bulk transfer
400 Bad request due to invalid input
401 Unauthorized access
500 Internal server error

Expected Outcomes

200

Transfer accepted

Successfully submitted bulk transfer

Representative Response
{
  "message": "Bulk transfer successfully submitted",
  "transactionId": "txn_123456789"
}
400

Transfer blocked

Bad request due to invalid input

Representative Error
{
  "error": "Invalid request payload"
}
After the response:
  • Do not create a fresh reference automatically during a retry unless you intentionally want a new payout attempt.
  • Check recipient validation, approval state, and balance rules before resubmitting the transfer.
  • Monitor the stored transfer reference after a successful initiation because final payout state may still transition later.

Language Notes

Python

Use `requests` from a backend worker, service, or Django/Flask app and centralize headers in a reusable helper.

Node.js

Use `axios` or `fetch` from Node.js services only; do not place secret credentials in frontend bundles.

PHP

Wrap cURL usage in a small client class so auth headers, error handling, and logging stay consistent.

cURL

Use cURL for smoke testing and debugging, then move the final logic into your backend service code.

Code Examples

Python
import requests

headers = {
    "Authorization": "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
}
payload = {
  "debitBankCode": "998",
  "debitAccountNumber": "0112345678",
  "data": "value"
}

response = requests.post(
    "https://api.paymish.com/api/transaction-service/external/v1/transfer/submit-bulk-transfer",
    headers=headers,
    json=payload,
)

data = response.json()
print(data)
Node.js
const axios = require("axios");

const response = await axios({
  method: "post",
  url: "https://api.paymish.com/api/transaction-service/external/v1/transfer/submit-bulk-transfer",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  data: {
  "debitBankCode": "998",
  "debitAccountNumber": "0112345678",
  "data": "value"
}
});

console.log(response.data);
cURL
curl https://api.paymish.com/api/transaction-service/external/v1/transfer/submit-bulk-transfer \
  -X POST \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{   "debitBankCode": "998",   "debitAccountNumber": "0112345678",   "data": "value" }'
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/transaction-service/external/v1/transfer/submit-bulk-transfer");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_SECRET_KEY",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    "debitBankCode" => "998",
    "debitAccountNumber" => "0112345678",
    "data" => "value",
]));

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);