Create Transfer

The Create Transfer API enables merchants to initiate payout requests, allowing them to transfer funds to payees swiftly and efficiently. Merchants can specify the amount, currency, and desired payout method, such as cryptocurrencies (e.g., Bitcoin, Ethereum) or fiat currencies (e.g., USD, EUR).

Sample Payload Data to be Encrypted

[{
    id: "11-22-33",
    fname: "Rohan",
    lname: "Singh",
    email: "testing998824@yopmail.com",
    label: "TestingL",
    businessname: "Testing2",
    amount: 10,
    currency: "USD",
    descriptor: "TestingD",
    },
    {
    id: "11-22-34",
    fname: "Rohan",
    lname: "Singh",
    email: "testing998825@yopmail.com",
    label: "TestingL",
    businessname: "Testing2",
    amount: 10,
    currency: "USD",
    descriptor: "TestingD",
    }];

This API will take encrypted data as request payload.

POST /payout/transfer

Headers

NameTypeDescription

Authorization*

String

Bearer {{token}}

Request Body

NameTypeDescription

encryptedReq*

String

Encrypted array of transfer object

When all data is correct

{
  "ok": true,
  "result": {
    "success": true,
    "receivers": [
      {
        "Email": "testing998877@yopmail.com",
        "Amount": 10,
        "Last Name": "Singh",
        "First Name": "Rohan",
        "Descriptor": "TestingD",
        "Currency": "USD",
        "Label": "TestingL"
      },
      {
        "Email": "testing998879@yopmail.com",
        "Amount": 10,
        "Last Name": "Singh",
        "First Name": "Rohan",
        "Descriptor": "TestingD",
        "Currency": "USD",
        "Label": "TestingL"
      }
    ],
    "insertedCount": 2,
    "result": {},
    "errorData": [],
    "errorMsg": ""
  }
}

When Encrypted Data is not in Correct Format

{
  "ok": true,
  "result": {
    "success": false,
    "errorMsg": "Invalid Encrypted Data"
  }
}

When Decrypted Data is not in Correct Format (Array)

{
  "ok": true,
  "result": {
    "success": false,
    "errorMsg": "Invalid Encrypted Data"
  }
}

When Decrypted Data is missing a required key

{
  "ok": true,
  "result": {
    "success": false,
    "errorMsg": "Invalid Email: Raw - 2"
  }
}

Last updated