Testing with Simulators

The simulators let you create test cards and transactions without using live banking networks. They are available only in the sandbox environment. You can simulate card transactions using your sandbox credentials as seen on your dashboard with these steps:

Fund your default account.
Create a funding source.
Create a cardholder.
Create a virtual or physical card.
Simulate your first card transaction.

1. Fund your default account.

To fund your default account, list your accounts and note the default account’s _id, accountNumber, and bankCode. In production, you can transfer funds to it. In sandbox, use the simulator.

curl --location --request GET 'https://api.sandbox.sudo.cards/accounts?page=0&limit=25' \
--header "Authorization: Bearer $SUDO_API_KEY" \

Then proceed to make funding using the sandbox simulator.

curl --location --request POST 'https://api.sandbox.sudo.cards/accounts/simulator/fund' \
--header "Authorization: Bearer $SUDO_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountId": "{{defaultAccountId}}",
    "amount": 5000.00
}'

2. Create a funding source.

Create a default funding source for the test cards. Card transactions using this funding source are charged to the customer’s card wallet.

curl --location --request POST 'https://api.sandbox.sudo.cards/fundingsources' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $SUDO_API_KEY" \
--data-raw '{
  "type": "default",
  "status": "active"
}'

3. Create a cardholder.

A cardholder is an individual or business that can be issued a payment card. This example includes the individual’s contact details, date of birth, and BVN identity required for card issuance.

curl --location --request POST 'https://api.sandbox.sudo.cards/customers' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $SUDO_API_KEY" \
--data-raw '{
  "type": "individual",
  "name": "John Doe",
  "phoneNumber": "+2348012345678",
  "emailAddress": "john.doe@example.com",
  "status": "active",
  "individual": {
    "firstName": "John",
    "lastName": "Doe",
    "dob": "1990-01-15",
    "identity": {
      "type": "BVN",
      "number": "22212345678"
    }
  },
  "billingAddress": {
    "line1": "4 Barnawa Close",
    "line2": "Off Challawa Crescent",
    "city": "Barnawa",
    "state": "Kaduna",
    "country": "NG",
    "postalCode": "800001"
  }
}'

4. Create a virtual or physical card.

Choose the flow for the type of card you want to create.

Virtual card

Create a virtual card directly through the Cards API. You do not need to generate a physical card number first.

curl --location --request POST 'https://api.sandbox.sudo.cards/cards' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $SUDO_API_KEY" \
--data-raw '{
  "customerId": "5f8b75ef12a06df84bd7aa3a",
  "fundingSourceId": "670cece725852ba485d745c7",
  "debitAccountId": "67974b365c184d20fc340889",
  "type": "virtual",
  "currency": "NGN",
  "status": "active"
}'

Physical card

To create or map a physical card, first generate a test card number:

curl --location --request GET 'https://api.sandbox.sudo.cards/cards/simulator/generate' \
--header "Authorization: Bearer $SUDO_API_KEY" \

Then use the generated number to create or map the physical card:

curl --location --request POST 'https://vault.sandbox.sudo.cards/cards' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $SUDO_API_KEY" \
--data-raw '{
	"customerId": "5f8b75ef12a06df84bd7aa3a",
	"type": "physical",
	"number": "5061000001743021565",
	"currency": "NGN",
	"status": "active"
}'

For more card options, see Creating Cards.

5. Make your first card transaction.

To make your first card transaction, proceed to simulate a transaction using the simulation endpoint.

You can also make a transaction at an ATM, POS terminal, or online using your card.

curl --location --request POST 'https://api.sandbox.sudo.cards/cards/simulator/authorization' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $SUDO_API_KEY" \
--data-raw '{
		"cardId": "5f90f250349360504cf82619",
    "channel": "web",
    "type": "purchase",
    "amount": 3500,
    "currency": "NGN",
    "merchant": {
        "category": "7399",
        "merchantId": "000000001",
        "name": "Acme Inc",
        "city": "Barnawa",
        "state": "KD",
        "country": "NG"
    }
}'

Overview

Getting Started

Cards

Controls

Purchases

Webhooks

Cloud Card

1. Fund your default account.

2. Create a funding source.

3. Create a cardholder.

4. Create a virtual or physical card.

Virtual card

Physical card

5. Make your first card transaction.

​1. Fund your default account.

​2. Create a funding source.

​3. Create a cardholder.

​4. Create a virtual or physical card.

​Virtual card

​Physical card

​5. Make your first card transaction.

1. Fund your default account.

2. Create a funding source.

3. Create a cardholder.

4. Create a virtual or physical card.

Virtual card

Physical card

5. Make your first card transaction.