Complete Payment

POST /api/payments/complete-payment

Complete a payment sent to your token webhook

Header Parameters

• api-key string required
• api-secret string required

application/json

Request Body required

• paymentId uuid required

  Unique identifier for the payment

• otp string required

  OTP sent via email, webhook or SMS

Responses

• 200
• 400

---

Payment was completed

Response Headers

• x-request-id any

  Request Id for traceability

*/*

Schema

Schema

• paymentId uuid required

  Unique identifier for the payment

• reference string required

  Reference set by the initiator

• success boolean required

  Is success

Example (from schema)

{
  "paymentId": "f9eb1b23-4f78-495c-968c-9dfdfc89a16d",
  "reference": "test-ref",
  "success": true
}

Error occurred - bad request

*/*

Schema

Schema

• requestId uuid

  Request Id for traceability

• detail string

  Detail of the message.

• status string

  Possible values: [API_KEYS_INVALID, INSUFFICIENT_FUNDS, INTERNAL_ERROR, API_NOT_ACTIVATED, NOT_SUPPORTED, CURRENCY_NOT_SUPPORTED, MOBILE_MONEY_NOT_WHOLE_NUMBER, BALANCE_NOT_FOUND, BALANCE_NOT_AUTHORISED, BALANCE_NOT_NUMERIC, WEB_HOOK_NOT_SPECIFIED_FOR_OTP, TOKEN_INVALID, PAYMENT_NOT_FOUND, RECIPIENT_INVALID_ID]

  Status

Example (from schema)

{
  "requestId": "d4265597-5317-45fd-8d2f-8012870633d5",
  "detail": "API key not valid or Internal error",
  "status": "INTERNAL_ERROR"
}

Loading...