Skip to main content
POST
Create an NGN wallet for a customer

Request

string
required
Active production API key belonging to the customer’s merchant.
string
required
FossaPay customer UUID. The customer must belong to the authenticated merchant.
string
required
Non-empty wallet display name.
string
required
Non-empty correlation reference generated and stored by your system.

Request Example

Response

string
success for a successful request.
number
HTTP status code. Successful creation returns 201.
string
Human-readable response message
object

Response Example

Errors

Store the wallet ID, assigned account details, and your wallet reference. Wallet creation does not provide idempotency semantics.

Authorizations

x-api-key
string
header
required

Body

application/json
customerId
string<uuid>
required
walletName
string
required
walletReference
string
required

Response

NGN wallet created successfully

status
string
required
Allowed value: "success"
statusCode
integer
required
message
string
required
data
object
required