Transactions

Authorize a pending transaction

Completes a transaction that was created in a CUSTOMER_ACTION_REQUIRED state and needs an extra authorization step (for example, a one-time password on a mobile-money deposit). The body is discriminated by type; today the only supported variant is OTP. Your business must have a webhook URL set, otherwise the request is rejected with a 400.

post/api/v1/transaction/{transactionId}/authorize

Request

Base URL
https://sandbox.api.afriex.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/afriex/apis/afriex-business-api/docs/api/v1/transaction/:transactionId/authorize/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

transactionIdstring required

The unique identifier of the transaction

Request body

type'OTP' required

The authorization method.

otpstring required

The one-time password supplied by the customer.

Response

Transaction authorized successfully.

Example response

{
  "data": {
    "meta": {
      "failureReason": {
        "code": "AFX_VELOCITY_LIMIT_EXCEEDED"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.