Skip to content

List payment links

GET
/v1/payment-links
curl --request GET \
--url https://api.feitpay.com/v1/payment-links \
--header 'Authorization: Bearer <token>' \
--header 'Gryphem-Environment: test'
Gryphem-Organization
string

Active organization for dashboard sessions. Ignored for API keys (the key determines the organization).

Gryphem-Environment
string
default: test
Allowed values: test live

test (default) or live for dashboard sessions. API keys determine the environment.

Payment links.

Media typeapplication/json
object
object
required
string
Allowed value: list
data
required
Array<object>
object
id
required
string
object
required
string
Allowed value: payment_link
livemode
required
boolean
store_id
required
string
title
required
string
description
required
string | null
amount
required

Decimal string. Never a float.

string
/^(0|[1-9][0-9]*)(\.[0-9]+)?$/
currency
required
string
url
required
string format: uri
active
required
boolean
allowed_networks
required
Array<string>
redirect_url
required
string | null
sessions_count
required
integer
confirmed_count
required
integer
created_at
required
string format: date-time

Example

{
"object": "list",
"data": [
{
"object": "payment_link",
"amount": "59.90"
}
]
}

Missing or invalid credentials.

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error
code
required
string
message
required
string
param
string
request_id
required
string

Example

{
"error": {
"type": "invalid_request_error"
}
}

Authenticated but not permitted.

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error
code
required
string
message
required
string
param
string
request_id
required
string

Example

{
"error": {
"type": "invalid_request_error"
}
}

Too many requests. See Retry-After.

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error
code
required
string
message
required
string
param
string
request_id
required
string

Example

{
"error": {
"type": "invalid_request_error"
}
}
Retry-After
integer