POST
/
payments
/
v1
/
checkouts
curl --request POST \
  --url https://sandbox-api.payfonte.com/payments/v1/checkouts \
  --header 'Content-Type: application/json' \
  --header 'client-id: <api-key>' \
  --header 'client-secret: <api-key>' \
  --data '{
  "country": "NG",
  "base": {
    "currency": "NGN",
    "amount": 10000
  },
  "shop": {
    "currency": "USD",
    "amount": 15
  },
  "user": {
    "name": "Example User",
    "email": "user@example.com",
    "phoneNumber": "2347012345678"
  },
  "reference": "<string>",
  "redirectURL": "https://example.com/redirect/success",
  "cancelURL": "https://example.com/redirect/cancel",
  "webhook": "https://example.com/webhook"
}'
{
  "data": {
    "url": "https://checkout-staging.payfonte.com/payfusion/66579afe04916ddcfcf73e7b",
    "shortURL": "https://l.6bd.co/XXXXX",
    "reference": "<string>",
    "amount": 100000,
    "currency": "NGN"
  }
}

Authorizations

​
client-id
string
header
required
​
client-secret
string
header
required

Body

application/json
Generate A Payment Checkout URL
​
country
string
required

2 character country code

Example:

"NG"

​
base
object
required

This is the base currency and amount the customer should be charged in

​
user
object
required
​
shop
object
​
reference
string

A reference code you'll generate to identify this transaction. This must be unique for every transaction. If you don't pass one, we will generate one for you.

​
redirectURL
string

Fully qualified URL to which the customer should be redirected after the payment is completed

Example:

"https://example.com/redirect/success"

​
cancelURL
string

Fully qualified URL to which the customer should be redirected if the cancel the payment session

Example:

"https://example.com/redirect/cancel"

​
webhook
string

This is a URL, if this is passed we will send the event webhook payload to this endpoint. Use this to override the webhook url provided on the dashboard for this transaction. Read more on Webhooks

Example:

"https://example.com/webhook"

Response

201 - application/json
Checkout URL Successfully Generated
​
data
object