Payment Link

This is where the Payment Link is created also know as Payment Intent

Create an Payment Link

POST/api/v1/payment-link

Authorization

JWT

Body

application/json

productType*enum

Type of product being sold

productservicenft

price*number

Price in cents of the product being sold

benefits*array of string

Array of benefit IDs that are gonna be associated with this payment link

userWalletsarray of string

Array of wallets of the user purchasing the product

isTokenGated*boolean

If this payment link uses Token Gate

receiveCurrency*enum

Type of currency in which the payment will be received

maticbrl

name*string

Name of the product being sold

imagenullable string

Image of the product being sold

paymentMethod*enum

Payment method of the link

pixmatic

checkingAccountstring

Id of the Checking account that will be related to the payment link

whitelistEndDatenullable string (date-time)

Date on which the whitelist will end

expiresAtnullable string (date-time)

Expiration date of the payment link

redirectTonullable string

Url to which the link will redirect to

activeboolean

Status of the payment link

Response

201

Request

JavaScriptCurl

const response = await fetch('/api/v1/payment-link', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "productType": "product",
      "price": 0,
      "benefits": [
        "text"
      ],
      "isTokenGated": false,
      "receiveCurrency": "matic",
      "name": "text",
      "paymentMethod": "pix"
    }),
});
const data = await response.json();

Get info from all of your Payment Links

GET/api/v1/payment-link/manage

Authorization

JWT

Query parameters

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/payment-link/manage', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Get detailed Payment Link info​

GET/api/v1/payment-link/{id}

Path parameters

id*string

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/payment-link/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Update an Payment Link

PATCH/api/v1/payment-link/{id}

Authorization

JWT

Path parameters

id*string

Body

application/json

productTypeenum

Type of product being sold

productservicenft

pricenumber

Price in cents of the product being sold

receiveCurrencyenum

Type of currency in which the payment will be received

maticbrl

namestring

Name of the product being sold

imagenullable string

Image of the product being sold

paymentMethodenum

Payment method of the link

pixmatic

checkingAccountstring

Id of the Checking account that will be related to the payment link

whitelistEndDatenullable string (date-time)

Date on which the whitelist will end

redirectTonullable string

Url to which the link will redirect to

activeboolean

Status of the payment link

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/payment-link/{id}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Disable an Payment Link

DELETE/api/v1/payment-link/{id}

Authorization

JWT

Path parameters

id*string

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/payment-link/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();