Payed Virtual Account Integration

Create a virtual account for a customer on an existing wallet

Getpayed virtual account integration guide

1. Login to the web via https://app.getpayed.co/login

2. Navigate to settings page and activate api access for your account https://app.getpayed.co/settings/api

3. Copy the API Key and Account ID

4. Provide a callback url for your server where you will be notified about new transactions. This should not be a frontend facing url

5. Implement the available inflow event web-hook here

6. Create account aliases (Virtual accounts) using the api below

   1. Create Virtual Account

   2. List All Virtual Accounts

   3. Disable Virtual Account

   4. Update Virtual Account Name

Create a new reserved nuban for an account profile

post

Create a new reserved nuban for an account profile

Authorizations

PayedIdToken

AuthorizationstringRequired

Enter the payed token with the Bearer: prefix, e.g. "Bearer abcde12345".

Path parameters

accountProfileIdnumberRequired

account profile id

Body

application/json

account_namestring · min: 5 · max: 255Optional

make_defaultbooleanOptional

providerstring · enumOptionalPossible values:

referencestring · max: 255Optional

Responses

201

Created

application/json

account_namestringOptional

account_numberstringOptional

account_referencestringOptional

bank_codestringOptional

bank_namestringOptional

created_atstringOptional

idintegerOptional

payed_account_profile_idintegerOptional

providerstringOptional

400

Bad Request

application/json

post

/v1/accounts/{accountProfileId}/reserved-nubans

HTTPcURLJavaScriptPython

POST /v1/accounts/{accountProfileId}/reserved-nubans HTTP/1.1
Host: api.getpayed.co
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "account_name": "text",
  "kyc": {
    "bvn": "text",
    "first_name": "text",
    "last_name": "text"
  },
  "make_default": true,
  "provider": "sterling",
  "reference": "text"
}

{
  "account_name": "text",
  "account_number": "text",
  "account_reference": "text",
  "bank_code": "text",
  "bank_name": "text",
  "created_at": "text",
  "id": 1,
  "payed_account_profile_id": 1,
  "provider": "text"
}

List reserved nubans for an account profile

get

List reserved nubans for an account profile

Authorizations

PayedIdToken

AuthorizationstringRequired

Enter the payed token with the Bearer: prefix, e.g. "Bearer abcde12345".

Path parameters

accountProfileIdnumberRequired

account profile id

Query parameters

pagenumberOptional

page

limitnumberOptional

limit of returned items

querystringOptional

search parameter

Responses

200

OK

application/json

400

Bad Request

application/json

get

/v1/accounts/{accountProfileId}/reserved-nubans

HTTPcURLJavaScriptPython

GET /v1/accounts/{accountProfileId}/reserved-nubans HTTP/1.1
Host: api.getpayed.co
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "account_name": "text",
      "account_number": "text",
      "account_reference": "text",
      "bank_code": "text",
      "bank_name": "text",
      "created_at": "text",
      "id": 1,
      "payed_account_profile_id": 1,
      "provider": "text"
    }
  ],
  "message": "text",
  "meta": {
    "count": 1,
    "current_page": 1,
    "page": 1,
    "size": 1,
    "total_pages": 1,
    "total_size": 1
  },
  "status": "text",
  "success": true
}

Show reserved nuban for an account profile by id

get

Show reserved nuban for an account profile by id

Authorizations

PayedIdToken

AuthorizationstringRequired

Enter the payed token with the Bearer: prefix, e.g. "Bearer abcde12345".

Path parameters

accountProfileIdnumberRequired

account profile id

reservedAccountIdnumberRequired

reserved account id

Responses

200

OK

application/json

400

Bad Request

application/json

get

/v1/accounts/{accountProfileId}/reserved-nubans/{reservedAccountId}

HTTPcURLJavaScriptPython

GET /v1/accounts/{accountProfileId}/reserved-nubans/{reservedAccountId} HTTP/1.1
Host: api.getpayed.co
Authorization: YOUR_API_KEY
Accept: */*

{
  "account_name": "text",
  "account_number": "text",
  "account_reference": "text",
  "bank_code": "text",
  "bank_name": "text",
  "created_at": "text",
  "id": 1,
  "payed_account_profile_id": 1,
  "provider": "text"
}

Patch a reserved nuban for an account profile by id

patch

Patch reserved nuban for an account profile by id

Authorizations

PayedIdToken

AuthorizationstringRequired

Enter the payed token with the Bearer: prefix, e.g. "Bearer abcde12345".

Path parameters

accountProfileIdnumberRequired

account profile id

reservedAccountIdnumberRequired

reserved account id

Body

application/json

account_namestring · min: 5 · max: 255Required

Responses

200

OK

application/json

400

Bad Request

application/json

patch

/v1/accounts/{accountProfileId}/reserved-nubans/{reservedAccountId}

HTTPcURLJavaScriptPython

PATCH /v1/accounts/{accountProfileId}/reserved-nubans/{reservedAccountId} HTTP/1.1
Host: api.getpayed.co
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "account_name": "text",
  "kyc": {
    "bvn": "text",
    "first_name": "text",
    "last_name": "text"
  }
}

{
  "account_name": "text",
  "account_number": "text",
  "account_reference": "text",
  "bank_code": "text",
  "bank_name": "text",
  "created_at": "text",
  "id": 1,
  "payed_account_profile_id": 1,
  "provider": "text"
}

Disable a reserved nuban for an account profile by id

delete

Disable reserved nuban for an account profile by id

Authorizations

PayedIdToken

AuthorizationstringRequired

Enter the payed token with the Bearer: prefix, e.g. "Bearer abcde12345".

Path parameters

accountProfileIdnumberRequired

account profile id

reservedAccountIdnumberRequired

reserved account id

Responses

200

OK

application/json

400

Bad Request

application/json

delete

/v1/accounts/{accountProfileId}/reserved-nubans/{reservedAccountId}

HTTPcURLJavaScriptPython

DELETE /v1/accounts/{accountProfileId}/reserved-nubans/{reservedAccountId} HTTP/1.1
Host: api.getpayed.co
Authorization: YOUR_API_KEY
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}