neo-pays

Instant payment

Generated page, from the OpenAPI specification the gateway serves (GET /v1/openapi.json). Do not edit it by hand: it is rewritten on every build.

Method Path Description
POST /v1/alias-claims Claim an alias
PUT /v1/alias-claims/{claimId}/response Answer a claim
POST /v1/alias-lookups Resolve an alias
POST /v1/payouts/{id}/recall Recall an instant payout
GET /v1/pi-aliases Your enrolled aliases
POST /v1/pi-aliases Enrol an alias
DELETE /v1/pi-aliases/{cle} Remove an alias
PUT /v1/pi-aliases/{cle}/claim-response Answer an alias claim
POST /v1/qr Issue an EMVCo QR
POST /v1/rtp Request a payment (RTP)
PUT /v1/rtp/received/{end2endId}/response Answer a received request
GET /v1/rtp/{id} Retrieve a payment request

POST /v1/alias-claims

Claim an alias

Requests the transfer to you of an alias held elsewhere.

ⓘ Family restricted to accounts with the “instant payment” product enabled; everyone else gets 403. Instant payment is the BCEAO's scheme, on which Mikaty SN SA is a participant.

Parameters

Name In Required Description
Idempotency-Key header no An idempotency key specific to THIS operation. Replaying the same key with the same payload returns the original; replaying it with a different payload is refused (409).

Responses

  • 201 — Claim lodged
  • 401 — API key missing or rejected
  • 403 — The key does not carry the required scope, or the account is not active
  • 409 — Idempotency key replayed with a different payload
  • 422 — Well-formed but refused: missing field, closed corridor, insufficient balance
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After

PUT /v1/alias-claims/{claimId}/response

Answer a claim

The response to a claim, by its identifier.

ⓘ Family restricted to accounts with the “instant payment” product enabled; everyone else gets 403. Instant payment is the BCEAO's scheme, on which Mikaty SN SA is a participant.

Parameters

Name In Required Description
claimId path yes The claim's identifier.

Responses

  • 200 — OK
  • 401 — API key missing or rejected
  • 403 — The key does not carry the required scope, or the account is not active
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After

POST /v1/alias-lookups

Resolve an alias

Queries the directory: who owns this alias?

⚠️ The name returned is the one the directory holds. It is compared against what you assert when you send: a mismatch makes the scheme refuse the operation.

ⓘ Family restricted to accounts with the “instant payment” product enabled; everyone else gets 403. Instant payment is the BCEAO's scheme, on which Mikaty SN SA is a participant.

Responses

  • 200 — OK
  • 401 — API key missing or rejected
  • 403 — The key does not carry the required scope, or the account is not active
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After

POST /v1/payouts/{id}/recall

Recall an instant payout

Requests the recall of a payout already sent. The scheme passes the request on to the beneficiary; a recall is never a right to take the money back.

ⓘ Family restricted to accounts with the “instant payment” product enabled; everyone else gets 403. Instant payment is the BCEAO's scheme, on which Mikaty SN SA is a participant.

Parameters

Name In Required Description
id path yes Internal identifier, the operation's reference, or your own client_ref.

Responses

  • 200 — OK
  • 401 — API key missing or rejected
  • 403 — The key does not carry the required scope, or the account is not active
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After

GET /v1/pi-aliases

Your enrolled aliases

The payment aliases enrolled for your accounts with the scheme's directory.

ⓘ Family restricted to accounts with the “instant payment” product enabled; everyone else gets 403. Instant payment is the BCEAO's scheme, on which Mikaty SN SA is a participant.

Responses

  • 200 — OK
  • 401 — API key missing or rejected
  • 403 — The key does not carry the required scope, or the account is not active
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After

POST /v1/pi-aliases

Enrol an alias

Enrols an alias with the directory.

⚠️ ONE alias per account: a further enrolment is refused, and an orphaned alias blocks the account.

ⓘ Family restricted to accounts with the “instant payment” product enabled; everyone else gets 403. Instant payment is the BCEAO's scheme, on which Mikaty SN SA is a participant.

Parameters

Name In Required Description
Idempotency-Key header no An idempotency key specific to THIS operation. Replaying the same key with the same payload returns the original; replaying it with a different payload is refused (409).

Responses

  • 201 — Alias enrolled
  • 401 — API key missing or rejected
  • 403 — The key does not carry the required scope, or the account is not active
  • 409 — Idempotency key replayed with a different payload
  • 422 — Well-formed but refused: missing field, closed corridor, insufficient balance
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After

DELETE /v1/pi-aliases/{cle}

Remove an alias

Removes the alias from the directory. The account remains; it is the addressing that disappears.

ⓘ Family restricted to accounts with the “instant payment” product enabled; everyone else gets 403. Instant payment is the BCEAO's scheme, on which Mikaty SN SA is a participant.

Parameters

Name In Required Description
cle path yes The alias key.

Responses

  • 204 — Removed
  • 401 — API key missing or rejected
  • 403 — The key does not carry the required scope, or the account is not active
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After

PUT /v1/pi-aliases/{cle}/claim-response

Answer an alias claim

Somebody is claiming an alias you hold: this response accepts or refuses the transfer.

ⓘ Family restricted to accounts with the “instant payment” product enabled; everyone else gets 403. Instant payment is the BCEAO's scheme, on which Mikaty SN SA is a participant.

Parameters

Name In Required Description
cle path yes The claimed alias's key.

Responses

  • 200 — OK
  • 401 — API key missing or rejected
  • 403 — The key does not carry the required scope, or the account is not active
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After

POST /v1/qr

Issue an EMVCo QR

A static or dynamic QR in EMVCo format: the payer scans it with their app and pays.

ⓘ Family restricted to accounts with the “instant payment” product enabled; everyone else gets 403. Instant payment is the BCEAO's scheme, on which Mikaty SN SA is a participant.

Parameters

Name In Required Description
Idempotency-Key header no An idempotency key specific to THIS operation. Replaying the same key with the same payload returns the original; replaying it with a different payload is refused (409).

Responses

  • 201 — QR issued
  • 401 — API key missing or rejected
  • 403 — The key does not carry the required scope, or the account is not active
  • 409 — Idempotency key replayed with a different payload
  • 422 — Well-formed but refused: missing field, closed corridor, insufficient balance
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After

POST /v1/rtp

Request a payment (RTP)

A payment request addressed to a payer: they see it and confirm it at their end. Nothing is debited without their agreement.

ⓘ Family restricted to accounts with the “instant payment” product enabled; everyone else gets 403. Instant payment is the BCEAO's scheme, on which Mikaty SN SA is a participant.

Parameters

Name In Required Description
Idempotency-Key header no An idempotency key specific to THIS operation. Replaying the same key with the same payload returns the original; replaying it with a different payload is refused (409).

Responses

  • 201 — Request issued
  • 401 — API key missing or rejected
  • 403 — The key does not carry the required scope, or the account is not active
  • 409 — Idempotency key replayed with a different payload
  • 422 — Well-formed but refused: missing field, closed corridor, insufficient balance
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After

PUT /v1/rtp/received/{end2endId}/response

Answer a received request

Accept or refuse a payment request addressed to you.

ⓘ Family restricted to accounts with the “instant payment” product enabled; everyone else gets 403. Instant payment is the BCEAO's scheme, on which Mikaty SN SA is a participant.

Parameters

Name In Required Description
end2endId path yes The request's end-to-end identifier.

Responses

  • 200 — OK
  • 401 — API key missing or rejected
  • 403 — The key does not carry the required scope, or the account is not active
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After

GET /v1/rtp/{id}

Retrieve a payment request

The state of the request and, once accepted, the operation that settles it.

ⓘ Family restricted to accounts with the “instant payment” product enabled; everyone else gets 403. Instant payment is the BCEAO's scheme, on which Mikaty SN SA is a participant.

Parameters

Name In Required Description
id path yes Internal identifier, the operation's reference, or your own client_ref.

Responses

  • 200 — OK
  • 401 — API key missing or rejected
  • 403 — The key does not carry the required scope, or the account is not active
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After