Create a payment link

POST

/v1/payment-links

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://api.feitpay.com/v1/payment-links"

  payload := strings.NewReader("{ \"store_id\": \"example\", \"title\": \"example\", \"description\": \"example\", \"amount\": \"59.90\", \"currency\": \"EUR\", \"allowed_networks\": [ \"example\" ], \"redirect_url\": \"https://example.com\", \"metadata\": { \"additionalProperty\": \"example\" } }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Gryphem-Environment", "test")
  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://api.feitpay.com/v1/payment-links';
const options = {
  method: 'POST',
  headers: {
    'Gryphem-Environment': 'test',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"store_id":"example","title":"example","description":"example","amount":"59.90","currency":"EUR","allowed_networks":["example"],"redirect_url":"https://example.com","metadata":{"additionalProperty":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.feitpay.com/v1/payment-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Gryphem-Environment: test' \
  --data '{ "store_id": "example", "title": "example", "description": "example", "amount": "59.90", "currency": "EUR", "allowed_networks": [ "example" ], "redirect_url": "https://example.com", "metadata": { "additionalProperty": "example" } }'

Honors Idempotency-Key (replays return the original response for 24 h).

Authorizations

ApiKey
Session

Parameters

Header Parameters

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.

Idempotency-Key

string

<= 255 characters

Unique key per logical create operation (max 255 chars). Replays return the original response; reuse with a different body returns idempotency_error.

Request Body^required

application/json

object

store_id

required

string

title

required

string

>= 1 characters <= 120 characters

description

string

<= 500 characters

amount

required

Decimal string. Never a float.

string

/^(0|[1-9][0-9]*)(\.[0-9]+)?$/

currency

required

string

Allowed values: EUR USD BRL GBP

allowed_networks

Array<string>

redirect_url

string format: uri

metadata

object

<= 20 properties

key

additional properties

string

<= 500 characters

Responses

201

Created.

application/json

object

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.

application/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.

application/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.

application/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.

application/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

Create a payment link

Authorizations

Parameters

Header Parameters

Request Bodyrequired

Responses

201

Example

401

Example

403

Example

422

Example

429

Example

Headers

Request Body^required