Create Collection

POST

collections

cURL

curl --request POST \
  --url https://api.swervpay.co/api/v1/collections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "currency": "<string>",
  "customer_id": "<string>",
  "merchant_name": "<string>",
  "reference": "<string>",
  "type": "<string>"
}
'

import requests

url = "https://api.swervpay.co/api/v1/collections"

payload = {
    "amount": 123,
    "currency": "<string>",
    "customer_id": "<string>",
    "merchant_name": "<string>",
    "reference": "<string>",
    "type": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 123,
    currency: '<string>',
    customer_id: '<string>',
    merchant_name: '<string>',
    reference: '<string>',
    type: '<string>'
  })
};

fetch('https://api.swervpay.co/api/v1/collections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.swervpay.co/api/v1/collections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 123,
    'currency' => '<string>',
    'customer_id' => '<string>',
    'merchant_name' => '<string>',
    'reference' => '<string>',
    'type' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.swervpay.co/api/v1/collections"

	payload := strings.NewReader("{\n  \"amount\": 123,\n  \"currency\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"merchant_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"type\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.swervpay.co/api/v1/collections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 123,\n  \"currency\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"merchant_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"type\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.swervpay.co/api/v1/collections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 123,\n  \"currency\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"merchant_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"type\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "account_name": "<string>",
  "account_number": "<string>",
  "account_type": "<string>",
  "address": "<string>",
  "balance": 123,
  "bank_address": "<string>",
  "bank_code": "<string>",
  "bank_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "id": "<string>",
  "pending_balance": 123,
  "reference": "<string>",
  "routing_number": "<string>",
  "status": "<string>",
  "total_received": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>",
  "values": {}
}

{
  "message": "<string>",
  "values": {}
}

{
  "message": "<string>",
  "values": {}
}

Create a collection account for receiving payments. Collections support existing NGN virtual account flows and USD collection accounts.

NGN collection

Use NGN collections for Naira virtual accounts. ONE_TIME dynamic accounts are issued through VFD Microfinance Bank and require an amount. DEFAULT permanent accounts are issued through Teerus Microfinance Bank and require a customer_id.

curl -X POST https://api.swervpay.co/api/v1/collections \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": "cus_123456789",
    "currency": "NGN",
    "merchant_name": "Swervpay",
    "amount": 10000,
    "type": "ONE_TIME"
  }'

USD collection account

Use USD collections to issue a permanent USD collection account for an approved customer in an eligible country. USD collections must use type set to DEFAULT and must include additional_information. The customer’s approved KYC profile supplies the country, residential address, date of birth, phone number, and country-specific bank or national identifier. Do not replace those values in the collection request.

curl -X POST https://api.swervpay.co/api/v1/collections \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": "cus_123456789",
    "currency": "USD",
    "merchant_name": "Ada Okafor",
    "amount": 0,
    "type": "DEFAULT",
    "additional_information": {
      "account_type": "INDIVIDUAL",
      "employment_status": "EMPLOYED",
      "account_designation": "PERSONAL",
      "income_band": "UNDER_10000",
      "source_of_income": "SALARY",
      "document": {
        "type": "NIN",
        "number": "12345678901",
        "issue_date": "2020-01-01",
        "expiry_date": "2030-01-01",
        "urls": ["https://example.com/document-front.jpg"]
      },
      "utility_bill": "https://example.com/utility-bill.pdf",
      "bank_statement": "https://example.com/bank-statement.pdf"
    }
  }'

For USD collections, type must be DEFAULT, customer_id is required, and additional_information must include source-of-funds answers, the customer’s government document, utility bill, and bank statement information.

The government-document type must be appropriate for the customer’s KYC country. Supported values are PASSPORT, NIN, NATIONAL_ID, DRIVERS_LICENSE, VOTERS_CARD, and GHANA_CARD.

USD account issuance may complete asynchronously. Use the collection.created webhook to receive final bank details, or collection.created.failed to receive rejection reasons.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

additional_information

object

Show child attributes

amount

number

currency

string

customer_id

string

merchant_name

string

reference

string

type

string

Response

account_name

string

account_number

string

account_type

string

address

string

balance

number

bank_address

string

bank_code

string

bank_name

string

created_at

string<date-time>

currency

string

pending_balance

number

reference

string

routing_number

string

status

string

total_received

number

updated_at

string<date-time>

cURL

curl --request POST \
  --url https://api.swervpay.co/api/v1/collections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "currency": "<string>",
  "customer_id": "<string>",
  "merchant_name": "<string>",
  "reference": "<string>",
  "type": "<string>"
}
'

import requests

url = "https://api.swervpay.co/api/v1/collections"

payload = {
    "amount": 123,
    "currency": "<string>",
    "customer_id": "<string>",
    "merchant_name": "<string>",
    "reference": "<string>",
    "type": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 123,
    currency: '<string>',
    customer_id: '<string>',
    merchant_name: '<string>',
    reference: '<string>',
    type: '<string>'
  })
};

fetch('https://api.swervpay.co/api/v1/collections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.swervpay.co/api/v1/collections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 123,
    'currency' => '<string>',
    'customer_id' => '<string>',
    'merchant_name' => '<string>',
    'reference' => '<string>',
    'type' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.swervpay.co/api/v1/collections"

	payload := strings.NewReader("{\n  \"amount\": 123,\n  \"currency\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"merchant_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"type\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.swervpay.co/api/v1/collections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 123,\n  \"currency\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"merchant_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"type\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.swervpay.co/api/v1/collections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 123,\n  \"currency\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"merchant_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"type\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "account_name": "<string>",
  "account_number": "<string>",
  "account_type": "<string>",
  "address": "<string>",
  "balance": 123,
  "bank_address": "<string>",
  "bank_code": "<string>",
  "bank_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "id": "<string>",
  "pending_balance": 123,
  "reference": "<string>",
  "routing_number": "<string>",
  "status": "<string>",
  "total_received": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>",
  "values": {}
}

{
  "message": "<string>",
  "values": {}
}

{
  "message": "<string>",
  "values": {}
}

API Documentation

Authentication

Business

Bills

Cards

Checkout

Customers

Collections

FX

Identity

Invoices

Others

Payouts

Transactions

Wallets

Webhook

NGN collection

USD collection account

Authorizations

Body

Response

​NGN collection

​USD collection account

Authorizations

Body

Response

NGN collection

USD collection account