Quickstart

Let's get you started quickly

🔑 Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key is unauthorized.

You can request an API key by filling this form.

💰 Make your first payment

To process your first payment, simply send a request to the payment transactions endpoint and include your API Key as indicated in the example below. This will create and process a new payment transfer.

Process a new payment transaction

POST/v1/transactions/payments

Authorization

bearer

Body

application/json

amount*integer

reference_idstring

fiat_denominationenum

USDEUR

originobject

source*object

destination*object

processing_dateinteger

metadataobject

Response

201

Payment transaction processed successfully.

Request

JavaScriptCurlPython

const response = await fetch('/v1/transactions/payments', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "source": {
        "network_id": 0,
        "payment_token": "text"
      },
      "destination": {
        "network_id": 0,
        "payment_token": "text"
      }
    }),
});
const data = await response.json();

Fetch all payment records (and by transaction hash)

GET/v1/transactions/payments

Authorization

bearer

Query parameters

Response

200404

Payment records retrieved successfully.

Request

JavaScriptCurlPython

const response = await fetch('/v1/transactions/payments', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Retrieve an existing payment record by payment ID

GET/v1/transactions/payments/{payment_id}

Authorization

bearer

Path parameters

payment_id*string

Response

200404

Payment record retrieved successfully.

Request

JavaScriptCurlPython

const response = await fetch('/v1/transactions/payments/{payment_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Take a look at how you might call the payment endpoint using curl:

curl --location 'https://sandbox.paygrid.co/v1/transactions/payments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer [PAYGRID_API_KEY]' \
--data-raw '{
    "amount": 120,
    "source": {
        "network_id": 137,
        "payment_token": "POLYGON_USDC",
        "from_address": "0x0AB796b0Db4333EF2fFaC835a1e05C75E0c119D4"
    },
    "destination": {
        "network_id": 137,
        "payment_token": "POLYGON_USDC",
        "to_address": "0x0AB796b0Db4333EF2fFaC835a1e05C75E0c119D4"
    },
    "reference_id": "INVOICE-LH9876543",
    "fiat_denomination": "USD",
    "metadata": {
        "invoice_id": "invoice-id",
        "payer_details": {
            "email": "[e-mail]",
            "name": "John Doan"
        }
    }
}'

🚀 Management Dashboard

You can manage your developer integrations in the dashboard and, keep track of all payment transactions. Start your registration here Paygrid Dashboard