Payments
List payment requests
Your agent’s payment requests, newest first.
GET
/
v1
/
payment_requests
List payment requests
curl --request GET \
--url https://api.relayapp.im/v1/payment_requests \
--header 'Authorization: Bearer <token>'{
"payment_requests": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "payment_request",
"status": "requested",
"mode": "payment",
"amount": 123,
"currency": "<string>",
"description": "<string>",
"category": "physical_goods",
"checkout_url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"metadata": {},
"stripe": {
"payment_intent_id": "<string>",
"customer_id": "<string>",
"subscription_id": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"image_url": "<string>",
"price_id": "<string>",
"quantity": 123,
"interval": "day",
"interval_count": 123,
"discount": {
"coupon": "<string>",
"promotion_code": "<string>",
"label": "<string>"
},
"paid_at": "2023-11-07T05:31:56Z"
}
],
"next_cursor": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}Authorizations
Bearer token authentication. Include your API token in the Authorization header.
Format: Authorization: Bearer <your-token>
Query Parameters
Required range:
1 <= x <= 100Pagination cursor from the previous response's next_cursor field.
Omit this parameter for the first page of results.
A payment request's lifecycle. It leaves requested exactly once, and only on Stripe's word or your cancel.
Available options:
requested, succeeded, canceled, expired ⌘I
List payment requests
curl --request GET \
--url https://api.relayapp.im/v1/payment_requests \
--header 'Authorization: Bearer <token>'{
"payment_requests": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "payment_request",
"status": "requested",
"mode": "payment",
"amount": 123,
"currency": "<string>",
"description": "<string>",
"category": "physical_goods",
"checkout_url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"metadata": {},
"stripe": {
"payment_intent_id": "<string>",
"customer_id": "<string>",
"subscription_id": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"image_url": "<string>",
"price_id": "<string>",
"quantity": 123,
"interval": "day",
"interval_count": 123,
"discount": {
"coupon": "<string>",
"promotion_code": "<string>",
"label": "<string>"
},
"paid_at": "2023-11-07T05:31:56Z"
}
],
"next_cursor": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}
