Okay

okay_challenge_challenge_id_accept

SecurityAPI_Secret_Key
Request
path Parameters
challenge_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/challenge/{challenge_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_challenge_challenge_id_reject

SecurityAPI_Secret_Key
Request
path Parameters
challenge_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/challenge/{challenge_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_login_login_id_forgot_pin

SecurityAPI_Secret_Key
Request
path Parameters
login_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/login/{login_id}/forgot_pin
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_login_login_id_accept

SecurityAPI_Secret_Key
Request
path Parameters
login_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/login/{login_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_login_login_id_pin

SecurityAPI_Secret_Key
Request
path Parameters
login_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
passcode
string
Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/login/{login_id}/pin
Request samples
application/json
{
  • "passcode": "string"
}
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_login_login_id_reject

SecurityAPI_Secret_Key
Request
path Parameters
login_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/login/{login_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_sends_send_id_forgot_pin

SecurityAPI_Secret_Key
Request
path Parameters
send_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/sends/{send_id}/forgot_pin
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_sends_send_id_accept

SecurityAPI_Secret_Key
Request
path Parameters
send_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/sends/{send_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_sends_send_id_pin

SecurityAPI_Secret_Key
Request
path Parameters
send_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
passcode
string
Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/sends/{send_id}/pin
Request samples
application/json
{
  • "passcode": "string"
}
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_sends_send_id_reject

SecurityAPI_Secret_Key
Request
path Parameters
send_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/sends/{send_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_beneficiary_issue

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
programmeName
required
string
operation
required
string
transactionId
required
string
transactionGroup
required
string
count
integer <int32>
credentialId
integer <int64>
Responses
200

Success

400

Invalid Request

409

Conflict

default

Error

post/okay/beneficiary/issue
Request samples
application/json
{
  • "programmeName": "string",
  • "operation": "string",
  • "transactionId": "string",
  • "transactionGroup": "string",
  • "count": 0,
  • "credentialId": 0
}
Response samples
application/json
{
  • "challengeId": 0,
  • "factorType": "PASSWORD"
}

okay_stepup_challenge_id_forgot_pin

SecurityAPI_Secret_Key
Request
path Parameters
challenge_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/stepup/{challenge_id}/forgot_pin
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_stepup_challenge_id_accept

SecurityAPI_Secret_Key
Request
path Parameters
challenge_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/stepup/{challenge_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_stepup_challenge_id_pin

SecurityAPI_Secret_Key
Request
path Parameters
challenge_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
passcode
string
Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/stepup/{challenge_id}/pin
Request samples
application/json
{
  • "passcode": "string"
}
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_stepup_challenge_id_reject

SecurityAPI_Secret_Key
Request
path Parameters
challenge_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/stepup/{challenge_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_three_ds_challenge_challenge_id_accept

SecurityAPI_Secret_Key
Request
path Parameters
challenge_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/three_ds/challenge/{challenge_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_three_ds_challenge_challenge_id_reject

SecurityAPI_Secret_Key
Request
path Parameters
challenge_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/three_ds/challenge/{challenge_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_three_ds_user_credential_id_issue

SecurityAPI_Secret_Key
Request
path Parameters
credential_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
merchant
required
string
maskedCardNo
required
string
required
object

A message representing a monetary amount in a particular currency.

Responses
200

Success

400

Invalid Request

409

Conflict

default

Error

post/okay/three_ds/user/{credential_id}/issue
Request samples
application/json
{
  • "merchant": "string",
  • "maskedCardNo": "string",
  • "transactionAmount": {
    }
}
Response samples
application/json
{
  • "challengeId": 0,
  • "factorType": "PASSWORD"
}

okay_beneficiary_management_beneficiary_batch_id_forgot_pin

SecurityAPI_Secret_Key
Request
path Parameters
beneficiary_batch_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/beneficiary_management/{beneficiary_batch_id}/forgot_pin
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_beneficiary_management_beneficiary_batch_id_accept

SecurityAPI_Secret_Key
Request
path Parameters
beneficiary_batch_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/beneficiary_management/{beneficiary_batch_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_beneficiary_management_beneficiary_batch_id_pin

SecurityAPI_Secret_Key
Request
path Parameters
beneficiary_batch_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
passcode
string
Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/beneficiary_management/{beneficiary_batch_id}/pin
Request samples
application/json
{
  • "passcode": "string"
}
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_beneficiary_management_beneficiary_batch_id_reject

SecurityAPI_Secret_Key
Request
path Parameters
beneficiary_batch_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/beneficiary_management/{beneficiary_batch_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_owt_owt_id_forgot_pin

SecurityAPI_Secret_Key
Request
path Parameters
owt_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/owt/{owt_id}/forgot_pin
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_owt_owt_id_accept

SecurityAPI_Secret_Key
Request
path Parameters
owt_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/owt/{owt_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_owt_owt_id_pin

SecurityAPI_Secret_Key
Request
path Parameters
owt_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
passcode
string
Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/owt/{owt_id}/pin
Request samples
application/json
{
  • "passcode": "string"
}
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_owt_owt_id_reject

SecurityAPI_Secret_Key
Request
path Parameters
owt_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/owt/{owt_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_enrol_credential_id_forgot_pin

SecurityAPI_Secret_Key
Request
path Parameters
credential_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/enrol/{credential_id}/forgot_pin
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_enrol_credential_id_acceptDeprecated

Enrolment challenges are no longer needed with the new okay enrolment flow

SecurityAPI_Secret_Key
Request
path Parameters
credential_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/enrol/{credential_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_enrol_credential_id_pinDeprecated

Enrolment challenges are no longer needed with the new okay enrolment flow

SecurityAPI_Secret_Key
Request
path Parameters
credential_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
passcode
string
Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/enrol/{credential_id}/pin
Request samples
application/json
{
  • "passcode": "string"
}
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_enrol_credential_id_rejectDeprecated

Enrolment challenges are no longer needed with the new okay enrolment flow

SecurityAPI_Secret_Key
Request
path Parameters
credential_id
required
integer <int64>
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/okay/enrol/{credential_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

okay_live_get

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
200

Success

400

Invalid Request

409

Conflict

default

Error

post/okay/live/get
Response samples
application/json
{
  • "enabled": true
}

okay_live_enable

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
200

Success

400

Invalid Request

409

Conflict

default

Error

post/okay/live/enable
Response samples
application/json
{
  • "enabled": true
}

okay_live_disable

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
200

Success

400

Invalid Request

409

Conflict

default

Error

post/okay/live/disable
Response samples
application/json
{
  • "enabled": true
}