Skip to main content
POST
/
api
/
v1
/
checkout-wallet
Create Checkout Wallet
curl --request POST \
  --url https://checkout-staging.embedly.ng/api/v1/checkout-wallet \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "organizationId": "<string>",
  "expectedAmount": 123,
  "organizationPrefixMappingId": "<string>",
  "expiryDurationMinutes": 123,
  "invoiceReference": "<string>",
  "description": "<string>",
  "currencyCode": "<string>",
  "customerEmail": "<string>",
  "customerName": "<string>",
  "metadata": "<string>",
  "splitType": "<string>",
  "incomeSplitConfig": [
    {}
  ],
  "accountInquiryResponseName": "<string>"
}
'
{
  "statusCode": 200,
  "message": "Checkout wallet reactivated successfully",
  "data": {
      "id": "bfce68af-4b43-4827-abb8-985a2d3b8a79",
      "walletNumber": "2225657965",
      "organizationId": "02600494-1a3c-11f0-a818-6045bd97b81d",
      "walletName": "Embedly Check Demo",
      "status": "Reactivated",
      "createdAt": "2025-07-14T16:47:32.297357Z",
      "expiresAt": "2025-07-24T14:28:01.1254478Z",
      "reactivatedAt": "2025-07-24T13:58:01.1254127Z",
      "expectedAmount": 20000,
      "checkoutRef": "CHK202507241358013544205"
  }
}
When a checkout wallet is generated without an ‘expiryDurationMinutes’, the system default of 30 minutes is applied to that wallet.
​
organizationId
string
required
Example: 02600494-1a3c-11f0-a818-6045bd97b81d
​
expectedAmount
number
required
Example: 20000
​
organizationPrefixMappingId
string
required
Example: 8b4432bc-f3c7-4055-b5e5-e232707e79af. You can get this Id using the ‘Get Organization Prefix Mapping Endpoint’
​
expiryDurationMinutes
number
This is the duration in minutes for which the wallet is to be active Example: 30.
​
invoiceReference
string
Example: CHK202507241358013544205.
​
description
string
Example: This is a checkout wallet.
​
currencyCode
string
Example: NGN.
​
customerEmail
string
Example: john_doe@gmail.com.
​
customerName
string
This is the customer name. Example: John Doe.
​
metadata
string
​
splitType
string
This can either be Fixed or Percentage. This property is required when it is a split payment. Example: Fixed.
​
incomeSplitConfig
object[]
Required for split payments. Defines the distribution of funds among multiple beneficiaries.Example: [{ "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "splitValue": 100, "feeValue": 5, "feeBearer": true }]
​
accountInquiryResponseName
string
Pass this to determine the name that should show when you validate the account number on banking applications. Example: John Doe.
{
  "statusCode": 200,
  "message": "Checkout wallet reactivated successfully",
  "data": {
      "id": "bfce68af-4b43-4827-abb8-985a2d3b8a79",
      "walletNumber": "2225657965",
      "organizationId": "02600494-1a3c-11f0-a818-6045bd97b81d",
      "walletName": "Embedly Check Demo",
      "status": "Reactivated",
      "createdAt": "2025-07-14T16:47:32.297357Z",
      "expiresAt": "2025-07-24T14:28:01.1254478Z",
      "reactivatedAt": "2025-07-24T13:58:01.1254127Z",
      "expectedAmount": 20000,
      "checkoutRef": "CHK202507241358013544205"
  }
}