POST
/
v1
/
payments
cURL
curl --request POST \
  --url https://api.paycashless.com/v1/payments \
  --header 'Content-Type: application/json' \
  --header 'Request-Signature: <request-signature>' \
  --header 'Request-Timestamp: <request-timestamp>' \
  --data '{
  "reference": "<string>",
  "paymentMethod": "pay_with_transfer",
  "amount": {
    "value": 50001,
    "currency": "NGN"
  },
  "customer": {
    "email": "[email protected]",
    "name": "<string>"
  },
  "expiresIn": 1800,
  "callbackUrl": "<string>",
  "metadata": {}
}'
{
  "id": "<string>",
  "reference": "<string>",
  "accountName": "<string>",
  "accountNumber": "<string>",
  "bankName": "<string>",
  "amount": {
    "value": 123,
    "currency": "<string>"
  },
  "customer": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>",
    "address": "<string>",
    "reference": "<string>",
    "isBlacklisted": true,
    "liveMode": true
  },
  "metadata": {},
  "liveMode": true,
  "expiresAt": "2023-11-07T05:31:56Z"
}

Headers

Request-Signature
string
required

SHA-512 HMAC signature of the request payload using the API secret

Minimum length: 1
Example:

"5e73d044c44d733fcf819ad3409aaaddca840d421b69cb0b04e2c750fc62ece7526d36296237663ad1f06f62a730c0466516507196b3ce6567493cc52a7cf63d"

Request-Timestamp
string
required

UNIX timestamp when the request was created (in seconds)

Example:

"1712336881"

Body

application/json
reference
string
required
paymentMethod
enum<string>
required
Available options:
pay_with_transfer
amount
object
required
customer
object
required
expiresIn
number
required

The time in minutes before the payment expires (in seconds)

Example:

1800

callbackUrl
string<uri>
metadata
object

Response

200 - application/json

Initiate a payment with transfer

id
string
required
reference
string
required
accountName
string
required
accountNumber
string
required
bankName
string
required
amount
object
required
customer
object
required
liveMode
boolean
required
expiresAt
string<date-time>
required
metadata
object