Initialize a payment

POST

payment

initialize

curl --request POST \
  --url https://server.staging.vestrapay.app/v1/payment/initialize \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": "100.00"
}
'

{
  "status": "success",
  "data": {
    "reference": "VPY_TXN_ACME001",
    "accessCode": "a1b2c3d4e5f6a1b2",
    "checkoutUrl": "https://checkout.vestrapay.com/a1b2c3d4e5f6a1b2",
    "amount": "100.00",
    "cardFee": "1.50",
    "transferFee": "1.00",
    "cardTotal": "101.50",
    "transferTotal": "101.00",
    "currency": "NGN",
    "merchantBearsCost": false,
    "channels": [
      "card",
      "bank_transfer",
      "bank_payment",
      "ussd"
    ],
    "status": "pending"
  }
}

{
  "status": "failed",
  "error": "<string>",
  "message": "<string>"
}

Authorizations

x-api-key

string

header

required

Secret key (sk_test_ or sk_live_). Authorization Bearer with the same value is also accepted.

Body

application/json

amount

string

required

Major units as a string. Not kobo.

Example:

"100.00"

currency

string

default:NGN

string<email>

customerName

string

callbackUrl

string<uri>

description

string

metadata

object

distribution

object

serviceKey to amount in the same unit as amount

Show child attributes

merchantBearsCost

boolean

Response

Transaction created

status

enum<string>

required

Available options:

success

data

object

required

Show child attributes

⌘I

curl --request POST \
  --url https://server.staging.vestrapay.app/v1/payment/initialize \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": "100.00"
}
'

{
  "status": "success",
  "data": {
    "reference": "VPY_TXN_ACME001",
    "accessCode": "a1b2c3d4e5f6a1b2",
    "checkoutUrl": "https://checkout.vestrapay.com/a1b2c3d4e5f6a1b2",
    "amount": "100.00",
    "cardFee": "1.50",
    "transferFee": "1.00",
    "cardTotal": "101.50",
    "transferTotal": "101.00",
    "currency": "NGN",
    "merchantBearsCost": false,
    "channels": [
      "card",
      "bank_transfer",
      "bank_payment",
      "ussd"
    ],
    "status": "pending"
  }
}

{
  "status": "failed",
  "error": "<string>",
  "message": "<string>"
}

Payments

Checkout

Initialize a payment

Authorizations

Body

Response