Skip to main content
POST
/
v1
/
collection
/
initialise
Error
A valid request URL is required to generate request examples
{
  "message": "Collection Request created successfully",
  "data": {
    "url": "https://pay.useglyde.io/f369f561-aaa4-4701-aeb1-ce79f438efc1"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
currency
string
required

The iso of the currency associated with the collection request. The iso of an existing record in the currencies table.

Example:

"dolor"

​
reference
string
required

A unique reference string you can pass for the transaction. Must be between 8 and 255 characters. Must be at least 8 characters. Must not be greater than 255 characters.

Example:

"iwxwkgbdnayis"

​
amount
number
required

The amount to be collected. Must be a numeric value. Must be at least 100.

Example:

94

​
customer_name
string
required

The full name of the customer. Must not be greater than 255 characters.

Example:

"ztu"

​
customer_email
string
required

The email address of the customer. Must not be greater than 255 characters.

Example:

"[email protected]"

​
channels
enum<string>[]
required

Individual payment channel values. Must be either valid card_payment, bank_transfer class.

Available options:
card_payment,
bank_transfer
Example:
["bank_transfer"]
​
customer_phone
string | null

The phone number of the customer. This is optional and must be a string with a maximum length of 255 characters. Must not be greater than 255 characters.

Example:

"hrfgizigkhjptokkrejaihjny"

​
default_channel
enum<string> | null

The default payment channel to be used. Must be either valid card_payment, bank_transfer class.

Available options:
card_payment,
bank_transfer
Example:

"bank_transfer"

​
meta
object

Additional metadata for the collection request. This must be an array and is optional.

Example:

null

Response

​
message
string
Example:

"Collection Request created successfully"

​
data
object