Create Payment
POST {{baseUrl}}/payments?order_reference={{reservation_reference}}
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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
order_reference | string | 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. | |
booking_reference | string | (ADVANCED) In case a booking_reference is provided, a partial payment will be registered. Only the specified booking will be paid. |
Request Body
{"data"=>{"payment"=>{"payment_object_type"=>"MANUAL", "payment_merchant_reference"=>"TEST_PAYMENT", "payment_external_reference"=>"SHOPPER_REF", "payment_contact"=>{"contact_name_first"=>"{{$randomFirstName}}", "contact_name_last"=>"{{$randomLastName}}", "contact_email"=>"{{$randomExampleEmail}}"}, "payment_method"=>"CASH"}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: Created
{"api_version":"3.4.0","data":{"kind":"currency","payment":{"payment_details":{"payment_currency_code":"EUR","payment_merchant_reference":"1478349849927_771663371","payment_method":"EXTERNAL","payment_status":"PAID","payment_type":"CAPTURE","payment_external_reference":"SHOPPER_REFERENCE","payment_order_reference":"ORDRREF123456","payment_scheme":"VISA","payment_recurring_type":"STORE","payment_refund_type":"SYSTEM","payment_refund_reason":"Guest reimbursement","payment_currency_rate":"2.5263","payment_gateway_details":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"payment_contact":{"contact_uid":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_external_uid":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_title":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_name_first":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_name_last":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_phone":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_mobile":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_language":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_nationality":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_flight_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_loyalty_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_birth_place":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_birth_date":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_passport":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_gender":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_age":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_room_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_website":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_classification":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_address":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_notes":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_custom_fields":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"payment_notes":[{"note_creator":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"note_date":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"note_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"note_value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"note_creator":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"note_date":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"note_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"note_value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]},"payment_object_type":"MANUAL","payment_result_code":"Authorised","payment_action":{},"payment_refusal_reason":"Not enough balance"}}}