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-timeAvailable options:

routing_prioritystring · enumoptional

Routing strategy for cross-chain payments

Default: AUTOAvailable options:

operator_dataobjectrequired

amountinteger · min: 1required

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

sourceobjectrequired

destinationobjectrequired

scheduleobjectoptional

The payment schedule for recurring payments

processing_dateinteger · unix-timestampoptional

Future processing timestamp, required for scheduled payments

expiration_dateinteger · unix-timestampoptional

Signature expiration timestamp, must match permit2 deadline

authorizationsobjectrequired

processing_feesobjectoptional

payment_referencestringoptional

External reference for payment reconciliation and tracking

metadataobjectoptional

Generic JSON key-value metadata about the payment workflow

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api-core.paygrid.co/v1/payments' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

201

400

401

500

201

{
  "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-04T02:02:45.282Z",
  "updatedAt": "2025-04-04T02:02:45.282Z",
  "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"
  }
}

Payment intent created successfully

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api-core.paygrid.co/v1/payments' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

200

{
  "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-04T02:02:45.282Z",
      "updatedAt": "2025-04-04T02:02:45.282Z",
      "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
  }
}

List of payment intents

Get payment intent details

get

Retrieves detailed information about a specific payment intent

Authorizations

Path parameters

payment_idstring · uuidrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api-core.paygrid.co/v1/payments/{payment_id}' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

404

200

{
  "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-04T02:02:45.282Z",
  "updatedAt": "2025-04-04T02:02:45.282Z",
  "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"
  }
}

Payment intent details