API Reference

API Reference

Authentication API

Generate Access Token

• Path: /api/v1/access-token
• Method: POST
• Request Body:
  • apiClientId: string (required)
  • apiClientSecret: string (required)
• Response Body:
  • access_token: string
  • refresh_token: string
  • scope: string
  • id_token: string
  • token_type: string
  • expires_in: string

Account Management

Fund NGN Account

(only applicable on sandbox for NGN payout accounts)

• Path: /api/v1/fund-ngn-account
• Method: POST
• Request Body:
  • onusReference: string (required), dynamic account: use onus reference, for fixed account: you can use a unique reference
  • accountNumber: string (required)
  • amount: double (required)
  • paymentStatus: string (required), values: SUCCESSFUL, FAILED
  • forDynamicAccount: boolean (required), values: true for dynamic account transaction, false for fixed account transactions
• Response Body:
  • message: string

Transfers

Name Enquiry

• Path: /api/v1/transfer-requests/name-enquiry
• Method: POST
• Request Body:
  • institutionCode: string (required)
  • accountNumber: string (required)
  • businessId: string (required)
• Response Body:
  • accountNumber: string
  • accountName: string
  • bankCode: string
  • bankName: string

Initiate Bank Transfer

• Path: /api/v1/transfer-requests/bank-transfer
• Method: POST
• Request Body:
  • reference: string (required) - unique reference
  • amount: double (required)
  • beneficiaryAccountNumber: string (required)
  • beneficiaryAccountName: string (required)
  • beneficiaryBankCode: string (required)
  • transferType: string (required) - valid types: WALLET_TO_BANK_ACCOUNT, WALLET_TO_WALLET, WALLET_TO_MOMO
  • countryCode: string (required) - alpha-2 country code
  • currency: string (required)
  • businessId: string (required)
  • email: string (required)
  • notificationUrl: string (optional) - webhook notification will be sent to this URL if specified. If not provided, it will default to business notification URL
• Response Body:
  • paymentStatus: string - valid types: PENDING, PROCESSING, SUCCESSFUL, FAILED, REJECTED
  • currency: string
  • amount: double
  • fee: double
  • onusReference: string
  • merchantReference: string

Fetch List of Transfer Requests / Payouts

• Path: /api/v1/transfer-requests
• Method: GET
• Query Params:
  • id: string
  • status: string - valid types: PENDING, PROCESSING, SUCCESSFUL, FAILED, REJECTED
  • onusReference: string
  • accountNumber: string
  • merchantReference: string
  • businessIds: string (array)
  • channel: string - valid types: CARD, BANK_TRANSFER, WALLET_TRANSFER, MOBILE_MONEY, EFT
  • transferType: string - valid types: WALLET_TO_BANK_ACCOUNT, WALLET_TO_WALLET, WALLET_TO_MOMO
  • currency: string
  • reversed: boolean
  • refund: boolean
  • createdFrom: datetime (format: YYYY-MM-DD)
  • createdTo: datetime (format: YYYY-MM-DD)
• Response Body:
  • pageNo: number
  • pageSize: number
  • lastPage: number
  • totalNumberOfItems: number
  • content: (collection)
    • id: string
    • businessId: string
    • merchantUserId: string
    • amount: double
    • fee: double
    • paymentChannel: string - valid types: CARD, BANK_TRANSFER, WALLET_TRANSFER, MOBILE_MONEY, EFT
    • currency: string
    • countryCode: string - alpha-2 country code
    • beneficiaryAccountNumber: string
    • beneficiaryAccountName: string
    • walletId: string
    • beneficiaryWalletId: string (optional) - only available for wallet-to-wallet transfers
    • bankCode: string
    • bankName: string
    • onusReference: string
    • reference: string
    • sessionId: string
    • notificationUrl: string (optional)
    • reversed: boolean
    • isRefund: boolean
    • onusResponseCode: string - valid types: Transfer Response Codes
    • paymentStatus: string - valid types: PENDING, PROCESSING, SUCCESSFUL, FAILED, REJECTED
    • transferType: string - valid types: WALLET_TO_BANK_ACCOUNT, WALLET_TO_WALLET, WALLET_TO_MOMO
    • narration: string
    • businessName: string
    • merchantName: string
    • createdDate: datetime
    • lastUpdatedDate: datetime