Transfers

The Transfers API facilitates Funds transfers processes within your integrated system.

The execution of the following requests requires double authentication (public and private keys). The key is present in the merchant's dashboard.

Initialize Transfer

Hey there, start a transfer from Notch Pay.

Attributes

  • Name
    currency
    Type
    string
    Description

    Currency of transaction.

  • Name
    amount
    Type
    numeric
    Description

    Amount to be transferred. According to currency.

  • Name
    description
    Type
    string
    Description

    The reason of transfer.

  • Name
    channel
    Type
    string
    Description

    Payment channel to make a payment with. Available channels include:

    1. cm.mtn: For MTN Mobile Money Cameroun
    2. cm.orange: For Orange Money Cameroun
    3. cm.mobile: For (Orange or MTN Mobile) Money Cameroun

Beneficiary parameters according to channel

  1. cm.mtn
  • phone : MTN Mobile mobile money number to receive funds
  1. cm.orange
  • phone : Orange money number to receive funds
  1. cm.mobile
  • phone : Orange money or MTN number to receive funds

Transfer

POST
/transfers
curl --location --request POST 'https://api.notchpay.co/transfers' \
--header 'Authorization: PUBLIC_KEY' \
--header 'Grant-Authorization: PRIVATE_KEY' \
--header 'Accept: application/json' \
--form 'currency="XAF"' \
--form 'amount="1325"' \
--form 'channel="cm.mobile"' \
--form "beneficiary" : {
"phone": "+237656019261"
} \
--form 'reference="your_unique_reference"' \
--form 'description="Account refund"'

Response

{
    "status": "Accepted",
    "message": "Transfer initialized",
    "code": 201,
    "transfer": {
    "amount": 1325,
    "amount_total": 1339,
    "fee": 14,
    "converted_amount": 1325,
    "business": {
    "id": "9pDOCy7Rp",
    "country": "CM",
    "email": "hello@notchpay.co",
    "phone": "+237 6 55 72 82 67",
    "poster": null,
    "name": "Notch Africa"
},
    "beneficiary": {
    "id": "bp.athib1F4L",
    "phone": "694677360",
    "name": null,
    "email": null,
    "country": "CM",
    "channel": {
    "name": "Orange Money",
    "type": "mobile",
    "id": "cm.orange"
},
    "receiver": {
    "number": "694677360"
}
},
    "description": "Account refund",
    "reference": "CPTpkZgsB9mHjnUPHEmxaQI6A0TlLd80",
    "status": "sended",
    "currency": "XAF",
    "initiated_at": "2023-05-24T22:54:42.000000Z",
    "updated_at": "2023-05-24T22:54:48.000000Z"
}
}

Fetch Transfer

Get Transfer details

Optionnal attributes

  • Name
    currency
    Type
    string
    Description

    Convert amount to given currency

Request

GET
/transfers/:reference
curl -G https://api.notchpay.co/transfers/bWpe7YBkjBZxUzRv60iDPTQJsiVUQLRt \
-H "Authorization: {PUBLIC_KEY}"
-H "Grant-Authorization: {PRIVATE_KEY}"

Response

{
    "code": 200,
    "status": "OK",
    "message": "Transfer retrieved",
    "transfer": {
        "amount": 10,
        "amount_total": 11,
        "fee": 1,
        "converted_amount": 10,
        "business": {
        "id": "9pDOCy7Rp",
        "country": "CM",
        "email": "hello@notchpay.co",
        "phone": "+237 6 55 72 82 67",
        "poster": null,
        "name": "Notch Africa"
    },
        "beneficiary": {
        "id": "bp.XnpRotoNo",
        "phone": "+237656019261,
        "name": null,
        "email": null,
        "country": "CM",
        "channel": {
        "name": "Orange Money",
        "type": "mobile",
        "id": "cm.orange"
    },
        "receiver": {
        "number": "+237656019261"
    }
    },
        "description": "My description",
        "reference": "TcCQJvKr53tHeQHRG6gTNWwOZYmiDdAi",
        "status": "complete",
        "currency": "XAF",
        "initiated_at": "2023-05-24T21:46:08.000000Z",
        "updated_at": "2023-05-24T21:46:08.000000Z"
    },
}

List Transfers

This endpoint allows you to retrieve a paginated list of all your transfers. By default, a maximum of thirty transfers are shown per page.

Optional attributes

  • Name
    perpage
    Type
    integer
    Description

    Number of transfers returned per page.

  • Name
    page
    Type
    integer
    Description

    Select items on specified page

Request

GET
/transfers
curl -G https://api.notchpay.co/transfers \
-H "Authorization: {PUBLIC_KEY}"
-H "Grant-Authorization: {PRIVATE_KEY}"

Response

{
    "code": 200,
    "status": "OK",
    "message": "Transfers retrieved",
    "totals": 3,
    "last_page": 1,
    "current_page": 1,
    "selected": 3,
    "items": [
{
    "amount": 10,
    "amount_total": 10.1,
    "fee": 0.1,
    "converted_amount": 10,
    "business": {
    "id": "9pDOCy7Rp",
    "country": "CM",
    "email": "hello@notchpay.co",
    "phone": "+237 6 55 72 82 67",
    "poster": null,
    "name": "Notch Africa"
},
    "beneficiary": {
    "id": "bp.XnpRotoNo",
    "phone": "+237656019261,
    "name": null,
    "email": null,
    "country": "CM",
    "channel": {
    "name": "Orange Money",
    "type": "mobile",
    "id": "cm.orange"
},
    "receiver": {
    "number": "+237656019261"
}
},
    "description": "My description",
    "reference": "TcCQJvKr53tHeQHRG6gTNWwOZYmiDdAi",
    "status": "complete",
    "currency": "XAF",
    "initiated_at": "2023-05-24T21:46:08.000000Z",
    "updated_at": "2023-05-24T21:46:08.000000Z"
},
    // ...
    ]
}