cNGN documentation
  • Introduction
    • Overview
      • Use Cases
      • Definitions
      • Brand Assets
    • Going Live checklist
  • Getting Started
    • Security
      • Generating SSH keys
      • Generating API Keys
      • Encrypting / Decrypting Request
  • Integrations
    • Contract Address
    • Networks Enum
    • Authorization
    • Endpoints
      • Get Balance
      • Get Bank List
      • Transaction History
      • Virtual Account
      • Redeem Assets
      • Withdraw cNGN
      • Verify Withdrawal
      • Bridge cNGN
      • Whitelist Address
  • Libraries/SDKs
    • Backend Libraries
      • cNGN PHP Library
      • cNGN Python Library
      • cNGN Nodejs Library
      • cNGN Java Library
    • Frontend SDKs/Widget
Powered by GitBook
On this page
  1. Integrations
  2. Endpoints

Redeem Assets

Redeem Assets

POST /redeemAsset

<Description of the endpoint>

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

amount

number

then amount to be redeemed

bank

string

bank code, please use the bank list endpoint to get the back codes

accountNumber

string

account number to redeem to

saveDetails

boolean

save account for future use

Response

{
  "status": 200,
  "message": "Deposit for redeem was successfully",
  "data": "<encrypted response>"
}
{
  "error": "Invalid request"
}

Decrypted Response


{
  "status": 200,
  "message": "Deposit for redeem was successfully",
  "data": {
      "id": "113e2009-fbd9-4a5f-b1d0-f5508bcef931",
      "from": "Bobo",
      "receiver": {
        "bank": {
          "name": "First Bank of Nigeria",
          "slug": "firstbank",
          "code": "011",
          "country": "NG",
          "nibss_bank_code": "000016"
        },
        "accountNumber": "3092345285"
      },
      "amount": "1000000",
      "description": "cNGN Redemption",
      "createdAt": "2025-01-23T10:38:55.649Z",
      "trx_ref": "c1147d4f-81bf-47e5-9b9f-df8855d3275a",
      "trx_type": "fiat_redeem",
      "network": "xbn",
      "asset_type": "wrapped",
      "asset_symbol": "NGN",
      "base_trx_hash": null,
      "extl_trx_hash": null,
      "explorer_link": null,
      "status": "pending"
    }
}
PreviousVirtual AccountNextWithdraw cNGN

Last updated 3 months ago