Skip to main content
POST
/
api
/
transaction
/
initialize
Initializes a payment request
curl --request POST \
  --url https://test.api.orionramp.com/api/transaction/initialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "KESy_TESTNET",
  "amount": 250000.5,
  "email": "jsmith@example.com",
  "currency": "KES",
  "metadata": {
    "orderID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "callback_url": "<string>",
  "channels": [
    "card"
  ]
}
'
{
  "reference": "<string>",
  "authorization_url": "<string>",
  "access_code": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
token
enum<string>
required

The token you want to receive

Available options:
KESy_TESTNET
​
amount
number
required

The amount of money you want user to pay

Required range: 1 <= x <= 500000
​
email
string<email>
required

The user's email, where they'll be sent payment notification

​
currency
enum<string>
required

The currency that user is paying in

Available options:
KES
​
metadata
object
required
​
callback_url
string<url>

Optional callback URL that you want user to be redirected to after completing payment

​
channels
enum<string>[]

The payment channel you want user to use

Available options:
card,
bank,
ussd,
qr,
mobile_money,
bank_transfer,
eft,
apple_pay,
payattitude

Response

201 - application/json

Payment request initialized succesfully

​
reference
string
required
​
authorization_url
string<url>
required

The URL to redirect user to for them to complete payment

​
access_code
string
required