# Authentication
Source: https://docs.swervpay.co/api-reference/authentication

Authenticate with Swerv API

Swervpay employs OAuth 2.0 as its fundamental security protocol. Access to Swerv endpoints necessitates obtaining an access token, granting entry to restricted endpoints.

To get an access token, you must first authenticate with the Swerv API. This is done by sending a POST request to the `/auth` endpoint with your business ID and secret key encoded in base64 as Basic Authorization in the request header.

<Info>Authentication URL: `POST` `https://api.swervpay.co/api/v1/auth`</Info>

### Sample Request

<CodeGroup>
  ```javascript Javascript theme={null}
  const response = await fetch(`https://api.swervpay.co/api/v1/auth`, {
      method: "POST",
      headers: {
          "Content-Type": "application/json",
          Authorization:  `Basic ${Buffer.from(`<BUSINESS_ID>:<SECRET_KEY>`).toString("base64")}`
      },
      body: JSON.stringify({}),
  });

  if (response.status !== 200 && response.status !== 201) {
      const body = await response.json();

      throw new Error(body as any);
  }

  const token = await response.json();
  ```

  ```php PHP theme={null}
  <?php

  $businessId = '<BUSINESS_ID>';
  $secretKey = '<SECRET_KEY>';
  $auth = base64_encode("{$businessId}:{$secretKey}");

  $options = [
      'http' => [
          'header'  => "Content-type: application/json\r\nAuthorization: Basic {$auth}",
          'method'  => 'POST',
          'content' => json_encode([]),
      ],
  ];

  $context  = stream_context_create($options);
  $response = file_get_contents('https://api.swervpay.co/api/v1/auth', false, $context);

  if ($response === FALSE) {
      throw new Exception('Error occurred while making request');
  }

  $httpCode = http_response_code();
  if ($httpCode !== 200 && $httpCode !== 201) {
      throw new Exception($response);
  }

  $token = json_decode($response, true);

  ?>
  ```

  ```go Go theme={null}
  package main

  import (
      "bytes"
      "encoding/base64"
      "encoding/json"
      "errors"
      "io/ioutil"
      "net/http"
  )

  func main() {
      businessID := "<BUSINESS_ID>"
      secretKey := "<SECRET_KEY>"
      auth := base64.StdEncoding.EncodeToString([]byte(businessID + ":" + secretKey))

      client := &http.Client{}
      req, _ := http.NewRequest("POST", "https://api.swervpay.co/api/v1/auth", bytes.NewBuffer([]byte("{}")))
      req.Header.Set("Content-Type", "application/json")
      req.Header.Set("Authorization", "Basic "+auth)

      resp, err := client.Do(req)
      if err != nil {
          panic(err)
      }
      defer resp.Body.Close()

      if resp.StatusCode != 200 && resp.StatusCode != 201 {
          bodyBytes, _ := ioutil.ReadAll(resp.Body)
          panic(errors.New(string(bodyBytes)))
      }

      var token map[string]interface{}
      json.NewDecoder(resp.Body).Decode(&token)
  }
  ```
</CodeGroup>

### Sample Response

```json Response theme={null}
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MDc1OTc0NDMsImlhdCI6MTcwNzU5Mzg0MywiaXNzIjoiU3dlcnZwYXkiLCJpZCI6ImJ1c19tdml1TlNNS2k3NHZUWTh5dmZQNm5RIiwidGtuIjp7InR5cCI6ImJlYXJlciIsImlkIjoiZGY2OTNjY2MtM2YwYy00NDAwLWE0YTQtMmM1YjE4YjBjZTNiIn19.53eKLonZZ8zvC_i2M_P4sQfZlmc7x-bSc8J95TCtIwY",
  "token": {
    "type": "bearer",
    "expires_at": 1707597443075,
    "issued_at": 1707593843075
  }
}
```

<Warning>The access token gotten from the auth API expires after 1 hour.</Warning>


# Authentication
Source: https://docs.swervpay.co/api-reference/authentication/auth

POST /auth
Authentication using business id and secret key



# Bill Categories
Source: https://docs.swervpay.co/api-reference/bills/categories

GET /bills/categories
Get list of bill categories

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/bills/categories \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.bill.categories();
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->bill()->categories()->toArray();
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Bill.Categories(ctx)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Create bill
Source: https://docs.swervpay.co/api-reference/bills/create

POST /bills
Create bill

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/bills \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
    -d '{
    "customer_id": "<CUSTOMER_ID>",
    "amount": "<AMOUNT>",
    "reference": "<REFERENCE>",
    "biller_id": "<BILLER_ID>",
    "item_id": "<ITEM_ID>",
    "category": "<CATEGORY>",
    }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.bill.create({
  	"amount": "<AMOUNT>",
  	"customer_id": "<CUSTOMER_ID>",
  	"reference": "<REFERENCE>",
  	"biller_id": "<BILLER_ID>",
  	"item_id": "<ITEM_ID>",
  	"category": "<CATEGORY>",
  });
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $payload = array(
      "customer_id" => "<CUSTOMER_ID>",
  	"amount" => "<AMOUNT>",
  	"reference" => "<REFERENCE>",
  	"biller_id" => "<BILLER_ID>",
  	"item_id" => "<ITEM_ID>",
  	"category" => "<CATEGORY>",
  )

  $client->bill()->create($payload)->toArray();
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

      payload := swervpay.BillCreateRequest{
  		CustomerID: "<CUSTOMER_ID>",
  		Amount: "<AMOUNT>",
  		Reference: "<REFERENCE>",
  		BillerID: "<BILLER_ID>",
  		ItemID: "<ITEM_ID>",
  		Category: "<CATEGORY>",
  	}

  	resp, err := client.Bill.Create(ctx, payload)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get bill
Source: https://docs.swervpay.co/api-reference/bills/get

GET /bills/{id}
Get bill

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/bills/<BILL_ID> \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.bill.get("<BILL_ID>");
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->bill()->get("<BILL_ID>")->toArray();
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Bill.Get(ctx, "<BILL_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Bill Category Items
Source: https://docs.swervpay.co/api-reference/bills/items

GET /bills/categories/{id}/items/{itemId}
Get list of bill category list items

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/bills/categories/{id}/items/{itemId} \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.bill.items("<CATEGORY_ID>", "<BILLER_ID>");
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->bill()->items("<CATEGORY_ID>", "<BILLER_ID>")->toArray();
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Bill.Items(ctx, "<CATEGORY_ID>", "<BILLER_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Bill Category List
Source: https://docs.swervpay.co/api-reference/bills/lists

GET /bills/categories/{id}
Get list of bill category list

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/bills/categories/{id} \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.bill.list("<CATEGORY_ID>");
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->bill()->list("<CATEGORY_ID>")->toArray();
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Bill.List(ctx, "<CATEGORY_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Validate customer
Source: https://docs.swervpay.co/api-reference/bills/validate

POST /bills/validate
Validate bill with customer

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/bills/validate \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
    -d '{
    "biller_id": "<BILLER_ID>",
    "customer_id": "<CUSTOMER_ID>",
    "category": "<CATEGORY>"
  }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.bill.validate({
  	"biller_id": "<BILLER_ID>",
  	"customer_id": "<CUSTOMER_ID>",
  	"category": "<CATEGORY>"
  });
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->bill()->validate(array(
  	"biller_id" => "<BILLER_ID>",
  	"customer_id" => "<CUSTOMER_ID>",
  	"category" => "<CATEGORY>"
  ));
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	payload := swervpay.BillValidateRequest{
  		BillerID: "<BILLER_ID>",
  		CustomerID: "<CUSTOMER_ID>",
  		Category: "<CATEGORY>",
  	}

  	resp, err := client.Bill.Validate(ctx, payload)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get Business
Source: https://docs.swervpay.co/api-reference/business/get

GET /business
Get business

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/business \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.business.get();
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->business()->get();
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Business.Get(ctx)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Create Card
Source: https://docs.swervpay.co/api-reference/cards/create

POST /cards
Create card

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/cards \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
    -d '{
      "customer_id": "user",
      "currency": "USD",
      "provider": "MASTERCARD",
      "amount": 10,
      "type": "DEFAULT"
    }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.card.create({
      customer_id: "user",
      currency: "USD",
      provider: "MASTERCARD",
      amount: 10,
      type: "DEFAULT"
  })
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->card()->create([
      "customer_id" => "user",
      "currency" => "USD",
      "provider" => "MASTERCARD",
      "amount" => 10,
      "type" => "DEFAULT"
  ]);
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

      data := swervpay.CreateCardBody{
          Type: "DEFAULT",
          Currency: "USD",
          Provider: "MASTERCARD",
          CustomerId: "user",
          Amount: 10
      }

  	resp, err := client.Card.Create(ctx, data)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Freeze Card
Source: https://docs.swervpay.co/api-reference/cards/freeze

POST /cards/{id}/freeze
Freeze card

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/cards/{id}/freeze \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
    -d '{
      
    }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.card.freeze('<CARD_ID>')
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->card()->freeze('<CARD_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Card.Freeze(ctx, "<CARD_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Fund Card
Source: https://docs.swervpay.co/api-reference/cards/fund-card

POST /cards/{id}/fund
Fund card

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/cards/{id}/fund \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
    -d '{
      "amount": 1000
    }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.card.fund('<CARD_ID>', {
      amount: "user"
  })
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->card()->fund('<CARD_ID>', [
      "amount" => "user"
  ]);
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

      data := swervpay.FundOrWithdrawCardBody{
          Amount: 1000
      }

  	resp, err := client.Card.Fund(ctx, "<CARD_ID>", data)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get Card
Source: https://docs.swervpay.co/api-reference/cards/get

GET /cards/{id}
Get card

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/cards/{id} \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.card.get('<CARD_ID>')
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->card()->get('<CARD_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Card.Get(ctx, "<CARD_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get All Cards
Source: https://docs.swervpay.co/api-reference/cards/get-all-cards

GET /cards
List all cards

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/cards \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.card.gets()
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->card()->gets()->toArray();
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
  		BusinessId: businessId
  		SecretKey: secretKey
    	})

    	query := swervpay.PageAndLimitQuery{
  		Limit: 10,
  		Page: 1,
  	}

  	resp, err := client.Card.Gets(ctx, query)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get Card Transaction
Source: https://docs.swervpay.co/api-reference/cards/get-transaction

GET /cards/{id}/transactions/{transactionId}
Get card transactions

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/cards/{id}/transactions/{transactionId} \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.card.transaction('<CARD_ID>', '<TRANSACTION_ID>');
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->card()->transaction('<CARD_ID>', '<TRANSACTION_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Card.Transaction(ctx, "<CARD_ID>", "<TRANSACTION_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Terminate Card
Source: https://docs.swervpay.co/api-reference/cards/terminate

POST /cards/{id}/terminate
Terminate card

<RequestExample>
  ```bash cURL theme={null}
  curl -X PUT https://api.swervpay.co/api/v1/cards/{id}/terminate \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
    -d '{

    }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.card.terminate('<CARD_ID>')
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->card()->terminate('<CARD_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Card.Terminate(ctx, "<CARD_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get Card Transactions
Source: https://docs.swervpay.co/api-reference/cards/transactions

GET /cards/{id}/transactions
List all card transactions

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/cards/{id}/transactions \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.card.transactions('<CARD_ID>')
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->card()->transactions('<CARD_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Card.Transactions(ctx, "<CARD_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Unfreeze Card
Source: https://docs.swervpay.co/api-reference/cards/unfreeze

POST /cards/{id}/unfreeze
Unfreeze card

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/cards/{id}/unfreeze \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
    -d '{
      
    }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.card.unfreeze('<CARD_ID>')
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->card()->unfreeze('<CARD_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Card.Unfreeze(ctx, "<CARD_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Withdraw from Card
Source: https://docs.swervpay.co/api-reference/cards/withdraw-from-card

POST /cards/{id}/withdraw
Card withdrawal

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/cards/{id}/withdraw \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
    -d '{
      "amount": 1000
    }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.card.withdraw('<CARD_ID>',{
      amount: "user"
  })
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->card()->withdraw('<CARD_ID>', [
      "amount" => "user"
  ]);
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

      data := swervpay.FundOrWithdrawCardBody{
          Amount: 1000,
      }

  	resp, err := client.Card.Withdraw(ctx, "<CARD_ID>", data)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Simulate credit transaction
Source: https://docs.swervpay.co/api-reference/checkouts/credit

POST /checkouts/{accountNo}/credit
Simulate credit transaction (Sandbox Only)



# Create Collection
Source: https://docs.swervpay.co/api-reference/collections/create

POST /collections
Create collection

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` collections require an `amount`. `DEFAULT` permanent collections require a `customer_id`.

```bash theme={null}
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. USD collections must use `type` set to `DEFAULT` and must include `additional_information`.

```bash theme={null}
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",
      "nin": "12345678901",
      "tax_number": "12345678901",
      "date_of_birth": "1994-04-12",
      "employment_status": "EMPLOYED",
      "account_designation": "PERSONAL",
      "income_band": "UNDER_10000",
      "source_of_income": "SALARY",
      "address": {
        "street": "12 Admiralty Way",
        "city": "Lagos",
        "state": "Lagos",
        "country": "Nigeria",
        "zip_code": "100001"
      },
      "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"
    }
  }'
```

<Note>
  For USD collections, `type` must be `DEFAULT`, `customer_id` is required, and `additional_information` must include the customer's identity, address, source-of-funds, document, utility bill, and bank statement information.
</Note>

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


# Simulate credit transaction
Source: https://docs.swervpay.co/api-reference/collections/credit

POST /collections/{id}/credit
Simulate credit transaction (Sandbox Only)



# Get Collection
Source: https://docs.swervpay.co/api-reference/collections/get

GET /collections/{id}
Get collection

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/collections/{id} \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.collection.get('<COLLECTION_ID>')
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->collection()->get('<COLLECTION_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Collection.Get(ctx, "<COLLECTION_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get All Collections
Source: https://docs.swervpay.co/api-reference/collections/get-all-collections

GET /collections
List all collections

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/collections \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.collection.gets()
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->card()->collection()->toArray();
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
  		BusinessId: businessId
  		SecretKey: secretKey
    	})

    	query := swervpay.PageAndLimitQuery{
  		Limit: 10,
  		Page: 1,
  	}

  	resp, err := client.Collection.Gets(ctx, query)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get Collection Transactions
Source: https://docs.swervpay.co/api-reference/collections/transaction

GET /collections/{id}/transactions
List all collection transactions

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/collections/{id}/transactions \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.collection.transactions('<COLLECTION_ID>')
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->collection()->transactions('<COLLECTION_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Collection.Transactions(ctx, "<COLLECTION_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Blacklist Customer
Source: https://docs.swervpay.co/api-reference/customers/blacklist

POST /customers/{id}/blacklist
Blacklist customer

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/customers/{id}/blacklist \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
    -d '{
    }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.customer.blacklist('<CUSTOMER_ID>');
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->customer()->blacklist('<CUSTOMER_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Customer.Blacklist(ctx, "<CUSTOMER_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Create Customer
Source: https://docs.swervpay.co/api-reference/customers/create

POST /customers
create customers

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/customers \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
    -d '{
      "firstname": "user",
      "lastname": "user",
      "middlename": "user",
      "country": "user",
      "email": "user@mailinator.com"
    }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.customer.create({
      firstname: "user",
      lastname: "user",
      middlename: "user",
      country: "user",
      email: "user@mailinator.com"
  })
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->customer()->create([
      "firstname" => "user",
      "lastname" => "user",
      "middlename" => "user",
      "country" => "user",
      "email" => "user@mailinator.com"
  ]);
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

      data := swervpay.CreateCustomerBody{
          Firstname: "user",
          Lastname: "user",
          Middlename: "user",
          Country: "user",
          Email: "user@mailinator.com"
      }

  	resp, err := client.Customer.Create(ctx, data)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get Customer
Source: https://docs.swervpay.co/api-reference/customers/get

GET /customers/{id}
Get customer

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/customers/{id} \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.customer.get('{id}')
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->customer()->get('<CUSTOMER_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Customer.Get(ctx, "<CUSTOMER_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get All Customers
Source: https://docs.swervpay.co/api-reference/customers/get-all-customers

GET /customers
Get customers

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/customers \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.customer.gets()
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->customer()->gets()->toArray();
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
  		BusinessId: businessId
  		SecretKey: secretKey
    	})

  	query := swervpay.PageAndLimitQuery{
  		Limit: 10,
  		Page: 1,
  	}

  	resp, err := client.Customer.Gets(ctx, query)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Customer KYC
Source: https://docs.swervpay.co/api-reference/customers/kyc

POST /customers/{id}/kyc
Update customer kyc

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/customers/{id}/kyc \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
    -d '{
  	"tier": "FULL",
  	"information": {
  		"bvn": "12345678901",
  		"state": "Lagos",
  		"city": "Ikeja",
  		"country": "Nigeria",
  		"address": "No 1, Ikeja",
  		"postal_code": "100001",
  		"date_of_birth": "1990-01-01"
  	},
  	"document": {
  		"documentType": "PASSPORT",
  		"documentNumber": "A1234567",
  		"document": "https://example.com/document.jpg",
  		"passport": "https://example.com/passport.jpg"
  	}
  }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.customer.kyc("<CUSTOMER_ID>", {
  	tier: "FULL",
  	information: {
  		bvn: "12345678901",
  		state: "Lagos",
  		city: "Ikeja",
  		country: "Nigeria",
  		address: "No 1, Ikeja",
  		postal_code: "100001",
  		date_of_birth: "1990-01-01"
  	},
  	document: {
  		document_type: "PASSPORT",
  		document_number: "A1234567",
  		document: "https://example.com/document.jpg",
  		passport: "https://example.com/passport.jpg"
  	}
  });
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->customer()->kyc('<CUSTOMER_ID>', [
  	'tier' => 'FULL',
  	'information' => [
  		'bvn' => '12345678901',
  		'state' => 'Lagos',
  		'city' => 'Ikeja',
  		'country' => 'Nigeria',
  		'address' => 'No 1, Ikeja',
  		'postal_code' => '100001',
  		'date_of_birth' => '1990-01-01'
  	],
  	'document' => [
  		'document_type' => 'PASSPORT',
  		'document_number' => 'A1234567',
  		'document' => 'https://example.com/document.jpg',
  		'passport' => 'https://example.com/passport.jpg'
  	]
  ]);
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

      data := swervpay.CustomerKycBody{
          Tier: "FULL",
  		Tier1: swervpay.Tier1KycInput{
  			Bvn: "12345678901",
  			State: "Lagos",
  			City: "Ikeja",
  			Country: "Nigeria",
  			Address: "No 1, Ikeja",
  			PostalCode: "100001",
  			DateOfBirth: "1990-01-01",
  		},
  		Tier2: swervpay.Tier2KycInput{
  			DocumentType: "PASSPORT",
  			DocumentNumber: "A1234567",
  			Document: "https://example.com/document.jpg",
  			Passport: "https://example.com/passport.jpg",
  		},
      }

  	resp, err := client.Customer.Kyc(ctx, "<CUSTOMER_ID>",  data)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Update Customer
Source: https://docs.swervpay.co/api-reference/customers/update

POST /customers/{id}/update
Update customer detail

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/customers/{id}/update \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
    -d '{
      "phone_number": "user",
      "email": "user@mailinator.com"
    }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.customer.update("<CUSTOMER_ID>", {
      phone_number: "user",
      email: "user@mailinator.com"
  })
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->customer()->update("<CUSTOMER_ID>", [
      "phone_number" => "user",
      "email" => "user@mailinator.com"
  ])->toArray();
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

      data := swervpay.UpdateCustomerBody{
          PhoneNumber: "user",
          Email: "user@mailinator.com"
      }

  	resp, err := client.Customer.Update(ctx, "<CUSTOMER_ID>", data)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Create FX
Source: https://docs.swervpay.co/api-reference/fx/exchange

POST /fx/exchange
Create exchange

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/fx/exchange \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
    -d '{
      "from": "NGN",
      "to": "USD",
      "amount": 1
    }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.fx.exchange({
      amount: 100,
      currency: 'NGN',
      to: 'USD'
  })
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->fx()->exchange([
      'amount' => 100,
      'currency' => 'NGN',
      'to' => 'USD'
  ]);
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

      data := swervpay.FxBody{
          Amount: 100,
          Currency: "NGN",
          To: "USD"
      }

  	resp, err := client.Fx.Exchange(ctx, data)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get FX Rates
Source: https://docs.swervpay.co/api-reference/fx/rate

POST /fx/rate
Get exchange rate

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/fx/rate \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
    -d '{
      "from": "NGN",
      "to": "USD",
      "amount": 1
    }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.fx.rate({
      amount: 100,
      currency: 'NGN',
      to: 'USD'
  })
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->fx()->rate([
      'amount' => 100,
      'currency' => 'NGN',
      'to' => 'USD'
  ]);
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

      data := swervpay.FxBody{
          Amount: 100,
          Currency: "NGN",
          To: "USD"
      }

  	resp, err := client.Fx.Rate(ctx, data)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# BVN Verification
Source: https://docs.swervpay.co/api-reference/identity/bvn

POST /identity/bvn
BVN Verification

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/identity/bvn \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
    -d '{
    "number": "12345678901"
    }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.identity.bvn("<NUMBER>")
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->identity()->bvn("<NUMBER>")->toArray();
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Identity.Bvn("<NUMBER>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Introduction
Source: https://docs.swervpay.co/api-reference/introduction



<Frame>
  <img alt="Dashboard Screenshot" />

  <img alt="Dashboard Screenshot" />
</Frame>

Swervpay provides a REST API for businesses building payment and embedded finance products. You can create collections, issue customer USD collection accounts, manage wallets, create and manage virtual cards, perform payouts, verify customer identity, retrieve transactions, and subscribe to real-time webhooks.

The API uses bearer authentication and is available in sandbox and production environments. Use sandbox while integrating, then complete the go-live checklist before moving production traffic.

<Note>
  Version: 1.0
</Note>

<Note>Production Base URL: `https://api.swervpay.co/api/v1`</Note>

<Note>Sandbox Base URL: `https://sandbox.swervpay.co/api/v1`</Note>

## Core resources

* [Authentication](/api-reference/authentication) - authenticate API requests.
* [Customers](/api-reference/customers/create) - create customers and submit KYC information.
* [Collections](/api-reference/collections/create) - create NGN and USD collection accounts.
* [Wallets](/api-reference/wallets/get-all-wallets) - view wallet balances and wallet activity.
* [Cards](/api-reference/cards/create) - create, fund, freeze, unfreeze, terminate, and withdraw from virtual cards.
* [Payouts](/api-reference/payouts/create) - send payouts to supported bank accounts.
* [Identity](/api-reference/identity/bvn) - verify BVN information.
* [Webhooks](/webhooks/introduction) - receive event updates for collections, payouts, cards, wallets, customers, and more.


# Get Invoice
Source: https://docs.swervpay.co/api-reference/invoices/get

GET /invoices/{id}
Get invoice



# Get All Invoices
Source: https://docs.swervpay.co/api-reference/invoices/get-all-invoices

GET /invoices
Get list of invoices



# Get banks
Source: https://docs.swervpay.co/api-reference/others/get-banks

GET /banks
Get banks

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/banks \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.other.banks()
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->other()->banks()->toArray();
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Other.Banks()

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Resolve Account Number
Source: https://docs.swervpay.co/api-reference/others/resolve-account-number

POST /resolve-account-number
Resolve bank account number

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/resolve-account-number \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
      -d '{
          "account_number": "user",
          "bank_code": "user"
      }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.other.resolve_account_number({
      'account_number': 'user',
      'bank_code': 'user'
  })
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->other()->resolve_account_number([
      'account_number' => 'user',
      'bank_code' => 'user
  ]);
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

      data := swervpay.ResolveAccountNumberBody{
          AccountNumber: "user",
          BankCode: "user"
      }

  	resp, err := client.Other.ResolveAccountNumber(ctx, data)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Create payout
Source: https://docs.swervpay.co/api-reference/payouts/create

POST /payouts
Create payout

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/payouts \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
    -d '{
      "bank_code": "user",
      "account_number": "user",
      "amount": "user",
      "currency": "NGN",
      "reference": "user",
      "narration": "user",
    }'
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.payout.create({
      bank_code: "user",
      account_number: "user",
      amount: "user",
      currency: "NGN",
      reference: "user",
      narration: "user"
  })
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->payout()->create([
      "bank_code" => "user",
      "account_number" => "user",
      "amount" => "user",
      "currency" => "NGN",
      "reference" => "user",
      "naration" => "user"
  ]);
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

      data := swervpay.CreatePayoutBody{
          BankCode: "user",
          AccountNumber: "user",
          Amount: "user",
          Currency: "NGN",
          Reference: "user",
          Narration: "user"
      }

  	resp, err := client.Payout.Create(ctx, data)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get payout
Source: https://docs.swervpay.co/api-reference/payouts/get

GET /payouts/{id}
Get payout

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/payouts/{id} \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.payout.get('{id}')
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->payout()->get('<PAYOUT_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Payout.Get(ctx, "<PAYOUT_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get Transaction
Source: https://docs.swervpay.co/api-reference/transactions/get

GET /transactions/{id}
Get transaction

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/transactions/{id} \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.transaction.get('<TRANSACTION_ID>')
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->transaction()->get('<TRANSACTION_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Transaction.Get(ctx, "<TRANSACTION_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get All Transctions
Source: https://docs.swervpay.co/api-reference/transactions/get-all-transactions

GET /transactions
Get list of transactions

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/transactions \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.transaction.gets()
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->transaction()->gets()->toArray();
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	query := swervpay.PageAndLimitQuery{
  		Limit: 10,
  		Page: 1,
  	}

  	resp, err := client.Transaction.Gets(ctx, query)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Simulate credit transaction
Source: https://docs.swervpay.co/api-reference/wallets/credit

POST /wallets/{id}/credit
Simulate credit transaction (Sandbox Only)



# Get Wallet
Source: https://docs.swervpay.co/api-reference/wallets/get

GET /wallets/{id}
Get wallet

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/wallets/{id} \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.wallet.get('<WALLET_ID>')
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->wallet()->get('<WALLET_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Wallet.Get(ctx, "<WALLET_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Get All Wallets
Source: https://docs.swervpay.co/api-reference/wallets/get-all-wallets

GET /wallets
Get wallets

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.swervpay.co/api/v1/wallets \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.wallet.gets()
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->wallet()->gets()->toArray();
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	query := swervpay.PageAndLimitQuery{
  		Limit: 10,
  		Page: 1,
  	}

  	resp, err := client.Wallet.Gets(ctx, query)

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Retry Webhook Log
Source: https://docs.swervpay.co/api-reference/webhook/retry

POST /webhook/log/{id}/retry
Retry webhook log

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/webhook/{id}/retry \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.webhook.retry('<WEBHOOK_LOG_ID>')
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->webhook()->retry('<WEBHOOK_LOG_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Webhook.Retry(ctx, "<WEBHOOK_LOG_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Test Webhook
Source: https://docs.swervpay.co/api-reference/webhook/test

POST /webhook/{id}/test
Send test webhook

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.swervpay.co/api/v1/webhook/{id}/test \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json"
  ```

  ```javascript Node.js theme={null}
  import { SwervpayClient } from '@swervpaydev/sdk';

  const config = {
      secretKey: "<SECRET_KEY>",
      businessId: "<BUSINESS_ID>"
  }

  const swervpay = new SwervpayClient(config);

  await swervpay.webhook.test('<WEBHOOK_ID>');
  ```

  ```php PHP theme={null}
  use Swervpaydev\SDK\Swervpay;

  $config = [
  	'business_id' => '<BUSINESS_ID>',
  	'secret_key' => '<SECRET_KEY>'
  ];

  $client = new Swervpay($config);

  $client->webhook()->test('<WEBHOOK_ID>');
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"github.com/swerv-ltd/swervpay-go"
  	"log"
  )

  func main() {
  	ctx := context.Background()

  	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
          BusinessID: "<BUSINESS_ID>",
          SecretKey: "<SECRET_KEY>",
      })

  	resp, err := client.Webhook.Test(ctx, "<WEBHOOK_ID>")

  	if err != nil {
  		log.Fatal("error", err.Error())
  		return
  	}
  }
  ```
</RequestExample>


# Overview
Source: https://docs.swervpay.co/card/introduction

Swerv Card API allows businesses to create card for their customer to pay anywhere global

This API provides a powerful, secure, and easy-to-use set of endpoints for card management, including creation, retrieval, freezing, and termination of cards. This guide will cover essential operations to help you manage card transactions within your applications

## Card Details Encryption

All card details are encrypted follows the AES standard with the following parameters:

* Algorithm: AES (RijndaelManaged)

* Mode: CBC (Cipher Block Chaining)

* Padding: PKCS7

* Block Size: 128-bit

* Key & IV: Derived from your registered Business ID:

* Key: The first 16 characters of your Business ID

* IV (Initialization Vector): The last 16 characters of your Business ID

```json Encrypted Card Details Payload theme={null}
{
    "card_number": "1234567890123456",
    "cvv": "123",
    "expiry": "12/34",
    "masked_pan": "424242******4242"
}
```

<CodeGroup>
  ```javascript NodeJS theme={null}
  const crypto = require('crypto');

  function decryptStringAES(cipherText, clientId) {
      const iv = Buffer.from(clientId.slice(0, 16), 'utf8');
      const key = Buffer.from(clientId.slice(-16), 'utf8');
      const encrypted = Buffer.from(cipherText, 'base64');
      try {
          const decipher = crypto.createDecipheriv('aes-128-cbc', key, iv);
          let decrypted = decipher.update(encrypted);
          decrypted = Buffer.concat([decrypted, decipher.final()]);
          return JSON.parse(decrypted.toString());
      } catch (err) {
          return "keyError";
      }
  }
  ```

  ```go Go theme={null}
  type CardInformation struct {
  	CardNumber string `json:"card_number"`
  	CardCvv    string `json:"cvv"`
  	CardExpiry string `json:"expiry"`
  	MaskedPan  string `json:"masked_pan"`
  }


  func decryptCardInformation(clientId, cipherText string) CardInformation {

  	iv := []byte(clientId[:16])
  	key := []byte(clientId[len(clientId)-16:])
  	encrypted, _ := base64.StdEncoding.DecodeString(cipherText)

  	block, err := aes.NewCipher(key)
  	if err != nil {
  		panic(err)
  	}

  	if len(encrypted)%aes.BlockSize != 0 {
  		panic("ciphertext not a multiple of block size")
  	}

  	mode := cipher.NewCBCDecrypter(block, iv)
  	decrypted := make([]byte, len(encrypted))
  	mode.CryptBlocks(decrypted, encrypted)

  	// remove PKCS7 padding
  	padLen := int(decrypted[len(decrypted)-1])
  	decrypted = decrypted[:len(decrypted)-padLen]

  	var details CardInformation
  	err = json.Unmarshal([]byte(decrypted), &details)
  	if err != nil {
  		panic(err)
  	}

  	return details
  }
  ```

  ```php PHP theme={null}
  function decryptStringAES($cipherText, $clientId) {
      $iv = substr($clientId, 0, 16);
      $key = substr($clientId, -16);
      $cipherBytes = base64_decode($cipherText);
      $decrypted = openssl_decrypt($cipherBytes, 'AES-128-CBC', $key, OPENSSL_RAW_DATA, $iv);
      if ($decrypted === false) {
          return "keyError";
      }
      return json_decode($decrypted, true);
  }
  ```
</CodeGroup>

### 📇 Create a Card

Initiate the creation of a virtual or physical card by sending a request to the [create](/api-reference/cards/create) card endpoint.

**Parameters**

<ParamField type="string">
  The unique identifier for the customer to whom the card will be issued.
</ParamField>

<ParamField type="string">
  The three-letter ISO currency code in uppercase.
</ParamField>

<ParamField type="string">
  The cardholder name that may appear on the card.
</ParamField>

<ParamField type="string">
  card provider e.g MASTERCARD, VISA
</ParamField>

<ParamField type="string">
  card type e.g DEFAULT, LITE or COOPERATE
</ParamField>

<ParamField type="integer">
  amount to pre-fund the card
</ParamField>

<ParamField type="string">
  The expiry date of the card in the format YYYY-MM-DD.
</ParamField>

<ParamField type="string">
  Phone number of the cardholder (for cooperate & lite card type only)
</ParamField>

<ParamField type="string">
  RC Number of the company (for cooperate card type only)
</ParamField>

<ParamField type="string">
  BVN of the director of the company (for cooperate card type only)
</ParamField>

<ParamField type="string">
  Business email of the company (for cooperate card type only)
</ParamField>

<ParamField type="string">
  Document number of the company (for lite card type only)
</ParamField>

<ParamField type="string">
  Document type of the company (for lite card type only)
</ParamField>

<Note>
  Note: `customer_id` is required for DEFAULT card type
</Note>

**Request Body**

Provide necessary details to set up a new card.

```json theme={null}
{
    "customer_id": "user",
    "currency": "USD",
    "issuer": "MASTERCARD",
    "name_on_card": "Swerv",
    "expiry_date": "2025-01-01",
    "amount": 10,
    "type": "DEFAULT"
}
```

### 💳➕ Fund Card

Add funds to an existing card using the [fund](/api-reference/cards/fund) endpoint. This operation is essential for increasing the card's available balance for use.

**Parameters**

<ParamField type="string">
  The unique identifier of the card to fund.
</ParamField>

**Body**

<ParamField type="integer">
  The amount to fund in the smallest currency unit.
</ParamField>

### 🔍 Get a Card

Retrieve information about a specific card with its unique identifier using the [get](/api-reference/cards/get) card endpoint.

**Parameters**

<ParamField type="string">
  The unique identifier of the card to retrieve.
</ParamField>

### ❄️ Freeze a Card

Temporarily disable a card to prevent new transactions by using the [freeze](/api-reference/cards/freeze) card endpoint.

**Path Parameters**

<ParamField type="string">
  The unique identifier of the card to freeze/unfreeze.
</ParamField>

### 🚫 Terminate a Card

Permanently disable a card and remove it from your account with the [terminate](/api-reference/cards/terminate) card endpoint.

**Path Parameters**

<ParamField type="string">
  The unique identifier of the card to terminate.
</ParamField>

### 💸  Withdraw from Card

Withdraw funds from the card back to your business account using the [withdraw-from-card](/api-reference/cards/withdraw-from-card) endpoint.

**Path Parameters**

<ParamField type="string">
  The unique identifier of the card to withdraw from.
</ParamField>

**Body**

<ParamField type="integer">
  The amount to fund in the smallest currency unit.
</ParamField>

### 🗂️ Get All Cards

To retrieve a comprehensive list of all the cards, use the [get all](/api-reference/cards/get-all-cards) cards endpoint. This method provides a paginated list of cards, complete with details for each card, allowing for effective oversight and management.

**Query Parameters**

<ParamField type="string">
  The page to return.
</ParamField>

<ParamField type="string">
  The maximum number of results to return.
</ParamField>

**Response Example**

The response returns an array of card objects with their respective details.

```json theme={null}
[
  {
    "id": "card_123456789",
    "type": "virtual",
    "status": "active",
    "card_number": "4242424242424242",
    "expiry": "12/34",
    "cvv": "123",
    "name_on_card": "John Doe",
    "balance": 500000, // Balance in the smallest currency unit
    "total_funded": 1500000, // Total funded in the smallest currency unit
    "freeze": false,
    "address_street": "123 Swyft Street",
    "address_city": "Paytown",
    "address_state": "Paystate",
    "address_country": "NG",
    "address_postal_code": "123456",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-02T00:00:00Z",
    "masked_pan": "424242******4242"
  }
  // ...other cards
]

```


# 2024 Changelog
Source: https://docs.swervpay.co/changelog/introduction



Stay up to date with the latest changes to our services

## August 2024

* Added [bvn verification](api-reference/identity/bvn) endpoint
* Update [create collection](api-reference/collections/create) endpoint to support additional information
* Update NodeJS sdk to support new changes
* Added unfreeze card endpoint
* Updated collection webhook

## July 2024

* Added support for IP whitelisting in dashboard
* Update get transaction to include collection details for collection transactions
* Update NodeJS sdk to support new changes

## June 2024

* Improve card issuance endpoint

## May 2024

* Update customer kyc to support voter's card
* Improve card issuance endpoint

## April 2024

* Added support for sandbox in all sdks

## March 2024

* (Sandbox Only) Added credit simulate for [wallet](api-reference/collections/credit), [collection](api-reference/wallets/credit), and [checkout](api-reference/checkouts/credit).
* Added sandbox endpoint for testing ([https://sandbox.swervpay.co/api/v1](https://sandbox.swervpay.co/api/v1))

## February 2024

* Added [NodeJS](https://www.npmjs.com/package/@swervpaydev/sdk) Sdk support
* Added [Go](https://github.com/Swerv-Ltd/swervpay-go) Sdk support
* Added [PHP](https://packagist.org/packages/swervpaydev/sdk) Sdk support
* Added [Laravel](https://packagist.org/packages/swervpaydev/laravel) Sdk support

## Jauary 2024

* Kick off the project


# Overview
Source: https://docs.swervpay.co/collection/introduction

Swerv Collection allows businesses to accept payments from their customers using virtual accounts & payment link.

## Supported partners

Below are the list of currently supported partners for virtual account issuing

* VFD Microfinance Bank
* Bridge for USD collection accounts

## Create Virtual Account

To create a virtual account, use the [create](/api-reference/collections/create) collection endpoint.

**Parameters**

<ParamField type="string">
  The unique identifier for the customer to whom the card will be issued.
</ParamField>

<ParamField type="string">
  The three-letter ISO currency code in uppercase. Use `NGN` for Naira accounts and `USD` for USD collection accounts.
</ParamField>

<ParamField type="string">
  merchant name that will be displayed on the virtual account. Required for ONE\_TIME (Temporary) virtual account.
</ParamField>

<ParamField type="string">
  virtual account type e.g DEFAULT (Permanent), ONE\_TIME (Temporary)
</ParamField>

<ParamField type="integer">
  amount expected to be paid into the virtual account. Required for ONE\_TIME (Temporary) virtual account.
</ParamField>

<ParamField type="object">
  Required when `currency` is `USD`. This contains the customer identity, address, document, source of funds, and supporting document details required for USD account issuance.
</ParamField>

<Note>
  Note: `customer_id` is required for `DEFAULT` permanent virtual accounts.
</Note>

```JSON Request Body theme={null}
{
    "customer_id": "user",
    "currency": "NGN",
    "merchant_name": "Swerv",
    "amount": 10,
    "type": "ONE_TIME"
}
```

### USD collection accounts

USD collection accounts are issued through Swervpay's Bridge-backed collection flow. Before creating a USD collection account, create the customer and submit customer KYC. Then create a `DEFAULT` collection with `currency` set to `USD` and include the required `additional_information` payload.

USD account issuance can be asynchronous. If the customer is already approved, the account details may be available shortly after creation. If additional review is required, listen for the `collection.created` or `collection.created.failed` webhook event.

```json USD Request Body theme={null}
{
  "customer_id": "cus_123456789",
  "currency": "USD",
  "merchant_name": "Ada Okafor",
  "amount": 0,
  "type": "DEFAULT",
  "additional_information": {
    "account_type": "INDIVIDUAL",
    "nin": "12345678901",
    "tax_number": "12345678901",
    "date_of_birth": "1994-04-12",
    "employment_status": "EMPLOYED",
    "account_designation": "PERSONAL",
    "income_band": "UNDER_10000",
    "source_of_income": "SALARY",
    "address": {
      "street": "12 Admiralty Way",
      "city": "Lagos",
      "state": "Lagos",
      "country": "Nigeria",
      "zip_code": "100001"
    },
    "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"
  }
}
```

Swervpay securely submits the required customer data to Bridge, creates or reuses the Bridge customer profile, and issues the USD deposit account when the customer is approved.

### 🔍 Get Collection Details

Retrieve detailed information of a specific collection with their unique identifier using the [get](/api-reference/collections/get) collection endpoint.

**Path Parameters**

<ParamField type="string">
  The unique identifier of the collection to retrieve.
</ParamField>

### 🔍 Get All collections

Retrieve a list of all collections by sending a request to the [get all](/api-reference/collections/get-all-collections) collections endpoint.

**Query Parameters**

<ParamField type="string">
  The page to return.
</ParamField>

<ParamField type="string">
  The maximum number of results to return.
</ParamField>

**Response Example**

The response provides an array of wallet objects, each containing comprehensive details about the wallets associated with your Swerv account.

```json Response theme={null}
[
  {
    "account_name": "string",
    "account_number": "string",
    "account_type": "string",
    "balance": 100000, // Balance in the smallest currency unit
    "bank_address": "string",
    "bank_code": "string",
    "bank_name": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "id": "wlt_123456789",
    "is_blocked": false,
    "pending_balance": 50000, // Pending balance in the smallest currency unit
    "reference": "string",
    "routing_number": "string",
    "total_received": 1500000, // Total amount received in the smallest currency unit
    "updated_at": "2024-01-02T00:00:00Z"
  }
  // ...other wallets
]
```


# Overview
Source: https://docs.swervpay.co/customer/introduction

Manage your customers efficiently with the Swerv Customers API.

### 🤖 Create a Customer

To add a new customer to your system, use the [create](/api-reference/customers/create) customer endpoint.

**Body**

<ParamField type="string">
  The customer's first name. It must match the customer's government-issued identification for KYC purposes.
</ParamField>

<ParamField type="string">
  The customer's last name or surname. It must match the customer's government-issued identification for KYC purposes.
</ParamField>

<ParamField type="string">
  The customer's middle name or initial. This can be used for additional verification and should match the customer's government-issued identification if provided.
</ParamField>

<ParamField type="string">
  The country of the customer's residence or operation. Use ISO 3166-1 alpha-2 country codes.
</ParamField>

<ParamField type="string">
  The customer's email address.
</ParamField>

**Request Body**

Provide necessary details to set up a new card.

```json Request Body theme={null}
{
  "firstname": "user",
  "lastname": "user",
  "middlename": "user",
  "country": "user",
  "email": "user@mailinator.com"
}
```

### 🔍 Get Customer Details

Retrieve detailed information of a specific customer with their unique identifier using the [get](/api-reference/customers/get) customer endpoint.

**Path Parameters**

<ParamField type="string">
  The unique identifier of the customer to retrieve.
</ParamField>

### 🔍 Get All Customers

Retrieve a comprehensive list of all customers in your system using the [get](/api-reference/customers/get-all-customers) all customers endpoint.

**Query Parameters**

<ParamField type="string">
  The page to return.
</ParamField>

<ParamField type="string">
  The maximum number of results to return.
</ParamField>

## Perform KYC for a Customer

Conduct Know Your Customer (KYC) checks to verify the identity of your customers using the [customer KYC](/api-reference/customers/kyc) endpoint.

<Note>
  Customer KYC is required before issuing a `DEFAULT` USD collection account for a customer. After KYC is submitted, create a USD collection with `currency` set to `USD` and include the required `additional_information` payload.
</Note>

**Parameters**

<ParamField type="string">
  The unique identifier of the customer to retrieve.
</ParamField>

**Body**

* `tier` enum (ONE, TWO, FULL) :
  * The amount to fund in the smallest currency unit.
* `information` object :
  * `bvn` string : customer bvn (Nigeria)
  * `ssnit` string : customer ssnit (Ghana)
  * `state` string : customer state
  * `city` string : customer city
  * `country` string : customer country
  * `address` string : customer address
  * `postal_code` string : customer address postal code
  * `date_of_birth` string : customer date of birth
* `document` object :
  * `document_type` enum (NIN, PASSPORT, DRIVERS\_LICENSE)
  * `document_number` number : customer document number
  * `document` url : customer document url
  * `passport` url : customer passport photograph url

```JSON Request Body theme={null}
{
	"tier": "FULL",
	"information": {
		"bvn": "12345678901",
		"state": "Lagos",
		"city": "Ikeja",
		"country": "Nigeria",
		"address": "No 1, Ikeja",
		"postal_code": "100001",
		"date_of_birth": "1990-01-01",
		"phone_number": "08012345678"
	},
	"document": {
		"document_type": "PASSPORT",
		"document_number": "A1234567",
		"document": "https://example.com/document.jpg",
		"passport": "https://example.com/passport.jpg"
	}
}
```

## Blacklist Customer

Blacklist customer from performing any action using the [post](/api-reference/customers/blacklist).

**Parameters**

<ParamField type="string">
  The unique identifier of the customer to blacklist.
</ParamField>


# Overview
Source: https://docs.swervpay.co/fx/introduction

Converting from one currency to another get easier with Swerv

### Supported Conversion

* USD to NGN
* NGN to USD

### 💵 Get Rate

To get current rate for convertion, use the [rate](/api-reference/fx/rate) endpoint.

**Body**

<ParamField type="string">
  The three-letter ISO currency code in uppercase.
</ParamField>

<ParamField type="string">
  The three-letter ISO currency code in uppercase.
</ParamField>

<ParamField type="integer">
  amount to convert in the smallest currency unit (e.g., cents, kobo).
</ParamField>

```json Request Body theme={null}
{
    "from": "NGN",
    "to": "USD",
    "amount": 1
}
```

### 💵 Exchnage

To convert from one currency to another, use the [exchange](/api-reference/fx/exchange) endpoint.

**Body**

<ParamField type="string">
  The three-letter ISO currency code in uppercase.
</ParamField>

<ParamField type="string">
  The three-letter ISO currency code in uppercase.
</ParamField>

<ParamField type="integer">
  amount to convert in the smallest currency unit (e.g., cents, kobo).
</ParamField>

```json Request Body theme={null}
{
    "from": "NGN",
    "to": "USD",
    "amount": 1
}
```


# Go live checklist
Source: https://docs.swervpay.co/go-live-checklist

A checklist of things to do before going live (production) with Swervpay.

## List

<AccordionGroup>
  <Accordion title="Create Business">
    After create account, you will be redirected to the dashboard. Click on the [Create Business](https://app.swervpay.co/businesses/new) button to create a business.
  </Accordion>

  <Accordion title="Complete Business KYC">
    After creating a business, you will be redirected to the business dashboard. On the business homepage click continue kyc button to complete the business KYC.
  </Accordion>

  <Accordion title="Invite team member">
    If you have a team member you want to invite to the business, you can do so by clicking on the [Invite Team Member](https://app.swervpay.co/~/settings/teams) button on the business dashboard.
  </Accordion>

  <Accordion title="Setup webhook">
    It is recommended to setup a webhook to receive event notification from Swervpay. You can do this by going to the developer section of the dashboard and clicking on the [Create Webhook](https://app.swervpay.co/~/developers/webhooks) button and make sure to run send test so as to conduct proper test for event communication.
  </Accordion>

  <Accordion title="Toggle live button in developer">
    Toggle the live button in the developer section of the dashboard to go live.
  </Accordion>
</AccordionGroup>


# Introduction
Source: https://docs.swervpay.co/introduction



<Frame>
  <img alt="Dashboard Screenshot" />

  <img alt="Dashboard Screenshot" />
</Frame>

Welcome to the Swervpay developer documentation. Swervpay gives businesses one API layer for building financial products across collections, payouts, cards, wallets, customers, identity verification, FX, and webhooks.

Use Swervpay to create NGN collection accounts, issue USD collection accounts for verified customers, manage customer profiles and KYC, create and fund virtual cards, move money to bank accounts, verify BVNs, and receive real-time event updates through webhooks. The API is designed for teams building payment, treasury, marketplace, remittance, and embedded finance workflows.

Start with the [Quickstart](/quickstart) if you want to make your first API call, or go directly to the [API Reference](/api-reference/introduction) for endpoint-level documentation.

## Resources

<CardGroup>
  <Card title="SDKs" icon="boxes-stacked" href="/sdks/introduction">
    Explore our SDKs to get started with your favorite language
  </Card>

  <Card title="Reference APIs" icon="code" href="/api-reference/introduction">
    Explore endpoints for collections, payouts, cards, customers, wallets, FX, identity, and webhooks
  </Card>

  <Card title="Changelog" icon="timer" href="/changelog">
    Stay up to date with the latest changes to our services
  </Card>

  <Card title="Contact Us" icon="user-headset" href="https://swervpay.co/slack">
    Having trouble? Reach out to our support team
  </Card>
</CardGroup>


# Overview
Source: https://docs.swervpay.co/payout/introduction

Swerv Payouts API allows businesses to automate and manage payout processes efficiently, ensuring fast, secure, and reliable transactions. This guide covers how to create a payout and retrieve payout details using our API

### Supported Currencies

The Swerv Payouts API currently supports the following currencies:

• **Nigerian Naira (NGN)**

• **United States Dollar (USD) (🚧 Coming Soon)**

• **Euro (EUR) (🚧 Coming Soon)**

• **British Pound (GBP) (🚧 Coming Soon)**

### Supported Banks for Naira Bank Transfer

The Swerv Payouts API currently supports the following banks for Naira Bank Transfer:

| Bank Name                | Bank Code |
| ------------------------ | --------- |
| Access Bank              | 044       |
| Citibank                 | 023       |
| Diamond Bank             | 063       |
| Ecobank Nigeria          | 050       |
| Fidelity Bank Nigeria    | 070       |
| First Bank of Nigeria    | 011       |
| First City Monument Bank | 214       |
| Guaranty Trust Bank      | 058       |

Retrieve the full list of supported banks using the [list](/api-reference/others/get-banks) banks endpoint.

### Create a Payout

To initiate a payout, use the [create](/api-reference/payouts/create) payout endpoint. This method allows you to send funds to a specified bank account. We currently support:

• **Naira Bank Transfer**

**Parameters**

<ParamField type="string">
  A unique bank code.
</ParamField>

<ParamField type="string">
  The recipient's bank account number.
</ParamField>

<ParamField type="integer">
  The total payout amount in the smallest currency unit (e.g., cents, kobo).
</ParamField>

<ParamField type="string">
  The three-letter ISO currency code in uppercase.
</ParamField>

<ParamField type="string">
  A unique identifier for the transaction.
</ParamField>

<ParamField type="string">
  A description for the transaction, to appear on the recipient’s statement.
</ParamField>

***

**Request Body**

Provide details of the payout, including the recipient's bank information, amount, and currency

```json Request Body theme={null}
{
  "bank_code": "059",
  "account_number": "0690000000",
  "amount": 8500,
  "currency": "NGN",
  "reference": "reference",
  "naration": "narration",
}
```

### Get a Payout

Retrieve details of a specific payout using its unique ID with the [get](/api-reference/payouts/get) payout endpoint.

**Path Parameters**

<ParamField type="string">
  The unique identifier of the payout to retrieve.
</ParamField>


# Quickstart
Source: https://docs.swervpay.co/quickstart



This guides demonstrate how to use Swervpay NodeJS SDK to integrate Swervpay into your NodeJS application.

### Setup

Make sure you have create a Swervpay business and have your API keys ready. Don't forget to check our recommended [go live checklist](/go-live-checklist).

### Install the SDK

Install [swervpay-node](https://www.npmjs.com/package/@swervpaydev/sdk) sdk into your new or existing NodeJS application using any of your favorite package manager.

<CodeGroup>
  ```bash npm theme={null}
  $ npm install @swervpaydev/sdk
  ```

  ```bash yarn theme={null}
  $ yarn add @swervpaydev/sdk
  ```

  ```bash pnpm theme={null}
  $ pnpm add @swervpaydev/sdk
  ```

  ```bash bun theme={null}
  $ bun install @swervpaydev/sdk
  ```
</CodeGroup>

### Usage

```javascript NodeJS theme={null}
import { SwervpayClient } from "@swervpaydev/sdk";

const config = {
    secretKey: "<SECRET_KEY>",
    businessId: "<BUSINESS_ID>"
}

const swervpay = new SwervpayClient(config);

// Create a new customer
await swervpay.customer.create({
    firstname: "user",
    lastname: "user",
    middlename: "user",
    country: "user",
    email: "user@mailinator.com"
})

// Create a new card
await swervpay.card.create({
    customer_id: "user",
    amount: 10,
    currency: "USD",
    provider: "MASTERCARD",
    type: "DEFAULT"
})

// Create a USD collection account for a customer
await swervpay.collection.create({
    customer_id: "user",
    currency: "USD",
    merchant_name: "Ada Okafor",
    amount: 0,
    type: "DEFAULT",
    additional_information: {
        account_type: "INDIVIDUAL",
        nin: "12345678901",
        tax_number: "12345678901",
        date_of_birth: "1994-04-12",
        employment_status: "EMPLOYED",
        account_designation: "PERSONAL",
        income_band: "UNDER_10000",
        source_of_income: "SALARY",
        address: {
            street: "12 Admiralty Way",
            city: "Lagos",
            state: "Lagos",
            country: "Nigeria",
            zip_code: "100001"
        },
        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"
    }
})

// Create a new payout
await swervpay.payout.create({
    bank_code: "user",
    account_number: "user",
    amount: "user",
    currency: "NGN",
    reference: "user",
    narration: "user"
})
```

Here, we initialize the Swervpay client with our secret key and business id. Then we create a new customer, card, USD collection account, and payout.

### Next Steps

* [Go Live Checklist](/go-live-checklist)

* [API Reference](/api-reference)

### Other SDKs

* [PHP](https://packagist.org/packages/swervpaydev/sdk)
* [Laravel](https://packagist.org/packages/swervpaydev/laravel)
* [Go](https://github.com/swerv-ltd/swervpay-go)


# Dart
Source: https://docs.swervpay.co/sdks/dart

Dart Client for Swervpay

### Installation

Install [swervpay-dart](https://pub.dev/packages/swervpay_dart) sdk into your new or existing Flutter/Dart application.

```bash Shell theme={null}
$ flutter pub add swervpay_dart

# OR

$ dart pub add swervpay_dart
```

### Usage

```dart Dart/Flutter theme={null}
import 'package:swervpay_dart/swervpay_dart.dart';

void main() async {

    final swervpay = Swervpay(
        apiKey
    );

}
```


# Go
Source: https://docs.swervpay.co/sdks/go

Go Client for Swervpay

### Installation

Install [swervpay-go](https://github.com/swerv-ltd/swervpay-go) sdk into your new or existing Go application.

```bash Shell theme={null}
$ go get github.com/swerv-ltd/swervpay-go
```

### Usage

```go Go theme={null}
package main

import (
    "context"
	"fmt"
	"github.com/swerv-ltd/swervpay-go"
	"os"
)

func main() {


    ctx := context.Background()

	businessId := os.Getenv("SWERVPAY_BUSINESS_ID")
	secretKey := os.Getenv("SWERVPAY_SECRET_KEY")

	client := swervpay.NewSwervpayClient(&swervpay.SwervpayClientOption{
		BusinessID: businessId,
		SecretKey:  secretKey,
	})

	customers, err := client.Customer.Gets(ctx, &swervpay.PageAndLimitQuery{
		Page:  1,
		Limit: 10,
	})

	if err != nil {
		panic(err)
	}

	for _, customer := range *customers {
		fmt.Printf("%v\n", customer)
	}

	customer, err := client.Customer.Get(ctx, "cus_123456")

	if err != nil {
		panic(err)
	}

	fmt.Printf("%v\n", customer)

	newCustomer, err := client.Customer.Create(ctx, &swervpay.CreateCustomerBody{
		Firstname:  "John",
		Lastname:   "Doe",
		Middlename: "Doe",
		Email:      "johndoe@gmail.com",
		Country:    "Nigeria",
	})

	if err != nil {
		panic(err)
	}

	fmt.Println("Created Customer id: " + newCustomer.ID)
	fmt.Printf("%v\n", newCustomer)


    banks, err := client.Other.Banks(ctx)

	if err != nil {
		panic(err)
	}

	for _, bank := range *banks {
		fmt.Printf("%v\n", bank)
	}

	resolveAccount, err := client.Other.ResolveAccountNumber(ctx, swervpay.ResolveAccountNumberBody{
		BankCode:      "044",
		AccountNumber: "0690000031",
	})

	if err != nil {
		panic(err)
	}

	fmt.Printf("%v\n", resolveAccount)


    transactions, err := client.Transaction.Gets(ctx, &swervpay.PageAndLimitQuery{
		Page:  1,
		Limit: 10,
	})

	if err != nil {
		panic(err)
	}

	for _, transaction := range *transactions {
		fmt.Printf("%v\n", transaction)
	}

	transaction, err := client.Transaction.Get(ctx, "txn_123456")

	if err != nil {
		panic(err)
	}

	fmt.Printf("%v\n", transaction)
}
```

See more [examples](https://github.com/Swerv-Ltd/swervpay-go/tree/main/_examples)


# Introduction
Source: https://docs.swervpay.co/sdks/introduction

Official SDks for Swervpay

## Official SDKs

<CardGroup>
  <Card
    title="NodeJs"
    icon={
<svg xmlns="http://www.w3.org/2000/svg" width="35" height="21.47" viewBox="0 0 512 314"><defs><linearGradient id="logosNodejs0" x1="68.188%" x2="27.823%" y1="17.487%" y2="89.755%"><stop offset="0%" stopColor="#41873F"/><stop offset="32.88%" stopColor="#418B3D"/><stop offset="63.52%" stopColor="#419637"/><stop offset="93.19%" stopColor="#3FA92D"/><stop offset="100%" stopColor="#3FAE2A"/></linearGradient><linearGradient id="logosNodejs1" x1="43.277%" x2="159.245%" y1="55.169%" y2="-18.306%"><stop offset="13.76%" stopColor="#41873F"/><stop offset="40.32%" stopColor="#54A044"/><stop offset="71.36%" stopColor="#66B848"/><stop offset="90.81%" stopColor="#6CC04A"/></linearGradient><linearGradient id="logosNodejs2" x1="-4413.77%" x2="5327.93%" y1="13.43%" y2="13.43%"><stop offset="9.192%" stopColor="#6CC04A"/><stop offset="28.64%" stopColor="#66B848"/><stop offset="59.68%" stopColor="#54A044"/><stop offset="86.24%" stopColor="#41873F"/></linearGradient><linearGradient id="logosNodejs3" x1="-4.389%" x2="101.499%" y1="49.997%" y2="49.997%"><stop offset="9.192%" stopColor="#6CC04A"/><stop offset="28.64%" stopColor="#66B848"/><stop offset="59.68%" stopColor="#54A044"/><stop offset="86.24%" stopColor="#41873F"/></linearGradient><linearGradient id="logosNodejs4" x1="-9713.77%" x2="27.93%" y1="36.21%" y2="36.21%"><stop offset="9.192%" stopColor="#6CC04A"/><stop offset="28.64%" stopColor="#66B848"/><stop offset="59.68%" stopColor="#54A044"/><stop offset="86.24%" stopColor="#41873F"/></linearGradient><linearGradient id="logosNodejs5" x1="-103.861%" x2="100.797%" y1="50.275%" y2="50.275%"><stop offset="9.192%" stopColor="#6CC04A"/><stop offset="28.64%" stopColor="#66B848"/><stop offset="59.68%" stopColor="#54A044"/><stop offset="86.24%" stopColor="#41873F"/></linearGradient><linearGradient id="logosNodejs6" x1="130.613%" x2="4.393%" y1="-211.069%" y2="201.605%"><stop offset="0%" stopColor="#41873F"/><stop offset="32.88%" stopColor="#418B3D"/><stop offset="63.52%" stopColor="#419637"/><stop offset="93.19%" stopColor="#3FA92D"/><stop offset="100%" stopColor="#3FAE2A"/></linearGradient><path id="logosNodejs7" d="M57.903 1.85a5.957 5.957 0 0 0-5.894 0L3.352 29.933c-1.85 1.04-2.89 3.005-2.89 5.085v56.286c0 2.08 1.156 4.045 2.89 5.085l48.657 28.085a5.957 5.957 0 0 0 5.894 0l48.658-28.085c1.849-1.04 2.89-3.005 2.89-5.085V35.019c0-2.08-1.157-4.045-2.89-5.085L57.903 1.85Z"/></defs><g fill="none"><path fill="#539E43" d="M253.11 313.094c-1.733 0-3.351-.462-4.854-1.271l-15.371-9.13c-2.312-1.272-1.156-1.734-.462-1.965c3.12-1.04 3.698-1.272 6.934-3.12c.347-.232.81-.116 1.156.115l11.789 7.05c.462.231 1.04.231 1.386 0l46.115-26.698c.462-.231.694-.694.694-1.271v-53.28c0-.579-.232-1.04-.694-1.272l-46.115-26.582c-.462-.232-1.04-.232-1.386 0l-46.115 26.582c-.462.231-.694.809-.694 1.271v53.28c0 .463.232 1.04.694 1.272l12.598 7.281c6.819 3.467 11.095-.578 11.095-4.623v-52.587c0-.693.578-1.387 1.387-1.387h5.894c.694 0 1.387.578 1.387 1.387v52.587c0 9.13-4.97 14.447-13.638 14.447c-2.658 0-4.738 0-10.633-2.89l-12.135-6.934c-3.005-1.733-4.854-4.97-4.854-8.437v-53.28c0-3.467 1.849-6.704 4.854-8.437l46.114-26.698c2.89-1.618 6.82-1.618 9.709 0l46.114 26.698c3.005 1.733 4.855 4.97 4.855 8.437v53.28c0 3.467-1.85 6.704-4.855 8.437l-46.114 26.698c-1.503.694-3.236 1.04-4.854 1.04Zm14.216-36.637c-20.225 0-24.386-9.246-24.386-17.105c0-.694.578-1.387 1.387-1.387h6.01c.693 0 1.271.462 1.271 1.156c.925 6.125 3.583 9.13 15.834 9.13c9.708 0 13.87-2.196 13.87-7.397c0-3.005-1.157-5.2-16.297-6.703c-12.598-1.272-20.457-4.045-20.457-14.1c0-9.362 7.86-14.91 21.035-14.91c14.793 0 22.075 5.086 23 16.18c0 .348-.116.694-.347 1.041c-.232.231-.578.462-.925.462h-6.01c-.578 0-1.156-.462-1.271-1.04c-1.387-6.356-4.97-8.437-14.447-8.437c-10.633 0-11.905 3.699-11.905 6.472c0 3.352 1.503 4.392 15.834 6.241c14.216 1.85 20.92 4.508 20.92 14.447c-.116 10.171-8.437 15.95-23.116 15.95Z"/><path fill="#333" d="M110.028 104.712c0-2.08-1.156-4.046-3.005-5.086l-49.004-28.2c-.81-.463-1.734-.694-2.658-.81h-.463c-.924 0-1.849.347-2.658.81l-49.004 28.2c-1.85 1.04-3.005 3.005-3.005 5.086l.116 75.817c0 1.04.578 2.08 1.502 2.543c.925.578 2.08.578 2.89 0l29.125-16.643c1.849-1.04 3.005-3.005 3.005-5.085v-35.482c0-2.08 1.155-4.045 3.005-5.085l12.366-7.166c.925-.578 1.965-.81 3.005-.81c1.04 0 2.08.232 2.89.81l12.366 7.166c1.85 1.04 3.005 3.004 3.005 5.085v35.482c0 2.08 1.156 4.045 3.005 5.085l29.125 16.643a2.82 2.82 0 0 0 3.005 0c.925-.463 1.503-1.503 1.503-2.543l-.116-75.817ZM345.571.347c-.924-.463-2.08-.463-2.89 0c-.924.578-1.502 1.502-1.502 2.542v75.125c0 .693-.346 1.386-1.04 1.849c-.693.346-1.387.346-2.08 0l-12.251-7.05a5.957 5.957 0 0 0-5.895 0l-49.004 28.316c-1.849 1.04-3.005 3.005-3.005 5.085v56.516c0 2.08 1.156 4.046 3.005 5.086l49.004 28.316a5.957 5.957 0 0 0 5.895 0l49.004-28.316c1.849-1.04 3.005-3.005 3.005-5.086V21.844c0-2.196-1.156-4.16-3.005-5.201L345.572.347Zm-4.507 143.776c0 .578-.231 1.04-.694 1.271l-16.758 9.708a1.714 1.714 0 0 1-1.503 0l-16.758-9.708c-.463-.231-.694-.809-.694-1.271v-19.417c0-.578.231-1.04.694-1.271l16.758-9.709a1.714 1.714 0 0 1 1.503 0l16.758 9.709c.463.23.694.809.694 1.271v19.417Zm167.584-19.879c1.85-1.04 2.89-3.005 2.89-5.086v-13.753c0-2.08-1.156-4.045-2.89-5.085l-48.657-28.2a5.957 5.957 0 0 0-5.895 0l-49.004 28.315c-1.85 1.04-3.005 3.005-3.005 5.085v56.517c0 2.08 1.156 4.045 3.005 5.085l48.657 27.738c1.85 1.04 4.046 1.04 5.78 0L489 178.45c.925-.463 1.503-1.503 1.503-2.543c0-1.04-.578-2.08-1.503-2.543l-49.235-28.316c-.925-.578-1.503-1.502-1.503-2.542v-17.683c0-1.04.578-2.08 1.503-2.543l15.371-8.784a2.821 2.821 0 0 1 3.005 0l15.372 8.784c.925.578 1.502 1.502 1.502 2.543v13.869c0 1.04.578 2.08 1.503 2.542a2.82 2.82 0 0 0 3.005 0l29.125-16.99Z"/><path fill="#539E43" d="M456.292 121.585a1.05 1.05 0 0 1 1.156 0l9.362 5.432c.346.232.577.578.577 1.04v10.865c0 .462-.23.809-.577 1.04l-9.362 5.432a1.05 1.05 0 0 1-1.156 0l-9.361-5.432c-.347-.231-.578-.578-.578-1.04v-10.864c0-.463.23-.81.578-1.04l9.361-5.433Z"/><g transform="translate(134.068 70.501)"><mask id="logosNodejs8" fill="#fff"><use href="#logosNodejs7"/></mask><use fill="url(#logosNodejs0)" href="#logosNodejs7"/><g mask="url(#logosNodejs8)"><path d="M51.893 1.85L3.121 29.933C1.27 30.974 0 32.94 0 35.02v56.286c0 1.387.578 2.658 1.502 3.698L56.285 1.156c-1.387-.231-3.005-.116-4.392.693Zm4.739 123.203c.462-.116.925-.347 1.387-.578l48.773-28.085c1.85-1.04 3.005-3.005 3.005-5.085V35.019c0-1.502-.694-3.005-1.734-4.045l-51.43 94.079Z"/><path fill="url(#logosNodejs1)" d="M106.676 29.934L57.788 1.85a8.025 8.025 0 0 0-1.503-.578L1.502 95.12a6.082 6.082 0 0 0 1.619 1.387l48.888 28.085c1.387.809 3.005 1.04 4.507.577l51.432-94.078c-.347-.462-.81-.81-1.272-1.156Z"/></g><g mask="url(#logosNodejs8)"><path d="M109.797 91.305V35.019c0-2.08-1.271-4.045-3.12-5.085L57.786 1.85a5.106 5.106 0 0 0-1.848-.693l53.511 91.42c.231-.347.347-.809.347-1.271ZM3.12 29.934C1.272 30.974 0 32.94 0 35.02v56.286c0 2.08 1.387 4.045 3.12 5.085l48.889 28.085c1.156.693 2.427.925 3.814.693L3.467 29.818l-.346.116Z"/><path fill="url(#logosNodejs2)" fillRule="evenodd" d="m50.391.809l-.693.347h.924l-.231-.347Z" transform="translate(0 -9.246)"/><path fill="url(#logosNodejs3)" fillRule="evenodd" d="M106.792 105.636c1.387-.809 2.427-2.196 2.89-3.698L56.053 10.402c-1.387-.231-2.89-.116-4.16.693L3.351 39.065l52.355 95.465a8.057 8.057 0 0 0 2.196-.693l48.889-28.2Z" transform="translate(0 -9.246)"/><path fill="url(#logosNodejs4)" fillRule="evenodd" d="m111.3 104.712l-.347-.578v.809l.346-.231Z" transform="translate(0 -9.246)"/><path fill="url(#logosNodejs5)" fillRule="evenodd" d="m106.792 105.636l-48.773 28.085a6.973 6.973 0 0 1-2.196.693l.925 1.734l54.089-31.32v-.694l-1.387-2.312c-.231 1.618-1.271 3.005-2.658 3.814Z" transform="translate(0 -9.246)"/><path fill="url(#logosNodejs6)" fillRule="evenodd" d="m106.792 105.636l-48.773 28.085a6.973 6.973 0 0 1-2.196.693l.925 1.734l54.089-31.32v-.694l-1.387-2.312c-.231 1.618-1.271 3.005-2.658 3.814Z" transform="translate(0 -9.246)"/></g></g></g></svg>
}
    href="/sdks/nodejs"
  >
    Official SDK for NodeJS.
  </Card>

  <Card
    title="Go"
    icon={
<svg xmlns="http://www.w3.org/2000/svg" width="35" height="13.13" viewBox="0 0 512 192"><path fill="#00ACD7" d="m292.533 13.295l1.124.75c13.212 8.725 22.685 20.691 28.917 35.15c1.496 2.243.499 3.49-2.493 4.237l-5.063 1.296c-11.447 2.949-20.53 5.429-31.827 8.378l-6.443 1.678c-2.32.574-2.96.333-5.428-2.477l-.348-.399c-3.519-3.988-6.155-6.652-10.817-9.03l-.899-.443c-15.705-7.727-30.911-5.484-45.12 3.74c-16.952 10.968-25.677 27.172-25.428 47.364c.25 19.942 13.96 36.395 33.654 39.137c16.951 2.244 31.16-3.739 42.378-16.452c2.244-2.743 4.238-5.734 6.73-9.224h-48.11c-5.235 0-6.481-3.24-4.736-7.478l.864-2.035c3.204-7.454 8.173-18.168 11.4-24.294l.704-1.319c.862-1.494 2.612-3.513 5.977-3.513h80.224c3.603-11.415 9.449-22.201 17.246-32.407c18.198-23.931 40.135-36.396 69.8-41.63c25.427-4.488 49.359-1.995 71.046 12.713c19.694 13.461 31.909 31.66 35.15 55.59c4.237 33.654-5.485 61.075-28.668 84.508c-16.453 16.702-36.645 27.172-59.829 31.908c-6.73 1.247-13.461 1.496-19.942 2.244c-22.685-.499-43.376-6.98-60.826-21.937c-12.273-10.61-20.727-23.648-24.928-38.828a104.937 104.937 0 0 1-10.47 16.89c-17.949 23.683-41.381 38.39-71.046 42.38c-24.43 3.24-47.115-1.497-67.058-16.454c-18.447-13.96-28.917-32.407-31.66-55.34c-3.24-27.173 4.737-51.603 21.19-73.041c17.7-23.184 41.132-37.891 69.8-43.126c22.999-4.16 45.037-1.595 64.936 11.464ZM411.12 49.017l-.798.178c-23.183 5.235-38.14 19.942-43.624 43.375c-4.488 19.444 4.985 39.138 22.934 47.115c13.71 5.983 27.421 5.235 40.633-1.496c19.694-10.22 30.413-26.175 31.66-47.613c-.25-3.24-.25-5.734-.749-8.227c-4.436-24.401-26.664-38.324-50.056-33.332ZM116.416 94.564c.997 0 1.496.748 1.496 1.745l-.499 5.983c0 .997-.997 1.745-1.745 1.745l-54.344-.249c-.997 0-1.246-.748-.748-1.496l3.49-6.232c.499-.748 1.496-1.496 2.493-1.496h49.857ZM121.9 71.63c.997 0 1.496.748 1.247 1.496l-1.995 5.983c-.249.997-1.246 1.495-2.243 1.495l-117.912.25c-.997 0-1.246-.499-.748-1.247l5.235-6.73c.499-.748 1.745-1.247 2.742-1.247H121.9Zm12.963-22.934c.997 0 1.246.748.748 1.496l-4.238 6.481c-.499.748-1.745 1.496-2.493 1.496l-90.24-.25c-.998 0-1.247-.498-.749-1.246l5.235-6.73c.499-.748 1.745-1.247 2.742-1.247h88.995Z"/></svg>
}
    href="/sdks/go"
  >
    Official SDK for GO.
  </Card>

  <Card
    title="PHP"
    icon={
<svg xmlns="http://www.w3.org/2000/svg" width="35" height="35" viewBox="0 0 128 128"><path fill="url(#deviconPhp0)" d="M0 64c0 18.593 28.654 33.667 64 33.667c35.346 0 64-15.074 64-33.667c0-18.593-28.655-33.667-64-33.667C28.654 30.333 0 45.407 0 64Z"/><path fill="#777bb3" d="M64 95.167c33.965 0 61.5-13.955 61.5-31.167c0-17.214-27.535-31.167-61.5-31.167S2.5 46.786 2.5 64c0 17.212 27.535 31.167 61.5 31.167Z"/><path d="M34.772 67.864c2.793 0 4.877-.515 6.196-1.53c1.306-1.006 2.207-2.747 2.68-5.175c.44-2.27.272-3.854-.5-4.71c-.788-.874-2.493-1.317-5.067-1.317h-4.464l-2.473 12.732zM20.173 83.547a.694.694 0 0 1-.68-.828l6.557-33.738a.695.695 0 0 1 .68-.561h14.134c4.442 0 7.748 1.206 9.827 3.585c2.088 2.39 2.734 5.734 1.917 9.935c-.333 1.711-.905 3.3-1.7 4.724a15.818 15.818 0 0 1-3.128 3.92c-1.531 1.432-3.264 2.472-5.147 3.083c-1.852.604-4.232.91-7.07.91h-5.724l-1.634 8.408a.695.695 0 0 1-.682.562z"/><path fill="#fff" d="M34.19 55.826h3.891c3.107 0 4.186.682 4.553 1.089c.607.674.723 2.097.331 4.112c-.439 2.257-1.253 3.858-2.42 4.756c-1.194.92-3.138 1.386-5.773 1.386h-2.786l2.205-11.342zm6.674-8.1H26.731a1.39 1.39 0 0 0-1.364 1.123L18.81 82.588a1.39 1.39 0 0 0 1.363 1.653h7.35a1.39 1.39 0 0 0 1.363-1.124l1.525-7.846h5.151c2.912 0 5.364-.318 7.287-.944c1.977-.642 3.796-1.731 5.406-3.237a16.522 16.522 0 0 0 3.259-4.087c.831-1.487 1.429-3.147 1.775-4.931c.86-4.423.161-7.964-2.076-10.524c-2.216-2.537-5.698-3.823-10.349-3.823zM30.301 68.557h4.471c2.963 0 5.17-.557 6.62-1.675c1.451-1.116 2.428-2.98 2.938-5.591c.485-2.508.264-4.277-.665-5.308c-.931-1.03-2.791-1.546-5.584-1.546h-5.036l-2.743 14.12m10.563-19.445c4.252 0 7.353 1.117 9.303 3.348c1.95 2.232 2.536 5.347 1.76 9.346c-.322 1.648-.863 3.154-1.625 4.518c-.764 1.366-1.76 2.614-2.991 3.747c-1.468 1.373-3.097 2.352-4.892 2.935c-1.794.584-4.08.875-6.857.875h-6.296l-1.743 8.97h-7.35l6.558-33.739h14.133"/><path d="M69.459 74.577a.694.694 0 0 1-.682-.827l2.9-14.928c.277-1.42.209-2.438-.19-2.87c-.245-.263-.979-.704-3.15-.704h-5.256l-3.646 18.768a.695.695 0 0 1-.683.56h-7.29a.695.695 0 0 1-.683-.826l6.558-33.739a.695.695 0 0 1 .682-.561h7.29a.695.695 0 0 1 .683.826L64.41 48.42h5.653c4.307 0 7.227.758 8.928 2.321c1.733 1.593 2.275 4.14 1.608 7.573l-3.051 15.702a.695.695 0 0 1-.682.56h-7.407z"/><path fill="#fff" d="M65.31 38.755h-7.291a1.39 1.39 0 0 0-1.364 1.124l-6.557 33.738a1.39 1.39 0 0 0 1.363 1.654h7.291a1.39 1.39 0 0 0 1.364-1.124l3.537-18.205h4.682c2.168 0 2.624.463 2.641.484c.132.14.305.795.019 2.264l-2.9 14.927a1.39 1.39 0 0 0 1.364 1.654h7.408a1.39 1.39 0 0 0 1.363-1.124l3.051-15.7c.715-3.686.103-6.45-1.82-8.217c-1.836-1.686-4.91-2.505-9.398-2.505h-4.81l1.421-7.315a1.39 1.39 0 0 0-1.364-1.655zm0 1.39l-1.743 8.968h6.496c4.087 0 6.907.714 8.457 2.14c1.553 1.426 2.017 3.735 1.398 6.93l-3.052 15.699h-7.407l2.901-14.928c.33-1.698.208-2.856-.365-3.474c-.573-.617-1.793-.926-3.658-.926h-5.829l-3.756 19.327H51.46l6.558-33.739h7.292z"/><path d="M92.136 67.864c2.793 0 4.878-.515 6.198-1.53c1.304-1.006 2.206-2.747 2.679-5.175c.44-2.27.273-3.854-.5-4.71c-.788-.874-2.493-1.317-5.067-1.317h-4.463l-2.475 12.732zM77.54 83.547a.694.694 0 0 1-.682-.828l6.557-33.738a.695.695 0 0 1 .682-.561H98.23c4.442 0 7.748 1.206 9.826 3.585c2.089 2.39 2.734 5.734 1.917 9.935a15.878 15.878 0 0 1-1.699 4.724a15.838 15.838 0 0 1-3.128 3.92c-1.53 1.432-3.265 2.472-5.147 3.083c-1.852.604-4.232.91-7.071.91h-5.723l-1.633 8.408a.695.695 0 0 1-.683.562z"/><path fill="#fff" d="M91.555 55.826h3.891c3.107 0 4.186.682 4.552 1.089c.61.674.724 2.097.333 4.112c-.44 2.257-1.254 3.858-2.421 4.756c-1.195.92-3.139 1.386-5.773 1.386h-2.786l2.204-11.342zm6.674-8.1H84.096a1.39 1.39 0 0 0-1.363 1.123l-6.558 33.739a1.39 1.39 0 0 0 1.364 1.653h7.35a1.39 1.39 0 0 0 1.363-1.124l1.525-7.846h5.15c2.911 0 5.364-.318 7.286-.944c1.978-.642 3.797-1.731 5.408-3.238a16.52 16.52 0 0 0 3.258-4.086c.832-1.487 1.428-3.147 1.775-4.931c.86-4.423.162-7.964-2.076-10.524c-2.216-2.537-5.697-3.823-10.35-3.823zM87.666 68.557h4.47c2.964 0 5.17-.557 6.622-1.675c1.45-1.116 2.428-2.98 2.936-5.591c.487-2.508.266-4.277-.665-5.308c-.93-1.03-2.791-1.546-5.583-1.546h-5.035Zm10.563-19.445c4.251 0 7.354 1.117 9.303 3.348c1.95 2.232 2.537 5.347 1.759 9.346c-.32 1.648-.862 3.154-1.624 4.518c-.763 1.366-1.76 2.614-2.992 3.747c-1.467 1.373-3.097 2.352-4.892 2.935c-1.793.584-4.078.875-6.856.875h-6.295l-1.745 8.97h-7.35l6.558-33.739h14.133"/><defs><radialGradient id="deviconPhp0" cx="0" cy="0" r="1" gradientTransform="translate(38.426 42.169) scale(84.04136)" gradientUnits="userSpaceOnUse"><stop stopColor="#AEB2D5"/><stop offset=".3" stopColor="#AEB2D5"/><stop offset=".75" stopColor="#484C89"/><stop offset="1" stopColor="#484C89"/></radialGradient></defs></svg>
}
    href="/sdks/php"
  >
    Official SDK for PHP.
  </Card>

  <Card title="Laravel" icon="laravel" href="/sdks/laravel">
    Official SDK for Laravel.
  </Card>

  <Card
    title="Flutter/Dart"
    icon={
<svg viewBox="-30.5 0 317 317" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" preserveAspectRatio="xMidYMid" fill="#000000"><g id="SVGRepo_bgCarrier" stroke-width="0"></g><g id="SVGRepo_tracerCarrier" stroke-linecap="round" stroke-linejoin="round"></g><g id="SVGRepo_iconCarrier"> <defs> <linearGradient x1="3.9517088%" y1="26.9930287%" x2="75.8970734%" y2="52.9192657%" id="linearGradient-1"> <stop stop-color="#000000" offset="0%"> </stop> <stop stop-color="#000000" stop-opacity="0" offset="100%"> </stop> </linearGradient> </defs> <g> <polygon fill="#47C5FB" points="157.665785 0.000549356223 0.000549356223 157.665785 48.8009614 206.466197 255.267708 0.000549356223"> </polygon> <polygon fill="#47C5FB" points="156.567183 145.396793 72.1487107 229.815265 121.132608 279.530905 169.842925 230.820587 255.267818 145.396793"> </polygon> <polygon fill="#00569E" points="121.133047 279.531124 158.214592 316.61267 255.267159 316.61267 169.842266 230.820807"> </polygon> <polygon fill="#00B5F8" points="71.5995742 230.364072 120.401085 181.562561 169.842046 230.821136 121.132827 279.531454"> </polygon> <polygon fill-opacity="0.8" fill="url(#linearGradient-1)" points="121.132827 279.531454 161.692896 266.072227 165.721875 234.941308"> </polygon> </g> </g></svg>
}
    href="/sdks/dart"
  >
    Official SDK for Dart/Flutter.
  </Card>
</CardGroup>


# Laravel
Source: https://docs.swervpay.co/sdks/laravel

Laravel Client for Swervpay

### Installation

Install [swervpay-laravel](https://packagist.org/packages/swervpaydev/laravel) sdk into your new or existing Laravel application using composer.

```bash Shell theme={null}
$ composer require swervpaydev/laravel
```

### Configuration

You can publish the configuration file using this command:

```bash Shell theme={null}
$ php artisan vendor:publish --tag="swervpaydev-laravel-config"
```

Set `SWERVPAYDEV_SECRET_KEY` & `SWERVPAYDEV_BUSINESS_ID` value in your environmental variable file

### Usage

```php Laravel theme={null}
use Swervpaydev\SDK\Swervpay;
```


# NodeJS
Source: https://docs.swervpay.co/sdks/nodejs

NodeJS Client for Swervpay

### Installation

Install [swervpay-node](https://www.npmjs.com/package/@swervpaydev/sdk) sdk into your new or existing NodeJS application using any of your favorite package manager.

```bash Shell theme={null}
$ npm install @swervpaydev/sdk
$ yarn add @swervpaydev/sdk
$ pnpm add @swervpaydev/sdk
$ bun install @swervpaydev/sdk
```

### Usage

Create swervpay instance with your Business ID and secret.

```javascript NodeJS theme={null}
import { SwervpayClient } from "@swervpaydev/sdk";

const swervpay = new SwervpayClient({
  businessId: process.env.SWERVPAY_API_KEY!,
  secretKey: process.env.SWERVPAY_API_SECRET!,
  logLevel: "debug",
});
```

### Create a Payout

Create a new payout

```javascript NodeJS theme={null}
const payout = await swervpay.payout.create({
    amount: req.body.amount,
    currency: req.body.currency,
    bank_code: req.body.bank_code,
    account_number: req.body.account_number,
    naration: req.body.narration,
    email: req.body.email,
    reference: req.body.reference,
});
```

### Get payout

Get a payout

```javascript NodeJS theme={null}
const payout = await swervpay.payout.get(req.param.id);
```

### Get transactions

Retrieve all transactions

```javascript NodeJS theme={null}
const transactions = await swervpay.transaction.gets({
    limit: parseInt(req.query.limit as string),
    page: parseInt(req.query.page as string),
});
```

### Get transaction

Get a transaction

```javascript NodeJS theme={null}
const transaction = await swervpay.transaction.get(req.param.id);
```

### Create a customer

Create a new customer

```javascript NodeJS theme={null}
const customer = await swervpay.customer.create({
    firstname: req.body.first_name,
    lastname: req.body.last_name,
    email: req.body.email,
    middlename: "",
    country: req.body.country,
});
```

### Update a customer

Update a customer

```javascript NodeJS theme={null}
 const customer = await swervpay.customer.update(req.params.id, {
    email: req.body.email,
    phone_number: req.body.phone_number,
});
```

### Complete customer KYC

Create/Update customer KYC

```javascript NodeJS theme={null}
 const customer = await swervpay.customer.kyc(req.params.id, {
    tier: req.body.tier as "ONE" | "TWO" | "FULL",
    document: {
        document_type: req.body.document_type,
        document: req.body.document,
        passport: req.body.passport,
        document_number: req.body.document_number,
    },
    information: {
        address: req.body.address,
        city: req.body.city,
        bvn: req.body.bvn,
        state: req.body.state,
        country: req.body.country,
        postal_code: req.body.postal_code,
    },
});
```

### Get customers

Retrieve all customers

```javascript NodeJS theme={null}
const customers = await swervpay.customer.gets({
    limit: parseInt(req.query.limit as string),
    page: parseInt(req.query.page as string),
});
```

### Get customer

Get a customer

```javascript NodeJS theme={null}
const customer = await swervpay.customer.get(req.param.id);
```

### Create a card

Create a new card

```javascript NodeJS theme={null}
const card = await swervpay.card.create({
    amount: req.body.amount,
    currency: req.body.currency,
    customer_id: req.body.customer_id,
    type: req.body.type as "LITE" | "DEFAULT" | "COOPERATE",
    issuer: req.body.issuer as "MASTERCARD" | "VISA",
    name_on_card: req.body.name_on_card,
});
```

### Get cards

Retrieve all cards

```javascript NodeJS theme={null}
const cards = await swervpay.card.gets({
    limit: parseInt(req.query.limit as string),
    page: parseInt(req.query.page as string),
});
```

### Get card

Get a card

```javascript NodeJS theme={null}
const card = await swervpay.card.get(req.param.id);
```

### Webhook test

Send a test webhook

```javascript NodeJS theme={null}
await swervpay.webhook.test(req.params.id);
```

### Webhook retry

Retry a webhook log

```javascript NodeJS theme={null}
await swervpay.webhook.retry(req.params.id);
```

### Get banks

Retrieve all banks

```javascript NodeJS theme={null}
const banks = await swervpay.other.banks();
```

### Resolve account number

Resolve an account number

```javascript NodeJS theme={null}
const result = await swervpay.other.resolve_account_number({
    bank_code: req.body.bank_code as string,
    account_number: req.body.account_number as string,
});
```

### FX rate

Get the current exchange rate

```javascript NodeJS theme={null}
const result = await swervpay.fx.rate({
    from: req.body.bank_code as string,
    to: req.body.account_number as string,
    amount: req.body.amount as number,
});
```

### FX Exchnage

Create a swap transaction

```javascript NodeJS theme={null}
const result = await swervpay.fx.rate({
    from: req.body.bank_code as string,
    to: req.body.account_number as string,
    amount: req.body.amount as number,
});
```

### Get wallet

Get a wallet

```javascript NodeJS theme={null}
const wallet = await swervpay.wallet.get(req.params.id);
```

### Get wallets

Retrieve all wallets

```javascript NodeJS theme={null}
 const wallets = await swervpay.wallet.gets({
    limit: parseInt(req.query.limit as string),
    page: parseInt(req.query.page as string),
});
```

See more [examples](https://github.com/Swerv-Ltd/swervpay-node/tree/main/examples)


# PHP
Source: https://docs.swervpay.co/sdks/php

PHP Client for Swervpay

### Installation

Install [swervpay-php](https://packagist.org/packages/swervpaydev/sdk) sdk into your new or existing PHP application using composer.

```bash Shell theme={null}
$ composer require swervpaydev/sdk
```

### Usage

```php PHP theme={null}
use Swervpaydev\SDK\Swervpay;
```


# Overview
Source: https://docs.swervpay.co/transaction/introduction

The Transaction API facilitates the retrieval, and management of financial transaction records.

### 🔍 Get All Transactions

'Retrieve a list of all transactions processed through Swervpay using the [get](/api-reference/transactions/get-all-transactions) all transaction endpoint which includes details such as transaction amount, status, and associated customer.

**Query Parameters**

<ParamField type="string">
  The page to return.
</ParamField>

<ParamField type="string">
  The maximum number of results to return.
</ParamField>

**Response Example**

Returns an array of transaction objects, each containing details about individual transactions processed through the platform.

```json Response theme={null}
[
  {
    "account_name": "Jane Doe",
    "account_number": "1234567890",
    "amount": 5000,
    "bank_code": "string",
    "bank_name": "Bank name",
    "category": "transfer",
    "charges": 50,
    "created_at": "2024-01-01T12:00:00Z",
    "detail": "Payment for services",
    "fiat_rate": 1.0,
    "id": "trans_789",
    "reference": "ref_101112",
    "report": false,
    "report_message": "",
    "session_id": "session_213",
    "status": "completed",
    "type": "debit",
    "updated_at": "2024-01-02T12:00:00Z",
  }
]
```

### 🔍 Get Transactions

Retrieve details of a specific transaction using its unique ID with the [get](/api-reference/transactions/get) transaction endpoint.

**Path Parameters**

<ParamField type="string">
  The unique identifier of the transaction to retrieve.
</ParamField>

**Response Example**

Retunrs a transaction object containing details about the transaction

```json Response theme={null}
  {
    "account_name": "Jane Doe",
    "account_number": "1234567890",
    "amount": 5000,
    "bank_code": "string",
    "bank_name": "Bank name",
    "category": "transfer",
    "charges": 50,
    "created_at": "2024-01-01T12:00:00Z",
    "customer_id": "cust_456",
    "detail": "Payment for services",
    "fiat_rate": 1.0,
    "id": "trans_789",
    "reference": "ref_101112",
    "report": false,
    "report_message": "",
    "session_id": "session_213",
    "status": "completed",
    "type": "debit",
    "updated_at": "2024-01-02T12:00:00Z",
  }
```


# Overview
Source: https://docs.swervpay.co/wallet/introduction

Retrieve a list of all wallets associated with an account. 

This API allows businesses to view wallet balances and transaction histories.

### 🔍 Get All wallets

Retrieve a list of all wallets by sending a request to the [get all](/api-reference/wallets/get-all-wallets) wallets endpoint. This enables businesses to monitor wallet statuses and balances in real-time.

**Query Parameters**

<ParamField type="string">
  The page to return.
</ParamField>

<ParamField type="string">
  The maximum number of results to return.
</ParamField>

**Response Example**

The response provides an array of wallet objects, each containing comprehensive details about the wallets associated with your Swervpay account.

```json Response theme={null}
[
  {
    "account_name": "string",
    "account_number": "string",
    "account_type": "string",
    "balance": 100000, // Balance in the smallest currency unit
    "bank_address": "string",
    "bank_code": "string",
    "bank_name": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "id": "wlt_123456789",
    "is_blocked": false,
    "pending_balance": 50000, // Pending balance in the smallest currency unit
    "reference": "string",
    "routing_number": "string",
    "total_received": 1500000, // Total amount received in the smallest currency unit
    "updated_at": "2024-01-02T00:00:00Z"
  }
  // ...other wallets
]
```


# Card
Source: https://docs.swervpay.co/webhooks/card

Overview of Card Webhook Events

## Overview

Our card webhook events are fired based on the following triggers:

* Created webhook event

* Terminated webhook event

* Freeze webhook event

* Unfreeze webhook event

* Updated webhook event

* Transaction webhook event

* Charges webhook event

* Contactless activation webhook event

## Created webhook event

This event is fired when a card is created.

```json card.created theme={null}
{
  "event": "card.created",
  "data": {
    "id": "card_123456789",
    "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
    "status": "STATUS",
    "created_at": "2024-02-06T02:49:18Z",
    "updated_at": "2024-02-06T02:49:18Z"
  }
}
```

## Terminated webhook event

This event is fired when a card is terminated.

```json card.terminated theme={null}
{
  "event": "card.terminated",
  "data": {
    "id": "card_123456789",
    "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
    "status": "STATUS",
    "created_at": "2024-02-06T02:49:18Z",
    "updated_at": "2024-02-06T02:49:18Z"
  }
}
```

## Freeze webhook event

This event is fired when a card is freezed.

```json card.freezed theme={null}
{
  "event": "card.freezed",
  "data": {
    "id": "card_123456789",
    "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
    "balance": 1000,
    "status": "STATUS",
    "created_at": "2024-02-06T02:49:18Z",
    "updated_at": "2024-02-06T02:49:18Z"
  }
}
```

## Unfreeze webhook event

This event is fired when a card is unfreezed.

```json card.unfreezed theme={null}
{
  "event": "card.unfreezed",
  "data": {
    "id": "card_123456789",
    "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
    "balance": 1000,
    "status": "STATUS",
    "created_at": "2024-02-06T02:49:18Z",
    "updated_at": "2024-02-06T02:49:18Z"
  }
}
```

## Updated webhook event

This event is fired when a card is funded.

```json card.updated theme={null}
{
  "event": "card.updated",
  "data": {
    "id": "card_123456789",
    "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
    "balance": 1000,
    "status": "ACTIVE",
    "created_at": "2024-02-06T02:49:18Z",
    "updated_at": "2024-02-06T02:49:18Z"
  }
}
```

## Transaction webhook event

This event is fired when a card transaction is made.

### Transaction Categories

* FUNDING
* WITHDRAW
* Transaction

### Transaction Types

* DEBIT
* CREDIT

### Transaction Status

* APPROVED
* DECLINED
* COMPLETED
* FAILED
* REVERSE

```json card.transaction theme={null}
{
  "event": "card.transaction",
  "data": {
    "id": "card_123456789",
    "card_id": "card_123456789",
    "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
    "reference": "ref_mviuNSMKi74vTY8yvfP6nQ",
    "amount": 1000,
    "charges": 1000,
    "status": "APPROVED",
    "type": "DEBIT",
    "merchant_name": "Google Inc",
    "merchant_city": "",
    "merchant_country": "",
    "merchant_postal_code": "",
    "merchant_state": "",
    "merchant_mcc": "",
    "merchant_mid": "",
    "currency": "USD",
    "category": "FUNDING",
    "created_at": "2024-02-06T02:49:18Z",
    "updated_at": "2024-02-06T02:49:18Z"
  }
}
```

## Charges webhook event

The `card.charges` event is fired when a card-related fee is debited from the business USD wallet. It is not emitted when the fee is successfully taken directly from the card.

Use `charge_type` to identify the fee:

* `CARD_DECLINE_FEE`: a declined-card fee that could not be collected from the card.
* `CROSS_BORDER_FEE`: a pending cross-border fee passed to the business wallet.

`funding_source` is `BUSINESS_WALLET` for this event.

```json card.charges theme={null}
{
  "event": "card.charges",
  "id": "evt_123456789",
  "data": {
    "id": "txn_123456789",
    "reference": "ref_mviuNSMKi74vTY8yvfP6nQ",
    "amount": 0.3,
    "charges": 0,
    "fiat_rate": 0,
    "detail": "Card transaction charges",
    "category": "CARD",
    "type": "DEBIT",
    "status": "COMPLETED",
    "created_at": "2026-07-20T15:30:00Z",
    "updated_at": "2026-07-20T15:30:00Z",
    "card": {
      "id": "card_123456789",
      "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
      "status": "ACTIVE",
      "balance": 10,
      "created_at": "2026-07-01T09:00:00Z",
      "updated_at": "2026-07-20T15:30:00Z"
    },
    "charge_type": "CARD_DECLINE_FEE",
    "funding_source": "BUSINESS_WALLET"
  }
}
```

## Contactless activation webhook event

The `card.contactless.activation` event contains the one-time code needed to add a contactless card to a supported wallet. This confidential event is delivered only after the business [explicitly subscribes an eligible webhook](/webhooks/introduction#contactless-activation-subscriptions).

```json card.contactless.activation theme={null}
{
  "event": "card.contactless.activation",
  "id": "3ca42ad1-1eb9-4ee7-828b-e00fbd2234c0",
  "data": {
    "customer_id": "cus_123456789",
    "email": "customer@example.com",
    "activation_code": "328893"
  }
}
```

Swervpay includes these headers:

| Header              | Description                                |
| ------------------- | ------------------------------------------ |
| `X-SWERV-Event`     | `card.contactless.activation`              |
| `X-SWERV-Event-Id`  | Stable identifier for the activation event |
| `X-SWERV-Timestamp` | Unix timestamp used to sign the request    |
| `X-SWERV-Signature` | `t=<timestamp>,v1=<hex HMAC-SHA256>`       |

Verify the signature against the raw request body using the webhook signing key returned when the webhook was created. The signed message is:

```text theme={null}
<timestamp>.<raw-request-body>
```

```js NodeJS theme={null}
import crypto from "node:crypto";

function verifyContactlessActivation(rawBody, headers, signingKey) {
  const timestamp = headers["x-swerv-timestamp"];
  const supplied = headers["x-swerv-signature"];
  const message = `${timestamp}.${rawBody}`;
  const digest = crypto
    .createHmac("sha256", signingKey)
    .update(message)
    .digest("hex");
  const expected = `t=${timestamp},v1=${digest}`;

  const expectedBuffer = Buffer.from(expected);
  const suppliedBuffer = Buffer.from(supplied || "");
  return expectedBuffer.length === suppliedBuffer.length &&
    crypto.timingSafeEqual(expectedBuffer, suppliedBuffer);
}
```

Validate that the timestamp is recent, verify the signature before parsing the body, store the event ID for idempotency, and return `2xx` promptly. Swervpay attempts confidential delivery up to three times. Activation payloads are redacted from webhook logs and cannot be manually retried through the webhook retry endpoint.


# Collection
Source: https://docs.swervpay.co/webhooks/collection

Overview of Collection Webhook Events

## Overview

Our collection webhook events are fired based on the following triggers:

* Completed webhook event
* Collection created event
* Collection created failed event

For USD collection accounts, `collection.created` confirms that the customer's USD account has been issued and contains the final account details. `collection.created.failed` is sent when the account request is rejected or cannot be completed.

## Completed webhook event

```json collection.completed theme={null}
{
  "event": "collection.completed",
  "data": {
    "id": "txn_zRo4J1WQU6bvvh2umYwA",
    "reference": "ref_zWkNkNFhbK3igZ8bDtEu",
    "business_id": "bsn_fAYcWSUXz3TogChv7BgH",
    "status": "COMPLETED",
    "amount": 500000,
    "charges": 1000,
    "type": "CREDIT",
    "detail": "Fund wallet",
    "created_at": "2024-03-13T21:00:28Z",
    "updated_at": "2024-03-13T21:00:28Z"
  }
}
```

## Collection created event

```json collection.created theme={null}
{
  "event": "collection.created",
  "data": {
    "wallet_id": "string",
    "business_id": "string",
    "account_number": "string",
    "bank_code": "string",
    "bank_name": "string",
    "account_name": "string",
    "routing_number": "string",
    "account_type": "string",
    "bank_address": "string",
  }
}
```

## Collection created failed event

```json collection.created.failed theme={null}
{
  "event": "collection.created.failed",
  "data": {
    "collection": {
      "wallet_id": "string",
      "business_id": "string",
      "account_number": "string",
      "bank_code": "string",
      "bank_name": "string",
      "account_name": "string",
      "routing_number": "string",
      "account_type": "string",
      "bank_address": "string",
    },
    "reasons": [
      {
        "reason": "Invalid tax number"
      }
    ]
  }
}
```


# Customer
Source: https://docs.swervpay.co/webhooks/customer

Overview of Customer Webhook Events

## Overview

Our customer webhook events are fired based on the following triggers:

* Created webhook event

* Updated webhook event

* KYC webhook event

## Created webhook event

This event is fired when a customer is created.

```json customer.created theme={null}
{
  "event": "customer.created",
  "data": {
      "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
      "id": "cus_BJ8ptMSAcm3n6qp6bFpc"
  }
}
```

## Updated webhook event

This event is fired when a customer is updated.

```json customer.updated theme={null}
{
  "event": "customer.updated",
  "data": {
      "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
      "id": "cus_BJ8ptMSAcm3n6qp6bFpc"
  }
}
```

## KYC webhook event

This event is fired when a customer's KYC status is updated.

```json customer.kyc.updated theme={null}
{
  "event": "customer.kyc.updated",
  "data": {
      "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
      "id": "cus_BJ8ptMSAcm3n6qp6bFpc",
      "tier": "ONE",
      "kyc_status": "APPROVED"
  }
}
```


# Introduction
Source: https://docs.swervpay.co/webhooks/introduction

Introduction to Webhooks

## Introduction

Webhooks are a way for Swervpay to provide real-time data to your application. They are HTTP callbacks that receive notification messages for events. When an event occurs, Swervpay sends an HTTP POST request to the webhook's configured URL. Your endpoint should respond with a `2xx` status code to indicate that the event has been successfully received.

## Creating a Webhook

You can create a webhook from the [dashboard](https://app.swervpay.co/-/developers/webhooks).

## Contactless activation subscriptions

Contactless activation codes are confidential and are not sent to a webhook by default. To receive them, explicitly subscribe one enabled HTTPS webhook to `card.contactless.activation`.

Create a subscribed webhook:

```bash theme={null}
curl --request POST \
  --url https://api.swervpay.co/api/v1/webhook \
  --header 'Authorization: Bearer <TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com/webhooks/swervpay",
    "description": "Contactless activation webhook",
    "events": ["card.contactless.activation"]
  }'
```

Or update an existing webhook:

```bash theme={null}
curl --request PUT \
  --url https://api.swervpay.co/api/v1/webhook/<WEBHOOK_ID> \
  --header 'Authorization: Bearer <TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com/webhooks/swervpay",
    "description": "Contactless activation webhook",
    "events": ["card.contactless.activation"]
  }'
```

The endpoint must:

* Use HTTPS.
* Return a `2xx` response.
* Be the only enabled webhook subscribed to `card.contactless.activation` for the business.

When no unique eligible subscription can be resolved, or delivery fails, Swervpay sends the activation code using the standard Swervpay email instead.

<Note>
  Supplying `events` when editing replaces the webhook's stored event list. Include every event that should remain explicitly registered. Omitting `events` preserves the existing list.
</Note>

## Authentication

All webhook requests include a `X-SWERV-SECRET` header for verification. It should match the secret generated when creating the webhook.

The confidential `card.contactless.activation` event uses an HMAC signature instead of `X-SWERV-SECRET`. See the [card webhook documentation](/webhooks/card#contactless-activation-webhook-event) for its headers and verification procedure.

<CodeGroup>
  ```js NodeJS theme={null}
  const secret = process.env.SWERVPAY_SECRET;

  function verifyWebhook(req, res, next) {
    if (req.headers['X-SWERV-SECRET'] !== secret) {
      return res.status(401).json({
        message: "Unauthorized request."
      });
    }
    next();
  }

  router.post('/webhook', verifyWebhook, (req, res) => {
    const webhook = req.body;
    switch(webhook.event) {
      case "card.created":
    
      break;
    }
    return res.sendStatus(200);
  });

  ```

  ```php PHP theme={null}
  $secret = getenv('SWERVPAY_SECRET');

  function verifyWebhook($secret) {
      $header = $_SERVER['HTTP_SWERVPAY_SECRET'];
      if ($header !== $secret) {
          http_response_code(401);
          echo 'Unauthorized request';
          exit();
      }
  }

  function handleWebhook() {
      $json = file_get_contents('php://input');
      $data = json_decode($json, true);

      if (json_last_error() !== JSON_ERROR_NONE) {
          http_response_code(400);
          echo 'Invalid JSON body';
          exit();
      }

      switch ($data['event']) {
          case 'card.created':
              // Handle the event
              break;
      }

      http_response_code(200);
  }

  verifyWebhook($secret);
  handleWebhook();
  ```

  ```php Laravel theme={null}
  // In your middleware
  namespace App\Http\Middleware;

  use Closure;
  use Illuminate\Http\Request;

  class VerifyWebhook
  {
      public function handle(Request $request, Closure $next)
      {
          $secret = env('SWERVPAY_SECRET');
          if ($request->header('X-SWERV-SECRET') !== $secret) {
              return response('Unauthorized request', 401);
          }

          return $next($request);
      }
  }

  // In your controller
  namespace App\Http\Controllers;

  use Illuminate\Http\Request;

  class WebhookController extends Controller
  {
      public function handle(Request $request)
      {
          $data = $request->json()->all();

          switch ($data['event']) {
              case 'card.created':
                  // Handle the event
                  break;
          }

          return response(null, 200);
      }
  }

  // In your routes/web.php or routes/api.php
  Route::post('/webhook', 'App\Http\Controllers\WebhookController@handle')->middleware('App\Http\Middleware\VerifyWebhook');
  ```

  ```go Go theme={null}
  package main

  import (
      "encoding/json"
      "net/http"
      "os"

      "github.com/gorilla/mux"
  )

  var secret = os.Getenv("SWERVPAY_SECRET")

  func verifyWebhook(next http.Handler) http.Handler {
      return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
          if r.Header.Get("X-SWERV-SECRET") != secret {
              http.Error(w, "Unauthorized request", http.StatusUnauthorized)
              return
          }
          next.ServeHTTP(w, r)
      })
  }

  type Webhook struct {
      Event string `json:"event"`
  }

  func handleWebhook(w http.ResponseWriter, r *http.Request) {
      var webhook Webhook
      err := json.NewDecoder(r.Body).Decode(&webhook)
      if err != nil {
          http.Error(w, err.Error(), http.StatusBadRequest)
          return
      }

      switch webhook.Event {
      case "card.created":
          // Handle the event
      }

      w.WriteHeader(http.StatusOK)
  }

  func main() {
      r := mux.NewRouter()
      r.Use(verifyWebhook)
      r.HandleFunc("/webhook", handleWebhook).Methods("POST")
      http.ListenAndServe(":8080", r)
  }
  ```
</CodeGroup>

## Retry

If a webhook fails, you have two main options to retry the failed delivery:

* Retry from developer section of the [dashboard](https://app.swervpay.co/-/developers/webhooks)

* Using [webhook Retry API](/api-reference/webhook/retry)


# Payout
Source: https://docs.swervpay.co/webhooks/payout

Overview of Payout Webhook Events

## Overview

Our payout webhook events are fired based on the following triggers:

* Completed webhook event

* Failed webhook event

## Completed webhook event

This event is fired when a payout is completed.

```json payout.completed theme={null}
{
  "event": "payout.completed",
  "data": {
    "id": "txn_LKkX3akrzdpJpfA2WGc5",
    "reference": "ref_ZwfWk6AfTb42GTibd4yG",
    "business_id": "bsn_fAYcWSUXz3TogChv7BgH",
    "status": "COMPLETED",
    "amount": 500000,
    "charges": 20,
    "type": "DEBIT",
    "detail": "God help us",
    "created_at": "2024-03-12T15:09:24Z",
    "updated_at": "2024-03-12T14:24:07Z"
  }
}
```

## Failed webhook event

This event is fired when a payout is failed.

```json payout.failed theme={null}
{
  "event": "payout.failed",
  "data": {
    "id": "txn_LKkX3akrzdpJpfA2WGc5",
    "reference": "ref_ZwfWk6AfTb42GTibd4yG",
    "business_id": "bsn_fAYcWSUXz3TogChv7BgH",
    "status": "FAILED",
    "amount": 500000,
    "charges": 20,
    "type": "DEBIT",
    "detail": "God help us",
    "created_at": "2024-03-12T15:09:24Z",
    "updated_at": "2024-03-12T14:24:07Z"
  }
}
```


# Wallet
Source: https://docs.swervpay.co/webhooks/wallet

Overview of Wallet Webhook Events

## Overview

Our wallet webhook events are fired based on the following triggers:

* Updated webhook event

## Updated webhook event

This event is fired when a wallet is updated.

```json wallet.updated theme={null}
{
  "event": "wallet.updated",
  "data": {
    "wallet_id": "wlt_Za3WgMTHsD5NSYMeqRJ7",
    "business_id": "bsn_fAYcWSUXz3TogChv7BgH",
    "type": "CREDIT",
    "amount": 11000,
    "balance": 402850
  }
}
```