Payments
Capture payments
Manage and settle payments using the API.
Not applicable to B2B resellers / purchases (Indirect sales / SettlementType:EXTERNAL
).
This API is called to list all payments in your account.
[FILTER] on order_reference
. You can also pass the reservation_reference
in this field.
ORDRREF123456
[FILTER] on payment_id
.
de1829d0-e144-11ea-bc09-f935c77bef95
[FILTER] on payment_merchant_reference
.
3fa85f64-5717-4562-b3fc-2c963f66afa6
[FILTER] on payment_service_provider_reference
.
3fa85f64-5717-4562-b3fc-2c963f66afa6
[FILTER] on payment_external_reference
.
SHOPPER_REFERENCE
[PAGING] Items Per Page - Allows user's to configure the items_per_page
value. For example, to load 100 items per page, the developer may point the user to a url with the query string ?items_per_page=100.
This parameter is mainly usefull to manage response times, higher values result in longer response times and therefore it is recommended to keep this value as low as possible. We do allow to adjust this value so it can be used to batch/cache/update inventory at once.
Clients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the items_per_page
response element in calculating actual page size.
10
Example: 5
[PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200.
1
Example: 1
[PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items.
This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The page_index
and total_pages
properties are used for this style of paging.
1
Example: 1
[CACHE] The If-Modified-Since
request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date.
If the resource has not been modified since, the response will be a 304 without any body; the Last-Modified
response header of a previous request will contain the date of last modification.
Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.
Wed, 21 Jan 2022 07:28:00 GMT
Get Payments Response
Not Modified
The HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a If-None-Match
or a If-Modified-Since
header.
Invalid Request
The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
Authentication Failed
The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.
Forbidden
The request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the scope
attribute with the scope necessary to access the protected resource.
Method Not Allowed
The HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.
A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.
Not Acceptable
The HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.
Unprocessable Entity
The HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.
Too Many Requests
The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").
Internal Server Error
The HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
Not Implemented
The HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.
The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).
Bad Gateway
The HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.
The HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system.
Service Unavailable
The HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.
The HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.
Gateway Timeout
The HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.
The HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system.
GET /v3.8/distributor/payments HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"api_version": "3.8.0",
"data": {
"kind": "location",
"current_item_count": 10,
"items_per_page": 10,
"start_index": 1,
"total_items": 200,
"page_index": 1,
"total_pages": 20,
"items": [
{
"payment_id": "f44226c0-e142-11ea-86d2-83036af9991e",
"payment_original_id": "de1829d0-e144-11ea-bc09-f935c77bef95",
"payment_partner_id": "PAYMENT_PARTNER_ID",
"payment_merchant_reference": "1478349849927_771663371",
"payment_external_reference": "SHOPPER_REFERENCE",
"payment_order_reference": "ORDRREF123456",
"payment_booking_references": [
"BKNGREF123456"
],
"payment_order_version": 2,
"payment_status": "PAID",
"payment_method": "EXTERNAL",
"payment_scheme": "VISA",
"payment_type": "CAPTURE",
"payment_link": "https://customer.prioticket.com/s?q=K0U2VmVNRGo0SEhGdFVUZ09IK2ViZkdtK1NjPQ==",
"payment_link_expires_at": "2025-08-05T13:02:36.637Z",
"payment_recurring": false,
"payment_recurring_type": "STORE",
"payment_refund_type": "SYSTEM",
"payment_refund_reason": "Guest reimbursement",
"payment_currency_code": "EUR",
"payment_currency_rate": "2.5263",
"payment_currency_amount": "10.25",
"payment_amount": "10.00",
"payment_total": "100.00",
"payment_gateway_details": {
"payment_merchant_account_name": "PrioticketECOM",
"payment_service_provider_reference": "852596799876396F",
"payment_service_provider_original_reference": "882596799845511E",
"payment_gateway_type": "ADYEN",
"payment_gateway_additional_values": {
"psp_shopper_name": "Checkout Shopper PlaceHolder",
"psp_shopper_cardnumber": "1111",
"psp_issuer_country": "NL",
"psp_fraudscore": "63",
"psp_payment_status": "Settled"
}
},
"payment_contact": {
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "[email protected]",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-08-05",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-08-05T13:02:36.637Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "[email protected]",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-08-05T13:02:36.637Z",
"contact_modified": "2025-08-05T13:02:36.637Z"
},
"payment_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-08-05T13:02:36.637Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "[email protected]",
"note_creator_user_role": "Supervisor"
}
],
"payment_created": "2025-08-05T13:02:36.637Z",
"payment_created_name": "Cashier Name",
"payment_created_email": "[email protected]"
}
]
}
}
This API is called to initiate a payment on a Prio connected PSP or to settle a manual payment. This is a required step if SettlementType:DIRECT
.
Only applicable to guest payments. Not applicable to B2B resellers (Indirect sales /
SettlementType:EXTERNAL
).Once a payment has been made you are unable to amend the reservation.
If only a order_reference
is provided, a full payment will be registered and all bookings will be automatically paid. You can also pass the reservation_reference
in this field.
ORDRREF123456
(ADVANCED) In case a booking_reference
is provided, a partial payment will be registered. Only the specified booking will be paid.
["BOOKING_REFERENCE_123"]
Create payment request model.
Represents the version of the service API that's served in the response.
3.8.0
Make Payment Response
Payment initiated, result will be notified on the set return_url
.
Invalid Request
The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
Authentication Failed
The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.
Forbidden
The request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the scope
attribute with the scope necessary to access the protected resource.
Method Not Allowed
The HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.
A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.
Not Acceptable
The HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.
Unprocessable Entity
The HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.
Too Many Requests
The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").
Internal Server Error
The HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
Not Implemented
The HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.
The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).
Bad Gateway
The HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.
The HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system.
Service Unavailable
The HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.
The HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.
Gateway Timeout
The HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.
The HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system.
POST /v3.8/distributor/payments HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164
{
"data": {
"payment": {
"payment_object_type": "MANUAL",
"payment_merchant_reference": "TEST_PAYMENT",
"payment_external_reference": "SHOPPER_REF",
"payment_method": "CASH"
}
}
}
{
"api_version": "3.8.0",
"data": {
"kind": "location",
"payment": {
"payment_object_type": "MANUAL",
"payment_details": {
"payment_id": "914fca40-d71c-11ea-a4c4-05fbb7067802",
"payment_merchant_reference": "TEST_PAYMENT",
"payment_external_reference": "SHOPPER_REF",
"payment_status": "PAID",
"payment_method": "CASH",
"payment_currency_code": "EUR",
"payment_currency_amount": "421.30",
"payment_amount": "500.00",
"payment_total": "500.00",
"payment_contact": {
"contact_name_first": "Ladarius",
"contact_name_last": "Barton",
"contact_email": "[email protected]"
},
"payment_created": "2020-08-05T15:07:08+02:00",
"payment_created_name": "Demo Cashier",
"payment_created_email": "[email protected]"
}
}
}
}
This API is called to Cancel / Refund your payment. Only use this API to cancel a payment in progress, e.g. a payment initiated on a payment terminal, or to refund a payment without cancelling the order.
In case you would like to cancel AND refund you can simply call the Cancel Reservation or the Cancel Order API (payment_refund:true
) which will refund the payment automatically (also upon auto-cancellation due to reservation expiry). Any card authorizations or blocks will be released as well.
Either the order_reference
, booking_reference
, product_type_transaction_id
, payment_id
, payment_merchant_reference
or payment_service_provider_reference
is required to identify the payment(s) to refund. If provided, only the matching payment(s) will be refunded.
A unique order / reservation reference. If provided, all payments linked to this order will be refunded.
ORDRREF123456
(ADVANCED) In case a booking_reference
is provided, a partial refund will be registered. Only the specified booking will be refunded.
["BOOKING_REFERENCE_123"]
(ADVANCED) In case the product_type_transaction_id
is provided, a partial refund will be made. Only the specified transaction(s) will be refunded.
["159118380521834001"]
Unique Payment ID set by the Prio system. This is an internal identifier.
de1829d0-e144-11ea-bc09-f935c77bef95
Unique (external) payment reference set by the merchant / (third) party / POS system initiating the payment.
1478349849927_771663371
Reference set by payment service provider
852596799876396F
Refund reason.
Guest reimbursement
Payment Cancelled / Refunded
Invalid Request
The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
Authentication Failed
The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.
Forbidden
The request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the scope
attribute with the scope necessary to access the protected resource.
Method Not Allowed
The HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.
A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.
Not Acceptable
The HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.
Conflict
The HTTP 409 Conflict response status code indicates a request conflict with current state of the server.
Conflicts are most likely to occur in response to a PUT request. For example, you may get a 409 response when trying to pay an order which is already cancelled on the server, resulting in a version control conflict.
Unprocessable Entity
The HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.
Too Many Requests
The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").
Internal Server Error
The HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
Not Implemented
The HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.
The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).
Bad Gateway
The HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.
The HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system.
Service Unavailable
The HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.
The HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.
Gateway Timeout
The HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.
The HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system.
DELETE /v3.8/distributor/payments HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"api_version": "3.8.0",
"data": {
"kind": "location",
"payment": {
"payment_id": "f44226c0-e142-11ea-86d2-83036af9991e",
"payment_original_id": "de1829d0-e144-11ea-bc09-f935c77bef95",
"payment_partner_id": "PAYMENT_PARTNER_ID",
"payment_merchant_reference": "1478349849927_771663371",
"payment_external_reference": "SHOPPER_REFERENCE",
"payment_order_reference": "ORDRREF123456",
"payment_booking_references": [
"BKNGREF123456"
],
"payment_order_version": 2,
"payment_status": "PAID",
"payment_method": "EXTERNAL",
"payment_scheme": "VISA",
"payment_type": "CAPTURE",
"payment_link": "https://customer.prioticket.com/s?q=K0U2VmVNRGo0SEhGdFVUZ09IK2ViZkdtK1NjPQ==",
"payment_link_expires_at": "2025-08-05T13:02:36.637Z",
"payment_recurring": false,
"payment_recurring_type": "STORE",
"payment_refund_type": "SYSTEM",
"payment_refund_reason": "Guest reimbursement",
"payment_currency_code": "EUR",
"payment_currency_rate": "2.5263",
"payment_currency_amount": "10.25",
"payment_amount": "10.00",
"payment_total": "100.00",
"payment_gateway_details": {
"payment_merchant_account_name": "PrioticketECOM",
"payment_service_provider_reference": "852596799876396F",
"payment_service_provider_original_reference": "882596799845511E",
"payment_gateway_type": "ADYEN",
"payment_gateway_additional_values": {
"psp_shopper_name": "Checkout Shopper PlaceHolder",
"psp_shopper_cardnumber": "1111",
"psp_issuer_country": "NL",
"psp_fraudscore": "63",
"psp_payment_status": "Settled"
}
},
"payment_contact": {
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "[email protected]",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-08-05",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-08-05T13:02:36.637Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "[email protected]",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-08-05T13:02:36.637Z",
"contact_modified": "2025-08-05T13:02:36.637Z"
},
"payment_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-08-05T13:02:36.637Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "[email protected]",
"note_creator_user_role": "Supervisor"
}
],
"payment_created": "2025-08-05T13:02:36.637Z",
"payment_created_name": "Cashier Name",
"payment_created_email": "[email protected]"
}
}
}
This API is called to get available payment methods and configuration from a Prio PSP.
Payment service provider used to process payments.
ADYEN
- Adyen (More info)CYBERSOURCE
- Cybersource (More info)HYPERPAY
- Hyperpay (More info)ADDONPAYMENTS
- Addon Payments (More info)MEWS
- Mews (More info)NGENIUS
- Network International (More info)MULTISAFE
- MultiSafePay (More info)SUMUP
- SumUp Payments (More info)IZETTLE
- iZettle (More info)STRIPE
- Stripe (More info)WORLDPAY
- WorldPay (More info)GOOGLE
- Google Pay (More info)PAYONEER
- Payoneer (More info)SMARTPAY
- Smart Pay (More info)MOKA
- Moka (More info)EXTERNAL
- The payment is settled externally.OTHER
- Payment provider not listed above.NONE
- No payment provider is used.
NONE
Example: ADYEN
Possible values: Order reference.
ORDRREF123456
[FILTER] Return the stored payment methods for a specific (returning) shopper (payment_recurring:true
).
SHOPPER_REFERENCE
Payment Configuration
Invalid Request
The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
Authentication Failed
The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.
Forbidden
The request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the scope
attribute with the scope necessary to access the protected resource.
Method Not Allowed
The HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.
A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.
Not Acceptable
The HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.
Unprocessable Entity
The HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.
Too Many Requests
The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").
Internal Server Error
The HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
Not Implemented
The HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.
The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).
Bad Gateway
The HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.
The HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system.
Service Unavailable
The HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.
The HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.
Gateway Timeout
The HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.
The HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system.
GET /v3.8/distributor/payments/config HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"payment_methods": "{\\\"groups\\\":[{\\\"name\\\":\\\"Credit Card\\\",\\\"types\\\":[\\\"mc\\\",\\\"visa\\\"...",
"payment_origin_key": "pub.v2.99...",
"payment_origin_domain": "https://www.your-company.com"
}
This API allows to sent a payment email.
Email Recipient rules:
If set, we sent to the first
contact_type:PAYMENT
.Otherwise, if set, we sent to the first
contact_type:BOOKER
.Otherwise, if set, we sent to the first
contact_type:CONTACT
.If none of the above are set, we sent to the first contact in the array.
If no contacts are provided, an error will be returned.
Order reference for which the payment email should be sent. You can also pass the reservation_reference
in this field.
ORDRREF123456
Specific booking reference for which the payment email should be sent.
BOOKINGREF123
Payment email sent
Invalid Request
The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
Authentication Failed
The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.
Forbidden
The request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the scope
attribute with the scope necessary to access the protected resource.
Method Not Allowed
The HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.
A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.
Not Acceptable
The HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.
Unprocessable Entity
The HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.
Too Many Requests
The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").
Internal Server Error
The HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
Not Implemented
The HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.
The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).
Bad Gateway
The HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.
The HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system.
Service Unavailable
The HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.
The HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.
Gateway Timeout
The HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.
The HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system.
POST /v3.8/distributor/payments/email HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
This API allows to submit additional payment details. Only applicable to merchants using the Adyen Marketplace. More Information
A unique identifier got in response of the create payment API.
de1829d0-e144-11ea-bc09-f935c77bef95
Additional details returned by Adyen front-end application.
Successful payment response
Invalid Request
The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
Authentication Failed
The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.
Forbidden
The request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the scope
attribute with the scope necessary to access the protected resource.
Method Not Allowed
The HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.
A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.
Not Acceptable
The HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.
Unprocessable Entity
The HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.
Too Many Requests
The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").
Internal Server Error
The HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
Not Implemented
The HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.
The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).
Bad Gateway
The HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.
The HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system.
Service Unavailable
The HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.
The HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.
Gateway Timeout
The HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.
The HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system.
POST /v3.8/distributor/payments/{payment_id}/details HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"data": "text"
}
{
"api_version": "3.8.0",
"data": {
"kind": "location",
"payment": {
"payment_object_type": "MANUAL",
"payment_result_code": "Authorised",
"payment_action": "{\n \"data\": {\n \"MD\": \"OEVudmZVMUlkWjd0MDNwUWs2bmhSdz09...\",\n \"PaReq\": \"eNpVUttygjAQ/RXbDyAXBYRZ00HpTH3wUosPfe...\",\n \"TermUrl\": \"adyencheckout://your.package.name\"\n },\n \"method\": \"POST\",\n \"paymentData\": \"Ab02b4c0!BQABAgA4e3wGkhVah4CJL19qdegdmm9E...\",\n \"paymentMethodType\": \"scheme\",\n \"type\": \"redirect\",\n \"url\": \"https://test.adyen.com/hpp/3d/validate.shtml\"\n}\n",
"payment_details": {
"payment_id": "f44226c0-e142-11ea-86d2-83036af9991e",
"payment_original_id": "de1829d0-e144-11ea-bc09-f935c77bef95",
"payment_partner_id": "PAYMENT_PARTNER_ID",
"payment_merchant_reference": "1478349849927_771663371",
"payment_external_reference": "SHOPPER_REFERENCE",
"payment_order_reference": "ORDRREF123456",
"payment_booking_references": [
"BKNGREF123456"
],
"payment_order_version": 2,
"payment_status": "PAID",
"payment_method": "EXTERNAL",
"payment_scheme": "VISA",
"payment_type": "CAPTURE",
"payment_link": "https://customer.prioticket.com/s?q=K0U2VmVNRGo0SEhGdFVUZ09IK2ViZkdtK1NjPQ==",
"payment_link_expires_at": "2025-08-05T13:02:36.637Z",
"payment_recurring": false,
"payment_recurring_type": "STORE",
"payment_refund_type": "SYSTEM",
"payment_refund_reason": "Guest reimbursement",
"payment_currency_code": "EUR",
"payment_currency_rate": "2.5263",
"payment_currency_amount": "10.25",
"payment_amount": "10.00",
"payment_total": "100.00",
"payment_gateway_details": {
"payment_merchant_account_name": "PrioticketECOM",
"payment_service_provider_reference": "852596799876396F",
"payment_service_provider_original_reference": "882596799845511E",
"payment_gateway_type": "ADYEN",
"payment_gateway_additional_values": {
"psp_shopper_name": "Checkout Shopper PlaceHolder",
"psp_shopper_cardnumber": "1111",
"psp_issuer_country": "NL",
"psp_fraudscore": "63",
"psp_payment_status": "Settled"
}
},
"payment_contact": {
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "[email protected]",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-08-05",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-08-05T13:02:36.637Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "[email protected]",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-08-05T13:02:36.637Z",
"contact_modified": "2025-08-05T13:02:36.637Z"
},
"payment_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-08-05T13:02:36.637Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "[email protected]",
"note_creator_user_role": "Supervisor"
}
],
"payment_created": "2025-08-05T13:02:36.637Z",
"payment_created_name": "Cashier Name",
"payment_created_email": "[email protected]"
}
}
}
}
Was this helpful?