Create Transfer Recipient

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

name

string

required

account_number

string

required

bank_code

string

required

Bank code e.g 058

metadata

object

optional

type

enum<string>

optional

Transfer type

Allowed values:

ng_nubanng_opay_wallet

Example

{
    "RAW_BODY": {
        "name": "string",
        "account_number": "string",
        "bank_code": "string",
        "metadata": {},
        "type": "ng_nuban"
    }
}

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/recipients' \
--header 'Content-Type: application/json' \
--data-raw '{
    "RAW_BODY": {
        "name": "string",
        "account_number": "string",
        "bank_code": "string",
        "metadata": {},
        "type": "ng_nuban"
    }
}'

Responses

🟢200OK

application/json

200

Body

message

string

optional

Example:

Transfer recipient created successfully

data

object

optional

id

integer

optional

Default:

0

Example:

1

name

string

optional

Example:

Wale Kas

account_name

string

optional

Example:

MARTINS ADEWALE

account_number

string

optional

Example:

0227717171

short_code

string

optional

Example:

TRP_rt8sm0j1je

bank_name

string

optional

Example:

Guaranty Trust Bank

bank_code

string

optional

Example:

058

currency

string

optional

Example:

NGN

country

string

optional

Example:

NG

created_at

string

optional

Example:

2021-05-22T14:01:07.638Z

updated_at

string

optional

Example:

2021-05-22T14:01:07.638Z

Example

{
  "message": "Transfer recipient created successfully",
  "data": {
    "id": 1,
    "name": "Wale Kas",
    "account_name": "MARTINS ADEWALE",
    "account_number": "0227717171",
    "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"
  }
}

🟠400Bad Request