Transfer

All the necessary APIs to manage transfers

Overview

Welcome to the Transfers API Documentation! Our Transfers API is tailored to streamline the process of creating, confirming, and fetching transfers, offering seamless integration for your financial applications. Whether you're facilitating cross-border transactions, managing international business payments, or incorporating transfer functionality into your platform, our API provides the tools and data necessary to power your transfer solutions. With real-time capabilities and comprehensive transfer management features, our API ensures smooth and efficient transfer processing to meet your business needs.

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.

Transfer: The movement of funds or assets from one account or entity to another, typically facilitated through electronic means.

Confirmation: An acknowledgment or verification of the successful completion of a transfer or transaction.

Create Transfer

Use this endpoint to create transfers.

cURL

 curl --location --request PUT 'https://business-api-testnet.palremit.com/core/collections/transfer' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxx' \
--data-raw '{
    "amount": "500",
    "currency": "NGN",
    "payerEmail": "[e-mail]"
}'

Python

import requests
import json

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

payload = json.dumps({
  "amount": "500",
  "currency": "NGN",
  "payerEmail": "[e-mail]"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer xxxxx'
}

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

print(response.text)

Body

amount : String *required

currency : String *required

payerEmail : String *required

Response

🟢 200: successful.

{
    "status": "success",
    "message": "Successful",
    "data": {
        "id": "98a0cfc616d34c2d75794bb3",
        "amount": 500,
        "amountPaid": 0,
        "accountNumber": "3995417671",
        "accountName": "FIN-Palremit limited",
        "bankName": "GLOBUS BANK",
        "bankCode": "103",
        "reference": "PR1705037754062",
        "currency": "NGN",
        "businessId": "906065b877acb6d08b45cf2c",
        "payerEmail": "[e-mail]",
        "payerName": "",
        "payerId": "",
        "channel": null,
        "network": null,
        "status": "AWAITING",
        "createdAt": "2024-01-12T05:36:05.105Z",
        "updatedAt": "2024-01-12T05:36:05.105Z"
    }
}

{
    "status": "pending",
    "message": "Transfer in progress",
    "data": {
        "transfer_id": "46b34249d13048f48cd621142573060e"
    }

Request Confirmation

Use this endpoint to request transfer confirmation.

cURL

 curl --location --request PATCH 'https://business-api-testnet.palremit.com/core/collections/transfer/paid?reference=PR1706806677529' \
--header 'Authorization: Bearer xxxxx'

Python

 import requests

url = "https://business-api-testnet.palremit.com/core/collections/transfer/paid?reference=PR1706806677529"

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

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

print(response.text)

Response

🟢 200: successful.

{
    "status": "success",
    "message": "Successful",
    "data": {
        "id": "98a0cfc616d34c2d75794bb3",
        "amount": 500,
        "amountPaid": 0,
        "accountNumber": "1235417671",
        "accountName": "FIN-Palremit limited",
        "bankName": "GLOBUS BANK",
        "bankCode": "103",
        "reference": "PR1705037754062",
        "currency": "NGN",
        "businessId": "906065b877acb6d08b45cf2c",
        "payerEmail": "[e-mail]",
        "payerName": "",
        "payerId": "",
        "channel": null,
        "network": null,
        "status": "PENDING",
        "createdAt": "2024-01-12T05:36:05.105Z",
        "updatedAt": "2024-01-12T05:36:05.105Z"
    }
}

Confirm Transfer

Use this endpoint to confirm transfers.

cURL

curl --location --request PATCH 'https://business-api-testnet.palremit.com/core/collections/transfer/confirm?reference=PR1706807126143' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxx' \
--data '{
    "amount": "100",
    "currency": "NGN"
}'

Python

import requests
import json

url = "https://business-api-testnet.palremit.com/core/collections/transfer/confirm?reference=PR1706807126143"

payload = json.dumps({
  "amount": "100",
  "currency": "NGN"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer xxxxx'
}

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

print(response.text)

Body

amount : String *required

currency : String *required

Response

🔴 400: Transfer already confirmed

{
    "status": "error",
    "message": "Transfer already confirmed"
}

Fetch transfer

Use this endpoint to fetch transfers.

cURL

curl --location 'https://business-api-testnet.palremit.com/core/collections/transfer' \
--header 'Authorization: Bearer xxxxx'

Python

import requests

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

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

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

print(response.text)

Response

🟢 200: successful.

{
    "status": "success",
    "message": "Successful",
    "data": [
        {
            "id": "98a0cfc616d34c2d75794bb3",
            "amount": 500,
            "amountPaid": 0,
            "accountNumber": "1235417671",
            "accountName": "FIN-Palremit limited",
            "bankName": "GLOBUS BANK",
            "bankCode": "103",
            "reference": "PR1705037754062",
            "currency": "NGN",
            "businessId": "906065b877acb6d08b45cf2c",
            "payerEmail": "[e-mail]",
            "payerName": "",
            "payerId": "",
            "channel": null,
            "network": null,
            "status": "PENDING",
            "createdAt": "2024-01-12T05:36:05.105Z",
            "updatedAt": "2024-01-12T06:02:30.228Z"
        }
    ]
}