Payouts

All the necessary APIs to manage payouts.

Overview

Welcome to the Payouts API Documentation! Our Payouts API is crafted to offer developers effortless access to streamlined fund transfers, facilitating transactions between bank accounts and mobile money wallets. Whether you're initiating bank transfers or topping up mobile money wallets, our API provides the essential tools and data to seamlessly integrate payout functionality into your platform.

By leveraging our Payouts API, developers can enhance user experiences, streamline payment processes, and unlock new possibilities in the financial technology landscape. Whether you're operating in traditional banking sectors or expanding into emerging mobile money markets, our API provides the necessary capabilities to meet your payout needs effectively.

Definitions

Here are some key terms used frequently in this documentation to describe API functionality. Feel free to refer back to this section if any term is unclear.

Bank transfer: A financial transaction that involves the electronic transfer of funds from one bank account to another.

Mobile money wallet: A digital wallet or account linked to a mobile phone number, allowing users to store funds and conduct financial transactions using mobile devices.

Bank transfers

Use this API to get bank transfer details.

cURL

curl --location 'https://business-api-testnet.palremit.com/core/payouts/bank-transfer' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxx' \
--data '{
    "amount": 200,
    "currency": "NGN",
    "description": "Payout from Palremit",
    "beneficiary": {
        "accountName": "John Doe ",
        "accountNumber": "1209677781",
        "bankCode": "305",
        "type": "individual",
        "country": "NG"
    }
}'

Python

import requests
import json

url = "https://business-api-testnet.palremit.com/core/payouts/bank-transfer"

payload = json.dumps({
  "amount": 200,
  "currency": "NGN",
  "description": "Payout from Palremit",
  "beneficiary": {
    "accountName": "John Doe ",
    "accountNumber": "1209677781",
    "bankCode": "305",
    "type": "individual",
    "country": "NG"
  }
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer xxxxx'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Body

amount : String *required

currency : String *required

description : String *required

beneficiary : Strings *required

Mobile money wallet

Use this API to get a mobile money wallet.

cURL

curl --location --request POST 'https://business-api-testnet.palremit.com/core/payouts/mobile-money' \
--header 'Authorization: Bearer xxxxx'

Python

import requests

url = "https://business-api-testnet.palremit.com/core/payouts/mobile-money"

payload = {}
headers = {
  'Authorization': 'Bearer xxxxx'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)