🔗Payment Links

Generate a URL — to share with customers or clients — to accept a crypto payment using an iFrame, redirect, or standalone webpage

Create a Payment Link

From your account, navigate to the Payment Links section. Once there, click the "Create Payment Link" button in the top right. Then simply fill out the information for the payment:

• Name: The payment title that will be visible to customers using the payment link.

• Internal Note (Notes): This field will not be visible to end-customers, and can be used as an internal note for any purpose.

• Image (Optional): An image/icon that will be visible to customers using the payment link, and when receiving payment completed emails.

• Currency: The fiat currency to be displayed on the payment link

  • Note: You can select any fiat currency when creating a payment link; however, your Swapped Commerce account will only denominate in 1 base fiat currency. For example, you can create payment links in 20+ currencies, but you'll only be able to settle and withdraw 1 single fiat currency.

• Amount: The amount of fiat currency to charge a customer.

Notes

Sandbox

If you wish to test a payment link, add testMode: true to the request body data. Then visit the URL and proceed with a test payment. You will still receive webhooks in this mode.

Autofill Customer Data

If you have your customers name or email, autofill it in the metadata.customerName or metadata.customerEmail fields. Then when a customer visits the URL, they can skip this step in the payment.

Default Payment Cryptocurrency

To define the preferred cryptocurrency your end-customer will view when they load the payment link. For example, to set the default cryptocurrency as USDT on Tron add this to your request:

  "purchase": {
     ...
  },
  "preferredPayCurrency": {
    "symbol": "USDT",
    "blockchain": "Tron"
  }
}

Generate a Payment Link via API

Create an order

post

Create a payment order

Authorizations

apiKey

X-API-KeystringRequired

Body

application/json

testModebooleanOptionalDefault: false

Responses

200

Successful

*/*

post

/v1/orders

HTTPcURLJavaScriptPython

POST /v1/orders HTTP/1.1
Host: pay-api.swapped.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 358

{
  "purchase": {
    "name": "text",
    "description": "text",
    "notes": "text",
    "imageUrl": "text",
    "price": "text",
    "currency": "USD"
  },
  "metadata": {
    "externalId": "text",
    "customerId": "text",
    "customerCountry": "text",
    "customerName": "text",
    "customerLang": "text",
    "customerEmail": "text",
    "redirectUrl": "text"
  },
  "testMode": false,
  "preferredPayCurrency": {
    "symbol": "text",
    "blockchain": "text"
  }
}

200

Successful

{
  "data": {
    "order": {
      "id": "text",
      "externalId": "text",
      "link": "text",
      "userId": "text",
      "customerId": "text",
      "merchant": {
        "id": "text"
      },
      "quote": {
        "fromAmount": {
          "amount": "text",
          "currency": {
            "id": "text",
            "symbol": "text",
            "precision": 1,
            "type": "FIAT",
            "flows": [
              "PAYMENT"
            ],
            "blockchain": {
              "id": "text",
              "name": "text"
            }
          }
        },
        "toAmount": {
          "amount": "text",
          "currency": {
            "id": "text",
            "symbol": "text",
            "precision": 1,
            "type": "FIAT",
            "flows": [
              "PAYMENT"
            ],
            "blockchain": {
              "id": "text",
              "name": "text"
            }
          }
        },
        "exchangeRateSnapshotId": "text",
        "fees": [
          {
            "id": "text",
            "type": "text",
            "label": "text",
            "amount": "text",
            "currency": {
              "id": "text",
              "symbol": "text",
              "precision": 1,
              "type": "text"
            },
            "createdAt": "text"
          }
        ]
      },
      "depositAddress": {
        "id": "text",
        "address": "text",
        "available": true,
        "memo": "text",
        "supportedCurrencies": [
          {
            "name": "text",
            "officialId": "text",
            "type": "FIAT",
            "symbol": "text",
            "precision": 1,
            "flows": [
              "PAYMENT"
            ],
            "blockchain": {
              "id": "text",
              "name": "text"
            },
            "blockchainId": "text",
            "isStablecoin": true,
            "decimals": 1,
            "isNative": true,
            "id": "text"
          }
        ]
      },
      "initType": "STANDARD",
      "emailReceiptSent": true,
      "emailReceiptSentAt": "text",
      "createdAt": "text",
      "expiresAt": "text",
      "status": "PENDING_USER_CREATION",
      "test": false,
      "purchase": {
        "id": "text",
        "name": "text",
        "notes": "text",
        "imageUrl": "text",
        "price": "text",
        "currency": {
          "name": "text",
          "officialId": "text",
          "type": "FIAT",
          "symbol": "text",
          "precision": 1,
          "flows": [
            "PAYMENT"
          ],
          "blockchain": {
            "id": "text",
            "name": "text"
          },
          "blockchainId": "text",
          "isStablecoin": true,
          "decimals": 1,
          "isNative": true,
          "id": "text"
        },
        "rateMerchantOverOrder": "text"
      },
      "payments": [
        {
          "id": "text",
          "orderId": "text",
          "receivedAmount": "text",
          "receivedCurrency": {
            "name": "text",
            "officialId": "text",
            "type": "FIAT",
            "symbol": "text",
            "precision": 1,
            "flows": [
              "PAYMENT"
            ],
            "blockchain": {
              "id": "text",
              "name": "text"
            },
            "blockchainId": "text",
            "isStablecoin": true,
            "decimals": 1,
            "isNative": true,
            "id": "text"
          },
          "txHash": "text",
          "confirmedAt": "text",
          "status": "text",
          "createdAt": "text",
          "depositAddress": {
            "id": "text",
            "address": "text",
            "available": true,
            "memo": "text",
            "supportedCurrencies": [
              {
                "name": "text",
                "officialId": "text",
                "type": "FIAT",
                "symbol": "text",
                "precision": 1,
                "flows": [
                  "PAYMENT"
                ],
                "blockchain": {
                  "id": "text",
                  "name": "text"
                },
                "blockchainId": "text",
                "isStablecoin": true,
                "decimals": 1,
                "isNative": true,
                "id": "text"
              }
            ]
          },
          "sourceAddress": "text",
          "fireblocksTxId": "text"
        }
      ],
      "paymentRoute": {
        "id": "text",
        "externalId": "text",
        "address": "text",
        "memo": "text"
      },
      "updates": [
        {
          "id": "text",
          "message": "text",
          "entityType": "text",
          "authorId": "text",
          "metadata": {},
          "timestamp": "text"
        }
      ],
      "metadata": {
        "externalId": "text",
        "customerId": "text",
        "customerName": "text",
        "customerLang": "text",
        "customerCountry": "text",
        "customerEmail": "text",
        "redirectUrl": "text"
      },
      "settlements": [
        {
          "id": "text",
          "type": "text",
          "status": "text"
        }
      ],
      "fees": [
        {
          "id": "text",
          "label": "text",
          "type": "SWAPPED_COLLECT",
          "amount": "text",
          "currency": {
            "id": "text",
            "symbol": "text",
            "precision": 1,
            "type": "FIAT",
            "flows": [
              "PAYMENT"
            ],
            "blockchain": {
              "id": "text",
              "name": "text"
            }
          },
          "needsCollection": true,
          "createdAt": "text"
        }
      ],
      "preferredPayCurrency": {
        "name": "text",
        "officialId": "text",
        "type": "FIAT",
        "symbol": "text",
        "precision": 1,
        "flows": [
          "PAYMENT"
        ],
        "blockchain": {
          "id": "text",
          "name": "text"
        },
        "blockchainId": "text",
        "isStablecoin": true,
        "decimals": 1,
        "isNative": true,
        "id": "text"
      }
    }
  },
  "message": "text",
  "success": true
}