Payment Intent API

Initiate a new payment intent

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

POSThttps://api-core.paygrid.co/v1/payments

Authorization

Body

payment_typeenum

The payment intent type

one-timerecurring

routing_priorityenum

Routing strategy for cross-chain payments

COSTSPEEDBALANCEDAUTO

operator_data*object

amount*integer

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

source*object

destination*object

scheduleobject

The payment schedule for recurring payments

processing_dateinteger (unix-timestamp)

Future processing timestamp, required for scheduled payments

expiration_dateinteger (unix-timestamp)

Signature expiration timestamp, must match permit2 deadline

authorizations*object

processing_feesobject

payment_referencestring

External reference for payment reconciliation and tracking

metadataobject

Generic JSON key-value metadata about the payment workflow

Response

Payment intent created successfully

Body

id*string (uuid)

Unique identifier for the payment intent

status*enum

Current status of the payment

RELEASED_TO_GATEWAYPROCESSINGSCHEDULEDCOMPLETEDFAILEDREJECTEDCANCELLED

blockchain_metadataobject

createdAt*string (date-time)

Timestamp when the payment record was created

updatedAt*string (date-time)

Timestamp when the payment record was last updated

payment_typeenum

The payment intent type

one-timerecurring

routing_priorityenum

Routing strategy for cross-chain payments

COSTSPEEDBALANCEDAUTO

operator_dataOperatorData (object)

amountinteger

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

sourcePaymentSource (object)

destinationPaymentDestination (object)

schedulePaymentSchedule (object)

processing_dateinteger (unix-timestamp)

Future processing timestamp, required for scheduled payments

expiration_dateinteger (unix-timestamp)

Signature expiration timestamp, must match permit2 deadline

authorizationsPaymentAuthorizations (object)

processing_feesProcessingFees (object)

payment_referencestring

External reference for payment reconciliation and tracking

metadataobject

Generic JSON key-value metadata about the payment workflow

Request

const response = await fetch('https://api-core.paygrid.co/v1/payments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "operator_data": {
        "id": "text",
        "operator": "text",
        "treasury": "text"
      },
      "amount": 0,
      "source": {
        "from_account": "text",
        "network_id": "ETHEREUM",
        "payment_token": "text"
      },
      "destination": {
        "to_account": "text",
        "network_id": "ETHEREUM",
        "payment_token": "text"
      },
      "authorizations": {
        "permit2_permit": {
          "signature": "text",
          "nonce": "text",
          "deadline": 0
        }
      }
    }),
});
const data = await response.json();

Response

{
  "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-01-15T08:57:45.007Z",
  "updatedAt": "2025-01-15T08:57:45.007Z",
  "payment_type": "one-time",
  "routing_priority": "COST",
  "operator_data": {
    "id": "text",
    "operator": "text",
    "authorized_delegates": [
      "text"
    ],
    "treasury": "text",
    "fee_bps": 0,
    "webhook_url": "https://example.com"
  },
  "amount": 0,
  "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": 0,
    "iterations": 0,
    "start_date": 0,
    "end_date": 0,
    "completed_iterations": 0,
    "next_execution_date": 0
  },
  "processing_date": 0,
  "expiration_date": 0,
  "authorizations": {
    "p2_signature": "text",
    "initial_permit": "text",
    "nonce": "text",
    "deadline": 0
  },
  "processing_fees": {
    "corridor_fees": "10.50",
    "charge_bearer": "OPERATOR"
  },
  "payment_reference": "text"
}

List all payment intents

Retrieves a paginated list of payment intents

GEThttps://api-core.paygrid.co/v1/payments

Authorization

Query parameters

Response

List of payment intents

Body

dataarray of PaymentIntentResponse (object)

paginationobject

Request

const response = await fetch('https://api-core.paygrid.co/v1/payments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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-01-15T08:57:45.007Z",
      "updatedAt": "2025-01-15T08:57:45.007Z",
      "payment_type": "one-time",
      "routing_priority": "COST",
      "operator_data": {
        "id": "text",
        "operator": "text",
        "authorized_delegates": [
          "text"
        ],
        "treasury": "text",
        "fee_bps": 0,
        "webhook_url": "https://example.com"
      },
      "amount": 0,
      "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": 0,
        "iterations": 0,
        "start_date": 0,
        "end_date": 0,
        "completed_iterations": 0,
        "next_execution_date": 0
      },
      "processing_date": 0,
      "expiration_date": 0,
      "authorizations": {
        "p2_signature": "text",
        "initial_permit": "text",
        "nonce": "text",
        "deadline": 0
      },
      "processing_fees": {
        "corridor_fees": "10.50",
        "charge_bearer": "OPERATOR"
      },
      "payment_reference": "text"
    }
  ],
  "pagination": {
    "total": 0,
    "page": 0,
    "limit": 0,
    "pages": 0
  }
}

Get payment intent details

Retrieves detailed information about a specific payment intent

GEThttps://api-core.paygrid.co/v1/payments/{payment_id}

Authorization

Path parameters

payment_id*string (uuid)

Response

Payment intent details

Body

id*string (uuid)

Unique identifier for the payment intent

status*enum

Current status of the payment

RELEASED_TO_GATEWAYPROCESSINGSCHEDULEDCOMPLETEDFAILEDREJECTEDCANCELLED

blockchain_metadataobject

createdAt*string (date-time)

Timestamp when the payment record was created

updatedAt*string (date-time)

Timestamp when the payment record was last updated

payment_typeenum

The payment intent type

one-timerecurring

routing_priorityenum

Routing strategy for cross-chain payments

COSTSPEEDBALANCEDAUTO

operator_dataOperatorData (object)

amountinteger

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

sourcePaymentSource (object)

destinationPaymentDestination (object)

schedulePaymentSchedule (object)

processing_dateinteger (unix-timestamp)

Future processing timestamp, required for scheduled payments

expiration_dateinteger (unix-timestamp)

Signature expiration timestamp, must match permit2 deadline

authorizationsPaymentAuthorizations (object)

processing_feesProcessingFees (object)

payment_referencestring

External reference for payment reconciliation and tracking

metadataobject

Generic JSON key-value metadata about the payment workflow

Request

const response = await fetch('https://api-core.paygrid.co/v1/payments/{payment_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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-01-15T08:57:45.007Z",
  "updatedAt": "2025-01-15T08:57:45.007Z",
  "payment_type": "one-time",
  "routing_priority": "COST",
  "operator_data": {
    "id": "text",
    "operator": "text",
    "authorized_delegates": [
      "text"
    ],
    "treasury": "text",
    "fee_bps": 0,
    "webhook_url": "https://example.com"
  },
  "amount": 0,
  "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": 0,
    "iterations": 0,
    "start_date": 0,
    "end_date": 0,
    "completed_iterations": 0,
    "next_execution_date": 0
  },
  "processing_date": 0,
  "expiration_date": 0,
  "authorizations": {
    "p2_signature": "text",
    "initial_permit": "text",
    "nonce": "text",
    "deadline": 0
  },
  "processing_fees": {
    "corridor_fees": "10.50",
    "charge_bearer": "OPERATOR"
  },
  "payment_reference": "text"
}

PreviousAuthentication NextCorridor Pricing API

Last updated 6 days ago

{ "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-01-15T08:57:45.007Z", "updatedAt": "2025-01-15T08:57:45.007Z", "payment_type": "one-time", "routing_priority": "COST", "operator_data": { "id": "text", "operator": "text", "authorized_delegates": [ "text" ], "treasury": "text", "fee_bps": 0, "webhook_url": "https://example.com" }, "amount": 0, "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": 0, "iterations": 0, "start_date": 0, "end_date": 0, "completed_iterations": 0, "next_execution_date": 0 }, "processing_date": 0, "expiration_date": 0, "authorizations": { "p2_signature": "text", "initial_permit": "text", "nonce": "text", "deadline": 0 }, "processing_fees": { "corridor_fees": "10.50", "charge_bearer": "OPERATOR" }, "payment_reference": "text" } ], "pagination": { "total": 0, "page": 0, "limit": 0, "pages": 0 } }

{ "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-01-15T08:57:45.007Z", "updatedAt": "2025-01-15T08:57:45.007Z", "payment_type": "one-time", "routing_priority": "COST", "operator_data": { "id": "text", "operator": "text", "authorized_delegates": [ "text" ], "treasury": "text", "fee_bps": 0, "webhook_url": "https://example.com" }, "amount": 0, "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": 0, "iterations": 0, "start_date": 0, "end_date": 0, "completed_iterations": 0, "next_execution_date": 0 }, "processing_date": 0, "expiration_date": 0, "authorizations": { "p2_signature": "text", "initial_permit": "text", "nonce": "text", "deadline": 0 }, "processing_fees": { "corridor_fees": "10.50", "charge_bearer": "OPERATOR" }, "payment_reference": "text" }

const response = await fetch('https://api-core.paygrid.co/v1/payments', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "operator_data": { "id": "text", "operator": "text", "treasury": "text" }, "amount": 0, "source": { "from_account": "text", "network_id": "ETHEREUM", "payment_token": "text" }, "destination": { "to_account": "text", "network_id": "ETHEREUM", "payment_token": "text" }, "authorizations": { "permit2_permit": { "signature": "text", "nonce": "text", "deadline": 0 } } }), }); const data = await response.json();