GET
/
v1
/
payments
/
{id}
cURL
curl --request GET \
  --url https://api.paycashless.com/v1/payments/{id} \
  --header 'Request-Signature: <request-signature>' \
  --header 'Request-Timestamp: <request-timestamp>'
{
  "id": "<string>",
  "reference": "<string>",
  "currency": "NGN",
  "status": "initiated",
  "accessToken": "<string>",
  "acceptedAmountPolicy": "ACCEPTED_AMOUNT_POLICY_FIXED",
  "paymentMethod": "pay_with_transfer",
  "paymentChannel": "checkout",
  "customerId": "<string>",
  "expectedAmount": 123,
  "chargedAmount": 123,
  "fee": 123,
  "vat": 123,
  "emtl": 123,
  "callbackUrl": "<string>",
  "returnUrl": "<string>",
  "receiptEmail": "[email protected]",
  "metadata": {},
  "liveMode": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "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"

Path Parameters

​
id
string
required
Example:

"pi_ff0c3z37zi40pvc82g74bgsm4q7fubbw"

Response

200 - application/json

Payment retrieved

​
id
string
required
​
reference
string
required
​
currency
enum<string>
required
Available options:
NGN,
USD
​
status
enum<string>
required
Available options:
initiated,
awaiting_charge,
charged,
failed,
expired,
reversed,
succeeded
​
accessToken
string
required
​
acceptedAmountPolicy
enum<string>
required
Available options:
ACCEPTED_AMOUNT_POLICY_FIXED,
ACCEPTED_AMOUNT_POLICY_ALLOW_PARTIAL,
ACCEPTED_AMOUNT_POLICY_ALLOW_EXCESS,
ACCEPTED_AMOUNT_POLICY_ALLOW_ANY
​
paymentMethod
enum<string> | null
required
Available options:
pay_with_transfer,
card,
dedicated_virtual_account,
invoice_payment_account,
bank_transfer
​
paymentChannel
enum<string>
required
Available options:
checkout,
terminal,
api,
bank_account
​
customerId
string
required
​
expectedAmount
integer
required
​
chargedAmount
integer
required
​
fee
number
required
​
vat
number
required
​
emtl
number
required
​
callbackUrl
string | null
required
​
returnUrl
string | null
required
​
receiptEmail
string<email> | null
required
​
metadata
object | null
required
​
liveMode
boolean | null
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required