MyWay
  • Overview
    • Welcome to MyWay!
  • Integration
    • Onboarding
    • Quick Start
  • API Reference
    • Introduction
    • Authorization
    • Checking Account
    • Payment Link
    • Transaction
    • Benefits
    • Community Tokens
    • Cards
  • Extras
    • Contact
    • SDK Reference
    • FAQ
Powered by GitBook
On this page
  1. API Reference

Payment Link

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

PreviousChecking AccountNextTransaction

Last updated 2 years ago

Create an Payment Link

Get info from all of your Payment Links

Update an Payment Link

Disable an Payment Link

Get detailed Payment Link info

​
get
Authorizations
Query parameters
takenumberOptionalDefault: 36
skipnumberOptionalDefault: 0
Responses
200Success
get
GET /api/v1/payment-link/manage HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
No content
get
Path parameters
idstringRequired
Responses
200Success
get
GET /api/v1/payment-link/{id} HTTP/1.1
Host: 
Accept: */*
200Success
No content
delete
Authorizations
Path parameters
idstringRequired
Responses
200Success
delete
DELETE /api/v1/payment-link/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
No content
  • Create an Payment Link
  • POST/api/v1/payment-link
  • Get info from all of your Payment Links
  • GET/api/v1/payment-link/manage
  • Get detailed Payment Link info​
  • GET/api/v1/payment-link/{id}
  • Update an Payment Link
  • PATCH/api/v1/payment-link/{id}
  • Disable an Payment Link
  • DELETE/api/v1/payment-link/{id}
post
Authorizations
Body
productTypestring · enumRequired

Type of product being sold

Possible values:
pricenumber · min: 100 · max: 2000000000Required

Price in cents of the product being sold

benefitsstring[]Required

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

userWalletsstring[]Optional

Array of wallets of the user purchasing the product

isTokenGatedbooleanRequired

If this payment link uses Token Gate

receiveCurrencystring · enumRequired

Type of currency in which the payment will be received

Possible values:
namestringRequired

Name of the product being sold

imagestring | nullableOptional

Image of the product being sold

paymentMethodstring · enumRequired

Payment method of the link

Possible values:
checkingAccountstringOptional

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

whitelistEndDatestring · date-time | nullableOptional

Date on which the whitelist will end

expiresAtstring · date-time | nullableOptional

Expiration date of the payment link

redirectTostring | nullableOptional

Url to which the link will redirect to

activebooleanOptional

Status of the payment link

Responses
201Success
post
POST /api/v1/payment-link HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 319

{
  "productType": "product",
  "price": 1,
  "benefits": [
    "text"
  ],
  "userWallets": [
    "text"
  ],
  "isTokenGated": true,
  "receiveCurrency": "matic",
  "name": "text",
  "image": "text",
  "paymentMethod": "pix",
  "checkingAccount": "text",
  "whitelistEndDate": "2025-05-18T12:55:04.924Z",
  "expiresAt": "2025-05-18T12:55:04.924Z",
  "redirectTo": "text",
  "active": true
}
201Success
No content
patch
Authorizations
Path parameters
idstringRequired
Body
productTypestring · enumOptional

Type of product being sold

Possible values:
pricenumberOptional

Price in cents of the product being sold

receiveCurrencystring · enumOptional

Type of currency in which the payment will be received

Possible values:
namestringOptional

Name of the product being sold

imagestring | nullableOptional

Image of the product being sold

paymentMethodstring · enumOptional

Payment method of the link

Possible values:
checkingAccountstringOptional

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

whitelistEndDatestring · date-time | nullableOptional

Date on which the whitelist will end

redirectTostring | nullableOptional

Url to which the link will redirect to

activebooleanOptional

Status of the payment link

Responses
200Success
patch
PATCH /api/v1/payment-link/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "productType": "product",
  "price": 1,
  "receiveCurrency": "matic",
  "name": "text",
  "image": "text",
  "paymentMethod": "pix",
  "checkingAccount": "text",
  "whitelistEndDate": "2025-05-18T12:55:04.924Z",
  "redirectTo": "text",
  "active": true
}
200Success
No content