Update a payment link

PATCH

/v1/payment-links/{payment_link_id}

curl --request PATCH \
  --url https://api.feitpay.com/v1/payment-links/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "active": true, "title": "example", "description": "example" }'

• GRYPHEM PAY API

Authorizations

• ApiKey
• Session

Parameters

Path Parameters

payment_link_id

required

string

Header Parameters

Gryphem-Organization

string

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

Request Body^required

Media typeapplication/json

object

active

boolean

title

string

>= 1 characters <= 120 characters

description

string

<= 500 characters

Example ^generated

{
  "active": true,
  "title": "example",
  "description": "example"
}

Responses

200

Updated.

Media typeapplication/json

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": "payment_link",
  "amount": "59.90"
}

401

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"
  }
}

403

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"
  }
}

404

Resource not found (or not visible to this tenant).

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"
  }
}

422

Validation failed.

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"
  }
}

429

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"
  }
}

Headers

Retry-After

integer