Skip to main content
POST
Afriex SDK
A deposit needs this step when the create-transaction response comes back with status CUSTOMER_ACTION_REQUIRED and meta.otpRequired set to true.
Testing in sandbox? Submit the OTP 123456 to complete the deposit. Any other value is rejected so you can test the wrong-OTP path. See Simulating OTP-required deposits for the full sandbox flow.

Authorizations

x-api-key
string
header
required

Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Manage your keys and their permissions under Developer → API keys in the dashboard.

A request whose key does not carry the permission the target endpoint requires is rejected with 401 Unauthorized, the same response an unrecognised, malformed, revoked or disabled key returns. The API does not distinguish the two cases on the wire.

See the Permissions reference for the permission each endpoint requires.

Headers

x-api-signature
string

Signature of the request payload, used for request authentication where payload signing is enabled for your business.

x-api-version
string

API version in ISO 8601 format. The only supported version is 2026-05-18, which is also the default when the header is omitted. Any other value is rejected with a 400 Bad Request.

Path Parameters

transactionId
string
required

The unique identifier of the transaction

Body

application/json
type
enum<string>
required

The authorization method.

Available options:
OTP
otp
string
required

The one-time password supplied by the customer.

Response

Transaction authorized successfully.

data
object