Payment Intent API
Initiates a new payment intent for processing one-time or recurring payments across blockchain networks.
Authorizations
Body
payment_typestring · enumOptionalDefault:
The payment intent type
one-time
Possible values: routing_prioritystring · enumOptionalDefault:
Routing strategy for cross-chain payments
AUTO
Possible 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
201
Payment intent created successfully
application/json
400
Invalid request parameters
application/json
401
Missing or invalid API key
application/json
500
Internal server error occurred. Please include the requestId when contacting Paygrid team.
application/json
post
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": "AUTO",
"operator_data": {
"id": "text",
"operator": "text",
"authorized_delegates": [
"text"
],
"treasury": "text",
"fee_bps": 0,
"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": "PROCESSING",
"blockchain_metadata": {
"payment_gateway_proxy": "text",
"transaction": {
"src_transaction_hash": "text",
"dst_transaction_hash": "text",
"tracking_link": "https://example.com"
}
},
"createdAt": "2025-06-23T03:35:52.166Z",
"updatedAt": "2025-06-23T03:35:52.166Z",
"payment_type": "one-time",
"routing_priority": "AUTO",
"operator_data": {
"id": "text",
"operator": "text",
"authorized_delegates": [
"text"
],
"treasury": "text",
"fee_bps": 0,
"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"
}
}
Retrieves a paginated list of payment intents
Authorizations
Query parameters
pageinteger · min: 1OptionalDefault:
Page number (starts from 1)
1
limitinteger · min: 1 · max: 100OptionalDefault:
Items per page (max 100)
10
Responses
200
List of payment intents
application/json
get
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": "PROCESSING",
"blockchain_metadata": {
"payment_gateway_proxy": "text",
"transaction": {
"src_transaction_hash": "text",
"dst_transaction_hash": "text",
"tracking_link": "https://example.com"
}
},
"createdAt": "2025-06-23T03:35:52.166Z",
"updatedAt": "2025-06-23T03:35:52.166Z",
"payment_type": "one-time",
"routing_priority": "AUTO",
"operator_data": {
"id": "text",
"operator": "text",
"authorized_delegates": [
"text"
],
"treasury": "text",
"fee_bps": 0,
"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
}
}
Retrieves detailed information about a specific payment intent
Authorizations
Path parameters
payment_idstring · uuidRequired
Responses
200
Payment intent details
application/json
404
Payment intent not found
application/json
get
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": "PROCESSING",
"blockchain_metadata": {
"payment_gateway_proxy": "text",
"transaction": {
"src_transaction_hash": "text",
"dst_transaction_hash": "text",
"tracking_link": "https://example.com"
}
},
"createdAt": "2025-06-23T03:35:52.166Z",
"updatedAt": "2025-06-23T03:35:52.166Z",
"payment_type": "one-time",
"routing_priority": "AUTO",
"operator_data": {
"id": "text",
"operator": "text",
"authorized_delegates": [
"text"
],
"treasury": "text",
"fee_bps": 0,
"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"
}
}
Last updated