Payments
Get a payment by id
Introduction
API Reference
- Auth
- Events
- ListRates
- Lists
- Locations
- Organizations
- Payments
- TicketRates
- Tickets
- Webhook Endpoints
Webhooks
- Introduction
- Events
Payments
Get a payment by id
Get a payment by id
GET
/
payments
/
{id}
curl --request GET \
--url https://channels-service-alpha.fourvenues.com/payments/{id} \
--header 'X-Api-Key: <api-key>'{
"data": {
"_id": "abcdefghi1234567890",
"status": "pending",
"rate_id": "abcdefghi1234567890",
"organization_id": "abcdefghi1234567890",
"event_id": "abcdefghi1234567890",
"resource_type": "ticket",
"resource_ids": [
"abcdefghi1234567890"
],
"total": {
"amount": 20.6,
"fees": 0.6
},
"send_resources": true,
"metadata": {
"user_id": "abcdefghi1234567890",
"internal_id": "abcdefghi1234567890"
},
"currency": "EUR",
"paid_at": "2023-12-31T00:00:00.000Z",
"expires_at": "2024-01-01T00:00:00.000Z"
},
"success": true
}Authorizations
Path Parameters
The id of the payment to retrieve.
Response
200
application/json
OK
Unique identifier of the payment.
Example:
"abcdefghi1234567890"
Status of the payment.
Example:
"pending"
Unique identifier for the ticket rate.
Example:
"abcdefghi1234567890"
Unique identifier for the organization.
Example:
"abcdefghi1234567890"
Unique identifier for the organization.
Example:
"abcdefghi1234567890"
Resource bought.
Available options:
ticket, name-change, list, pass, plan, booking Example:
"ticket"
Unique identifier for the resources.
Currency used for total.
Example:
"EUR"
Date that should be displayed as the date the payment was made.
Example:
"2023-12-31T00:00:00.000Z"
Expiration date of for the payment.
Example:
"2024-01-01T00:00:00.000Z"
If the resources (tickets, passes, etc) should be sent to the user (via email, sms, whatsapp, etc) by Fourvenues.
Example:
true
Metadata passed by the API client to be stored in the payment. Max 1kb.
Example:
{
"user_id": "abcdefghi1234567890",
"internal_id": "abcdefghi1234567890"
}
curl --request GET \
--url https://channels-service-alpha.fourvenues.com/payments/{id} \
--header 'X-Api-Key: <api-key>'{
"data": {
"_id": "abcdefghi1234567890",
"status": "pending",
"rate_id": "abcdefghi1234567890",
"organization_id": "abcdefghi1234567890",
"event_id": "abcdefghi1234567890",
"resource_type": "ticket",
"resource_ids": [
"abcdefghi1234567890"
],
"total": {
"amount": 20.6,
"fees": 0.6
},
"send_resources": true,
"metadata": {
"user_id": "abcdefghi1234567890",
"internal_id": "abcdefghi1234567890"
},
"currency": "EUR",
"paid_at": "2023-12-31T00:00:00.000Z",
"expires_at": "2024-01-01T00:00:00.000Z"
},
"success": true
}