Payment Intent API

Initiate a new payment intent

post

Initiates a new payment intent for processing one-time or recurring payments across blockchain networks.

Authorizations

Body

payment_typestring · enumOptional

The payment intent type

Default: one-timePossible values:

routing_prioritystring · enumOptional

Routing strategy for cross-chain payments

Default: AUTOPossible values:

amountinteger · min: 1Required

Gross amount to be transferred in cents, before any fees are applied (e.g., $10.00 = 1000)

processing_dateinteger · unix-timestampOptional

Future processing timestamp, required for scheduled payments

expiration_dateinteger · unix-timestampOptional

Signature expiration timestamp, must match permit2 deadline

payment_referencestringOptional

External reference for payment reconciliation and tracking

Responses

post

HTTPcURLJavaScriptPython

POST /v1/payments HTTP/1.1
Host: api-core.paygrid.co
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 808

{
  "payment_type": "one-time",
  "routing_priority": "COST",
  "operator_data": {
    "id": "text",
    "operator": "text",
    "authorized_delegates": [
      "text"
    ],
    "treasury": "text",
    "fee_bps": 1,
    "webhook_url": "https://example.com"
  },
  "amount": 1,
  "source": {
    "from_account": "text",
    "network_id": "ETHEREUM",
    "payment_token": "text"
  },
  "destination": {
    "to_account": "text",
    "network_id": "ETHEREUM",
    "payment_token": "text"
  },
  "schedule": {
    "interval_unit": "DAY",
    "interval_count": 1,
    "iterations": 1,
    "start_date": 1,
    "end_date": 1
  },
  "processing_date": 1,
  "expiration_date": 1,
  "authorizations": {
    "permit2_permit": {
      "signature": "text",
      "nonce": "text",
      "deadline": 1
    },
    "initial_permit": {
      "signature": "text",
      "nonce": "text",
      "deadline": 1
    }
  },
  "processing_fees": {
    "corridor_fees": "text",
    "charge_bearer": "OPERATOR"
  },
  "payment_reference": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "RELEASED_TO_GATEWAY",
  "blockchain_metadata": {
    "payment_gateway_proxy": "text",
    "transaction": {
      "src_transaction_hash": "text",
      "dst_transaction_hash": "text",
      "tracking_link": "https://example.com"
    }
  },
  "createdAt": "2025-04-25T08:59:24.079Z",
  "updatedAt": "2025-04-25T08:59:24.079Z",
  "payment_type": "one-time",
  "routing_priority": "COST",
  "operator_data": {
    "id": "text",
    "operator": "text",
    "authorized_delegates": [
      "text"
    ],
    "treasury": "text",
    "fee_bps": 1,
    "webhook_url": "https://example.com"
  },
  "amount": 1,
  "source": {
    "from_account": "text",
    "network_id": "ETHEREUM",
    "payment_token": "text"
  },
  "destination": {
    "to_account": "text",
    "network_id": "ETHEREUM",
    "payment_token": "text"
  },
  "schedule": {
    "interval_unit": "DAY",
    "interval_count": 1,
    "iterations": 1,
    "start_date": 1,
    "end_date": 1,
    "completed_iterations": 1,
    "next_execution_date": 1
  },
  "processing_date": 1,
  "expiration_date": 1,
  "authorizations": {
    "p2_signature": "text",
    "initial_permit": "text",
    "nonce": "text",
    "deadline": 1
  },
  "processing_fees": {
    "corridor_fees": "10.50",
    "charge_bearer": "OPERATOR"
  },
  "payment_reference": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

List all payment intents

get

Retrieves a paginated list of payment intents

Authorizations

Query parameters

pageinteger · min: 1Optional

Page number (starts from 1)

Default: 1

limitinteger · min: 1 · max: 100Optional

Items per page (max 100)

Default: 10

Responses

get

HTTPcURLJavaScriptPython

GET /v1/payments HTTP/1.1
Host: api-core.paygrid.co
X-API-KEY: YOUR_API_KEY
Accept: */*

200

List of payment intents

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "RELEASED_TO_GATEWAY",
      "blockchain_metadata": {
        "payment_gateway_proxy": "text",
        "transaction": {
          "src_transaction_hash": "text",
          "dst_transaction_hash": "text",
          "tracking_link": "https://example.com"
        }
      },
      "createdAt": "2025-04-25T08:59:24.079Z",
      "updatedAt": "2025-04-25T08:59:24.079Z",
      "payment_type": "one-time",
      "routing_priority": "COST",
      "operator_data": {
        "id": "text",
        "operator": "text",
        "authorized_delegates": [
          "text"
        ],
        "treasury": "text",
        "fee_bps": 1,
        "webhook_url": "https://example.com"
      },
      "amount": 1,
      "source": {
        "from_account": "text",
        "network_id": "ETHEREUM",
        "payment_token": "text"
      },
      "destination": {
        "to_account": "text",
        "network_id": "ETHEREUM",
        "payment_token": "text"
      },
      "schedule": {
        "interval_unit": "DAY",
        "interval_count": 1,
        "iterations": 1,
        "start_date": 1,
        "end_date": 1,
        "completed_iterations": 1,
        "next_execution_date": 1
      },
      "processing_date": 1,
      "expiration_date": 1,
      "authorizations": {
        "p2_signature": "text",
        "initial_permit": "text",
        "nonce": "text",
        "deadline": 1
      },
      "processing_fees": {
        "corridor_fees": "10.50",
        "charge_bearer": "OPERATOR"
      },
      "payment_reference": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 1,
    "pages": 1
  }
}

Get payment intent details

get

Retrieves detailed information about a specific payment intent

Authorizations

Path parameters

payment_idstring · uuidRequired

Responses

get

HTTPcURLJavaScriptPython

GET /v1/payments/{payment_id} HTTP/1.1
Host: api-core.paygrid.co
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "RELEASED_TO_GATEWAY",
  "blockchain_metadata": {
    "payment_gateway_proxy": "text",
    "transaction": {
      "src_transaction_hash": "text",
      "dst_transaction_hash": "text",
      "tracking_link": "https://example.com"
    }
  },
  "createdAt": "2025-04-25T08:59:24.079Z",
  "updatedAt": "2025-04-25T08:59:24.079Z",
  "payment_type": "one-time",
  "routing_priority": "COST",
  "operator_data": {
    "id": "text",
    "operator": "text",
    "authorized_delegates": [
      "text"
    ],
    "treasury": "text",
    "fee_bps": 1,
    "webhook_url": "https://example.com"
  },
  "amount": 1,
  "source": {
    "from_account": "text",
    "network_id": "ETHEREUM",
    "payment_token": "text"
  },
  "destination": {
    "to_account": "text",
    "network_id": "ETHEREUM",
    "payment_token": "text"
  },
  "schedule": {
    "interval_unit": "DAY",
    "interval_count": 1,
    "iterations": 1,
    "start_date": 1,
    "end_date": 1,
    "completed_iterations": 1,
    "next_execution_date": 1
  },
  "processing_date": 1,
  "expiration_date": 1,
  "authorizations": {
    "p2_signature": "text",
    "initial_permit": "text",
    "nonce": "text",
    "deadline": 1
  },
  "processing_fees": {
    "corridor_fees": "10.50",
    "charge_bearer": "OPERATOR"
  },
  "payment_reference": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}