Skip to navigation

Create Card Customer

View as Markdown

Registers a customer with the card issuing provider. Do this once per customer before issuing a card.

Body (JSON) — all fields required (presence check only; no Joi schema):

FieldTypeNotes
customerIdstringID of an existing customer that belongs to your company
streetstringBilling address line 1
lgastringSent to provider as billing address line 2
citystring
statestring
countrystringe.g. NG
postalCodestring

The customer’s first/last name, email and mobile number are taken from the customer record. Call once per customer; a second call returns 400 Customer already exist, proceed to generate a card.... Returns 201 with no data object.

All errors from this folder use { "status": "error", "message": "..." } and are returned as HTTP 400 (including “Card not found” — there is no 404). Success bodies use status: "success" (not success: true like the VTU endpoints).

Authentication

AuthorizationBearer

Access token from Generate Access Token (valid 15 minutes).

Request

This endpoint expects an object.
customerIdstringOptional
statestringOptional
countrystringOptional
citystringOptional
streetstringOptional
postalCodestringOptional
lgastringOptional

Response

Created
statusstringOptional
messagestringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error