Payment links

get/v1/payment_linksList payment links
post/v1/payment_linksCreate a payment link
post/v1/payment_links/{id}/activateActivate a payment link
post/v1/payment_links/{id}/deactivateDeactivate a payment link

List payment links

get/v1/payment_links

bash

curl https://sandbox.api.biftpay.com/v1/payment_links \
  -H "Authorization: Bearer bp_test_..."

Responses

200
OKobject
Fields
object"list"required
dataarray of PaymentLinkrequired
Fields of data
idstring (uuid)required
object"payment_link"required
livemodebooleanrequired
brandstring (uuid) | null
slugstringrequired
Unique within the merchant and mode.
pathstringrequired
Where customers pay, on the checkout site: /pay/<handle>/<slug> (live) or /pay/test/<handle>/<slug> (test). Links made before merchant handles keep /pay/<slug>.
titlestringrequired
descriptionstring | null
amountinteger | null
min_amountinteger | null
max_amountinteger | null
currencyNGN | USDrequired
statusactive | inactiverequired
created_atstring (date-time)required
has_moreboolean

Create a payment link

post/v1/payment_links

Set amount for a fixed price, or leave it out to let the customer enter any amount (optionally within min_amount and max_amount; a payment must still cover its processing fee). Customers open the link's path on the checkout site (checkout API /checkout/v1/merchants/{handle}/links/{slug}). slug is optional and only has to be unique within your account.

Parameters

Idempotency-Keystringin headerrequired

A unique key per logical request, for example a UUID. Up to 255 characters.

up to 255 characters

Body

titlestringrequired

up to 120 characters

descriptionstring

up to 500 characters

amountinteger

at least 1

min_amountinteger

at least 1

max_amountinteger

at least 1

currencyNGN | USD

brandstring (uuid)

slugstring

bash

curl -X POST https://sandbox.api.biftpay.com/v1/payment_links \
  -H "Authorization: Bearer bp_test_..." \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "…"
  }'

Responses

201
OKPaymentLink
Fields
idstring (uuid)required
object"payment_link"required
livemodebooleanrequired
brandstring (uuid) | null
slugstringrequired
Unique within the merchant and mode.
pathstringrequired
Where customers pay, on the checkout site: /pay/<handle>/<slug> (live) or /pay/test/<handle>/<slug> (test). Links made before merchant handles keep /pay/<slug>.
titlestringrequired
descriptionstring | null
amountinteger | null
min_amountinteger | null
max_amountinteger | null
currencyNGN | USDrequired
statusactive | inactiverequired
created_atstring (date-time)required
400
Invalid request
409
The object is in a state that doesn't allow this

Activate a payment link

post/v1/payment_links/{id}/activate

Parameters

idstring (uuid)in pathrequired

Idempotency-Keystringin headerrequired

A unique key per logical request, for example a UUID. Up to 255 characters.

up to 255 characters

bash

curl -X POST https://sandbox.api.biftpay.com/v1/payment_links/{id}/activate \
  -H "Authorization: Bearer bp_test_..." \
  -H "Idempotency-Key: $(uuidgen)"

Responses

200
OKPaymentLink
Fields
idstring (uuid)required
object"payment_link"required
livemodebooleanrequired
brandstring (uuid) | null
slugstringrequired
Unique within the merchant and mode.
pathstringrequired
Where customers pay, on the checkout site: /pay/<handle>/<slug> (live) or /pay/test/<handle>/<slug> (test). Links made before merchant handles keep /pay/<slug>.
titlestringrequired
descriptionstring | null
amountinteger | null
min_amountinteger | null
max_amountinteger | null
currencyNGN | USDrequired
statusactive | inactiverequired
created_atstring (date-time)required
404
Not found, or not visible to this key

Deactivate a payment link

post/v1/payment_links/{id}/deactivate

Parameters

idstring (uuid)in pathrequired

Idempotency-Keystringin headerrequired

A unique key per logical request, for example a UUID. Up to 255 characters.

up to 255 characters

bash

curl -X POST https://sandbox.api.biftpay.com/v1/payment_links/{id}/deactivate \
  -H "Authorization: Bearer bp_test_..." \
  -H "Idempotency-Key: $(uuidgen)"

Responses

200
OKPaymentLink
Fields
idstring (uuid)required
object"payment_link"required
livemodebooleanrequired
brandstring (uuid) | null
slugstringrequired
Unique within the merchant and mode.
pathstringrequired
Where customers pay, on the checkout site: /pay/<handle>/<slug> (live) or /pay/test/<handle>/<slug> (test). Links made before merchant handles keep /pay/<slug>.
titlestringrequired
descriptionstring | null
amountinteger | null
min_amountinteger | null
max_amountinteger | null
currencyNGN | USDrequired
statusactive | inactiverequired
created_atstring (date-time)required
404
Not found, or not visible to this key