Payment Methods APICopy Anchor Link

const paymentMethod = await afriex.paymentMethods.create({
  channel: "BANK_ACCOUNT",
  customerId: "customer-id",
  accountName: "John Doe",
  accountNumber: "1234567890",
  countryCode: "NG",
  institution: {
    institutionCode: "044",
    institutionName: "Access Bank",
  },
});

const paymentMethod = await afriex.paymentMethods.get("payment-method-id");

const response = await afriex.paymentMethods.list({
  page: 0,
  limit: 20,
  channel: ["BANK_ACCOUNT", "MOBILE_MONEY"],
  currencies: ["USD", "NGN"],
  status: ["active", "pending"],
});

await afriex.paymentMethods.delete("payment-method-id");

const response = await afriex.paymentMethods.getInstitutions({
  channel: "BANK_ACCOUNT",
  countryCode: "NG",
});

for (const institution of response.data) {
  console.log(institution.institutionName, institution.institutionCode);
}

// Returns: { data: Institution[], total, page }
// Institution: { institutionName, institutionCode, institutionAddress?, institutionBranch? }

const result = await afriex.paymentMethods.resolveInstitutionCode({
  searchTerm: "021000021",
  country: "US",
  codeType: "routing_number",
});

console.log(result.data?.bankName); // 'JPMORGAN CHASE BANK'

// Returns: { data: { bankName } }, with data null if the code does not resolve

const response = await afriex.paymentMethods.resolveAccount({
  channel: "BANK_ACCOUNT",
  accountNumber: "1234567890",
  institutionCode: "044",
  countryCode: "NG",
});

console.log(response.data.recipientName);

// Returns: { data: ResolvedAccount }
// ResolvedAccount: { recipientName?, institutionName?, institutionCode? }

const response = await afriex.paymentMethods.getCryptoWallet({
  asset: "USDT", // or 'USDC'
  customerId: "optional-customer-id",
});

for (const { network, address } of response.data.addresses) {
  console.log(network, address);
}

// Returns: { data: { id, addresses: [{ address, network }] } }
// One wallet, carrying an address per supported network
// (ETHEREUM_MAINNET, POLYGON_MAINNET, SOLANA_MAINNET, TRON_MAINNET).

const response = await afriex.paymentMethods.listVirtualAccounts({
  customerId: "customer-id",
  currency: "NGN",
});

// Returns: { data: PaymentMethod[], total, page }

// Static: a permanent account, grouped by purpose
const staticAccount = await afriex.paymentMethods.createVirtualAccount({
  currency: "NGN",
  label: "SALES",
  customerId: "customer-id",
});

// Dynamic: a one-time account for a specific amount
const dynamicAccount = await afriex.paymentMethods.createVirtualAccount({
  currency: "NGN",
  amount: 50000,
  customerId: "customer-id",
});

if (dynamicAccount) {
  console.log(dynamicAccount.accountNumber, dynamicAccount.reference);
}

const transfer = await afriex.paymentMethods.simulateTransfer({
  accountNumber: "6520751033",
  amount: 2500,
  currency: "NGN",
});

console.log(transfer.reference);

const poolAccount = await afriex.paymentMethods.getPoolAccount({
  customerId: "customer-id",
  country: "NG",
});

console.log(poolAccount.accountNumber, poolAccount.reference);