Create Transfer

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

RAW_BODY

object

optional

amount

integer <int32>

required

amount to transfer in kobo

recipient

string

required

Transfer recipient code

reference

string

required

merchant reference

narration

string

required

transfer description

metadata

object

optional

string

optional

Account transaction pin

Default:

"1234"

Example

{
    "RAW_BODY": {
        "amount": 0,
        "recipient": "string",
        "reference": "string",
        "narration": "string",
        "metadata": {},
        "pin": "\"1234\""
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://devapi.collect.africa/transfers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "RAW_BODY": {
        "amount": 0,
        "recipient": "string",
        "reference": "string",
        "narration": "string",
        "metadata": {},
        "pin": "\"1234\""
    }
}'

Responses

🟢200OK

application/json

200

Body

message

string

optional

Example:

Transfer created successfully

data

object

optional

id

integer

optional

Default:

0

Example:

1

amount

integer

optional

Default:

0

Example:

10000

fee

integer

optional

Default:

0

Example:

5000

currency

string

optional

Example:

NGN

status

string

optional

Example:

pending

short_code

string

optional

Example:

TRF_qm11kfckpf

reference

string

optional

Example:

1112222

narration

string

optional

Example:

string

source

string

optional

Example:

balance

metadata

object

optional

recipient

object

optional

transferred_at

optional

created_at

string

optional

Example:

2021-05-24T11:36:42.000Z

updated_at

string

optional

Example:

2021-05-24T11:36:42.000Z

Example

{
  "message": "Transfer created successfully",
  "data": {
    "id": 1,
    "amount": 10000,
    "fee": 5000,
    "currency": "NGN",
    "status": "pending",
    "short_code": "TRF_qm11kfckpf",
    "reference": "1112222",
    "narration": "string",
    "source": "balance",
    "metadata": {},
    "recipient": {
      "id": 1,
      "name": "Wale Test",
      "account_name": "MARTINS ADEWALE",
      "account_number": "0227172785",
      "short_code": "TRP_rt8sm0j1je",
      "bank_name": "Guaranty Trust Bank",
      "bank_code": "058",
      "currency": "NGN",
      "country": "NG",
      "created_at": "2021-05-22T14:01:07.638Z",
      "updated_at": "2021-05-22T14:01:07.638Z"
    },
    "transferred_at": null,
    "created_at": "2021-05-24T11:36:42.000Z",
    "updated_at": "2021-05-24T11:36:42.000Z"
  }
}

🟠400Bad Request