Skip to main content
POST
Initiate a tag-to-tag payment

Authorizations

Authorization
string
header
required

Obtain a token from POST /v1/auth/token using your client_id and client_secret, then enter Bearer <token> here.

Headers

Idempotency-Key
string

Optional idempotency key (UUID or any unique string, max 128 chars). Duplicate calls with the same key within 24 hours return the original response.

Body

application/json

Request body for initiating a cross-application tag-to-tag payment

senderTag
string
required

The sender's tag handle (must belong to the calling application)

Example:

"@alice"

receiverTag
string
required

The recipient's tag handle (can belong to any application)

Example:

"@bob"

amount
number
required

Positive payment amount with up to 4 decimal places

Required range: x > 0.0001
Example:

1500

currency
string

ISO 4217 currency code (defaults to NGN)

Pattern: ^[A-Z]{3}$
Example:

"NGN"

narration
string

Optional human-readable payment note

Maximum string length: 500
Example:

"School fees payment"

callbackUrl
string

Optional HTTPS URL that IDaaS will POST the final transaction status to once accepted or rejected

Maximum string length: 500
Example:

"https://my-app.example.com/webhooks/transactions"

idempotencyKey
string

Client-supplied idempotency key (UUID v4 recommended). Duplicate calls within 24 hours return the original response.

Maximum string length: 64
Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Transaction initiated successfully

success
boolean
message
string
errorCode
string
data
object

Full details of a cross-application tag-to-tag payment transaction

errors
string[]
timestamp
string<date-time>