****** Orders ****** An order is a collection of products or tickets created by a consumer. It is part of our main purchase flow where a consumer adds products to a basket, creates an order from the products in the basket, and pays for the order. Placing a new order =================== Place a new order by defining products, consumer details and some additional data to administer the order. This request can be authenticated using :ref:`basic-auth` or a :ref:`bearer-token`, in addition to a :ref:`cognito-token`. .. _order_request_data: Request data ------------ ========================= ============================================ ================================================= Field name Type Description ========================= ============================================ ================================================= products List of :doc:`/objects/product_selection` List of products with a quantity. Optionally you can provide a ``List`` of :doc:`/objects/ticket_consumer` objects. Note that the length of the list should be equal to the quantity of the products. All products must be part of the same :doc:`event`. tickets :doc:`Ticket ` references List of tickets to transfer to a new order and new owner. All tickets should be part of the same order. You cannot provide both ``products`` and ``tickets`` in a single order. consumer :doc:`Consumer ` A consumer object, describing the information of the consumer for whom the order is being placed. payment_method String The selected payment method. Optional for free orders. shipping_method String or :doc:`/objects/shipping` The selected shipping method uid. Optional. Alternatively, you may provide a :doc:`Consumer` object in case the *delivery* address is different from the *consumer* address. In this case, only address-related fields are required and stored in our system. external_purchases List of :doc:`/objects/external_purchase` A list of external purchases. Optional. external_reference String(32) 32 characters to use as your own reference. Optional. redirect_url String(255) 255 character field for redirecting clients back to your site, this overrides the default redirect_url set in the backoffice. Optional. check_consecutive_seats Boolean Defaults to ``true``. If the event has seating enabled and the value is ``true``, you will receive an ``INSUFFICIENT_CONSECUTIVE_SEATS`` error when there are not enough consecutive seats available and the order will not be created. This ensures that people that want to sit next to each other don't end up in different rows. vouchers List of strings List of voucher codes that open an access to specific sales or provide discounts. currency String (ISO 4217) Currency code (See :doc:`/objects/amount`). Optional. opt_in Boolean Opt-in choice (See :doc:`event`). captcha String Optional captcha token. donation_amount Amount Optional amount to donate. ========================= ============================================ ================================================= Examples -------- .. _create_order_with_products: Create an order from a product selection ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: bash [POST] https://shopping-api.paylogic.com/orders .. code-block:: javascript { "products": [ { "product": "https://shopping-api.paylogic.com/products/12365478654238976585643567854323", "quantity": 3 }, { "product": "https://shopping-api.paylogic.com/products/456ghtr45tg678fe5rf456yhgbvsw3lh", "quantity": 1, "consumer": { "address": "Some street 31", "city": "Some city", "country": "US", "date_of_birth": "1990-01-01", "email": "john.smith@example.com", "first_name": "John", "last_name": "Smith", "gender": 1, "postal_code": "1234", "state": "UT", "language": "en" } } ], "consumer": { "first_name": "John", "last_name": "Doe", "date_of_birth": "1986-12-30", "email": "john.doe@paylogic.eu", "gender": "1", "address": "Nieuwe Boteringestraat 28", "postal_code": "9716 JJ", "city": "Groningen", "country": "NL", "ip": "192.168.1.1" }, "payment_method": "ghr57d5h3gd162fb35c5a3db57ghrydg", "shipping_method": { "uid": "87a5quvndhe162fb357alt872705zr2j", "consumer" : { "first_name": "John", "last_name": "Doe", "email": "john.doe@paylogic.com", "gender": 1, "address": "Some street for shipping 2", "city": "Some other city", "country": "US", "postal_code": "02145", "state": "MA" } }, "external_purchases": [ { "title": { "en": "External purchase" }, "product_reference": "External purchase product A", "quantity": 3, "unit_price": { "currency": "EUR", "amount": 50.00 } } ], "external_reference": "CO-118", "redirect_url": "http://www.example.com/redirect_url/", "check_consecutive_seats": "true" } .. _order-from-basket: Create an order from a basket ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ When you create an order from a basket, the order will inherit all data that was already administered in the basket. All data previously administered in the basket can be overwritten while creating the order. .. code-block:: bash [POST] https://shopping-api.paylogic.com/orders .. code-block:: javascript { "basket": "https://shopping-api.paylogic.com/basket/d2e37ee17474417a87259b02b674da9b", "payment_method": "ghr57d5h3gd162fb35c5a3db57ghrydg", "shipping_method": "87a5quvndhe162fb357alt872705zr2j", } Transfer tickets ~~~~~~~~~~~~~~~~ When transferring tickets, all tickets have to belong to the same order. This request can be authenticated using :ref:`basic-auth`, in addition to an :ref:`order-token` or :ref:`cognito-token`. The Order token or Cognito token must have access to the original order in order to allow a transfer. .. code-block:: bash [POST] https://shopping-api.paylogic.com/orders .. code-block:: javascript { "tickets": [ "https://shopping-api.paylogic.com/tickets/a2e37ee17474417a87259b02b674da9a", "https://shopping-api.paylogic.com/tickets/12365478654238976585643567854323", ], "consumer": { "first_name": "John", "last_name": "Doe", "date_of_birth": "1986-12-30", "email": "john.doe@paylogic.eu", "gender": "1", "address": "Nieuwe Boteringestraat 28", "postal_code": "9716 JJ", "city": "Groningen", "country": "NL", "ip": "192.168.1.1" }, "payment_method": "ghr57d5h3gd162fb35c5a3db57ghrydg", "shipping_method": "87a5quvndhe162fb357alt872705zr2j", } Captcha ------- Placing an order may be rate-limited by the application and a captcha has to be resolved by the consumer. In this case :doc:`storefront` exposes the captcha provider and public key. Example request ~~~~~~~~~~~~~~~ .. code-block:: javascript { "products": [ { "product": "https://shopping-api.paylogic.com/products/12365478654238976585643567854323", "quantity": 3 }, "captcha": "", ... } .. _order-errors: Error types ----------- Error type codes can be used to dispatch the errors on the client side. These errors are related to the order creation. See :ref:`bill errors `. .. TODO: Inline bill errors here. ==================================== =========== ============================================================================================================================================================================================ Type HTTP code Description ==================================== =========== ============================================================================================================================================================================================ FORBIDDEN 403 Forbidden. NOT_FOUND 404 Not found. BAD_REQUEST 400 Bad request. PAYMENT_METHOD_MISSING 400 A payment method is needed for the creation of an order. Please retrieve a bill for the selected products to see which payment methods are available. EMPTY_BASKET 400 You are trying to create an order with no products. CONSUMER_MISSING 400 Not all necessary consumer data was provided. Please check the documentation to see which data to provide. CONSTRAINT_VIOLATION 400 Generic constraint violation. NO_TICKETS_OR_PRODUCTS_PROVIDED 400 No tickets or products provided. BOTH_TICKETS_AND_PRODUCTS_PROVIDED 400 Both tickets or products provided, while only one or the other is allowed. TICKET_ERROR 400 When creating :doc:`/documentation/transfer_approvals`: Ticket or transfer approval is not in a valid state. TICKET_NOT_AVAILABLE 400 Provided ticket is not valid or not found. NO_CONSUMER_URI_OR_INFO_PROVIDED 400 Provided consumer information is not valid, or a consumer is not found. TICKET_CONSUMER_ERROR 400 Ticket consumer information is not valid. INSUFFICIENT_CONSECUTIVE_SEATS 409 There are not enough seats available in the same row. The order has been cancelled. VOUCHER_INVALID 400 Voucher code is invalid. CAPTCHA_INVALID 403 Captcha token is invalid. CAPTCHA_RATE_LIMIT_REACHED 400 Order creation rate limit has been exceeded, please resolve captcha. CAPTCHA_INVALID_DOMAIN 403 Captcha token is resolved for the domain that is not allowed by the application. 10MER 403 With this combination of data, it is not possible to buy tickets for this event. Please contact the Paylogic Customer Service (please supply calling code: 10MER) ==================================== =========== ============================================================================================================================================================================================ .. _get-order: Retrieve a single order ======================= Retrieve the details of a single order using an order reference. Authentication -------------- The retrieval of an order can be authenticated in multiple ways. - :ref:`basic-auth`: The application must have permission to access this order. - :ref:`bearer-token`: The application will have access if it created the order. - :ref:`cognito-token`: The user represented by the token must be the creator of the order. - :ref:`order-token`: The token has to match the order token in our system. Response -------- ==================== =========================================== ======================================================= Field name Type Description ==================== =========================================== ======================================================= uid String A machine readable id for this order, used in communication with the API. reference String A human readable id for this order, used in communication with consumers. external_reference String 32 character field for your own purpose. redirect_url String 255 character field for redirecting clients back to your site, this overrides the default redirect_url set in the backoffice. created_date Datetime The date and time the order was created. status String The status of the order. See :ref:`order-statuses` for the values. product_selection List of :doc:`/objects/product_selection` List of products with a quantity. There is also an optional ``parent`` attribute when combo products are used. consumer :doc:`/objects/order_consumer` An order consumer object, representing the consumer data as provided when placing the order. shipping_consumer :doc:`/objects/shipping_consumer` An order shipping consumer object, representing delivery data as provided when placing the order. payment_method :doc:`/objects/payment_method` The payment method selected when placing the order. payment :doc:`/objects/payment` Information on the order's payment, or null if no payment exists for the order. shipping_method :doc:`/objects/shipping_method` The shipping method selected when placing the order. If none is selected, the key will be included but the value will be an empty object. product_total :doc:`/objects/amount` The total value of all products. service_costs :doc:`/objects/amount` The service costs included by the merchant and Paylogic. grand_total :doc:`/objects/amount` The grand total the consumer has to pay. external_purchases :doc:`/objects/external_purchase` A list of external purchases. legal_info :doc:`/objects/legal_info` Legal information for this order. ==================== =========================================== ======================================================= .. _order-statuses: Order statuses ~~~~~~~~~~~~~~ ============ =========================================================================================================== Status Description ============ =========================================================================================================== pending We are waiting for the payment to arrive. completed The payment has arrived. canceled The order is canceled and no longer valid. ============ =========================================================================================================== Link relations ~~~~~~~~~~~~~~ * ``payment``: (optional) A link to a payment where you can send a user to in order to pay this order. * ``shop:etickets``: (optional) E-ticket download link (in PDF format). Will be available when the order has been paid for and tickets are personalized (when enabled and required). * ``shop:ordercancellation``: (optional) A Shopping API reference to the resource where this order can be canceled. See :doc:`/documentation/ordercancellation`. * ``shop:customer_service``: Website address and email address of customer support for this event. Embedded resources ~~~~~~~~~~~~~~~~~~ * ``shop:product``: a list of products in this order. See :doc:`/documentation/product`. * ``shop:ticket``: a list of tickets in this order. See :doc:`/documentation/tickets`. Example ~~~~~~~ .. code-block:: bash [GET] https://shopping-api.paylogic.com/orders/87a2195h3gd162fb35c5a3dbd7bapo1l .. code-block:: javascript { "_links": { "curies": [{ "name": "shop", "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html", "templated": true, "type": "text/html" }], "self": { "href": "https://shopping-api.paylogic.com/orders/87a2195h3gd162fb35c5a3dbd7bapo1l" }, "profile": { "href": "https://shopping-api-docs.paylogic.com/documentation/orders.html", "type": "text/html" }, "payment": { "href": "https://payments.paylogic.com?redirect=https://psp.paylogic.com/consumer/123", "type": "text/html" }, "shop:etickets": { "href": "https://download.paylogic.com/eticket/sdfsdf235r245wsdgfw5235", "type": "text/html" }, "shop:ordercancellation": { "href": "https://shopping-api.paylogic.com/ordercancellation", "type": "text/html" } }, "uid": "87a2195h3gd162fb35c5a3dbd7bapo1l", "reference": "525743", "created_date": "2014-05-01T12:15:00Z", "status": "pending", "product_selection": [ { "product": "https://shopping-api.paylogic.com/products/12365478654238976585643567854323", "quantity": 3, "unit_price": {"currency": "EUR", "amount": "5.45"}, "total": {"currency": "EUR", "amount": "16.35"} }, { "product": "https://shopping-api.paylogic.com/products/456ghtr45tg678fe5rf456yhgbvsw3lh", "quantity": 1, "unit_price": {"currency": "EUR", "amount": "1.00"}, "total": {"currency": "EUR", "amount": "1.00"} }, { "parent": "https://shopping-api.paylogic.com/products/456ghtr45tg678fe5rf456yhgbvsw3lh", "product": "https://shopping-api.paylogic.com/products/267arnr45tg984rd5rf456opshwks0ol", "quantity": 1, "unit_price": {"currency": "EUR", "amount": "1.23"}, "total": {"currency": "EUR", "amount": "1.23"} } ], "consumer": { "first_name": "John", "last_name": "Doe", "date_of_birth": "1986-12-30", "email": "john.doe@paylogic.eu", "gender": 1, "address": "Nieuwe Boteringestraat 28", "postal_code": "9716 JJ", "city": "Groningen", "country": "NL", "ip": "192.168.1.1" }, "shipping_consumer": { "address": "Nieuwe Boteringestraat 28", "postal_code": "9716 JJ", "city": "Groningen", "country": "NL", }, "payment": { "status": "pending", "reason": null }, "payment_method": { "uid": "ghr57d5h3gd162fb35c5a3db57ghrydg", "name": {"en": "iDeal", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""}, "image": "https://static.paylogic.com/ideal.jpg", "costs": { "amount": 1.00, "currency": "EUR" } }, "shipping_method": { "uid": "87a5quvndhe162fb357alt872705zr2j", "name": {"en": "Eticket", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""}, "costs": { "amount": 0.50, "currency": "EUR" } }, "product_total": { "amount": 13.50, "currency": "EUR" }, "service_costs": { "amount": 1.50, "currency": "EUR" }, "grand_total": { "amount": 16.50, "currency": "EUR" }, "external_purchases": [ { "title": {"en": "External purchase", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""}, "product_reference": "External purchase product A", "unit_price": { "amount": 50.00, "currency": "EUR" }, "quantity": 3 } ], "external_reference": "CO-115", "redirect_url": "http://example.com/redirect_url", "legal_info": { "registration_id": "reg123456789", "display_imprint": false, "statutory_city": "Koeln", "telephone_number": "+123456789", "doing_business_as": "Mega Corporation", "platform": { "registration_id": "ABCDEF0123456789", "legal_representative": "Kyle Reece", "legal_phrase": "The red fox jumped over brown dog", "customer_service_email": "industrious@cs.com", "telephone_number": "+123123123987", "vat_id": "FEDDEF123321", "_links": { "shop:customer_service_url": { "href": "https://customer.service.url/follow/me" }, "shop:logo_url": { "href": "https://logo.url/follow/me" }, "curies": [ { "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html", "type": "text/html", "name": "shop", "templated": true } ], "shop:terms_url": { "href": "https://terms.url/follow/me", "templated": true }, "shop:privacy_url": { "href": "https://privacy.url/follow/me", "templated": true }, "shop:cookie_url": { "href": "https://cookie.url/follow/me", "templated": true } }, "company_name": "Industrious Corporation", "statutory_zip": "RX 4500", "statutory_address": "204C Niklaus Wirth avenue", "statutory_city": "Utrecht", "public_email": "domain@address.com", "display_powered_by": false }, "legally_represented_by": "Hannes Strauss", "statutory_zip": "NX 2162", "statutory_address": "Lange Strasse 24", "vat_id": "vat123456789", "public_email": "mailme@com.de", "display_imprint": true, "imprint_additional_info": { "es": "", "en": "Legal information\nRequired in Germany.", "nl": "", "de": "", "fr": "Rechtsinformation\nIn Deutschland erforderlich.", "pt": "", "tr": "" } }, "_embedded": { "shop:product": [ // See "Embedded resources" above. ], "shop:ticket": [ // See "Embedded resources" above. ], "shop:customer_service": { "email": "customerservice@paylogic.com" }, } } Modify a single order ======================= If an order is already completed, it is still possible to change its consumer information. This is only permitted if an application has the "merchant" Shopping API role. Authentication -------------- It's required to authenticate using :ref:`basic-auth`. The application must have permission to modify this order. Request data ------------ ========================= ============================================ ================================================= Field name Type Description ========================= ============================================ ================================================= consumer :doc:`Consumer ` A consumer object. shipping_consumer :doc:`Consumer ` A shipping consumer object. ========================= ============================================ ================================================= Response -------- Same as when retrieving a single order. Error types ----------- ==================================== =========== ======================================================================= Type HTTP code Description ==================================== =========== ======================================================================= ORDER_CANNOT_BE_MODIFIED 400 Order is either not in the COMPLETED state or not personalized. ==================================== =========== ======================================================================= Example ~~~~~~~ .. code-block:: bash [PUT] https://shopping-api.paylogic.com/orders/87a2195h3gd162fb35c5a3dbd7bapo1l .. code-block:: javascript { "consumer": { "first_name": "John", "last_name": "Doe", "date_of_birth": "1986-12-30", "email": "john.doe@paylogic.eu", "gender": 1, "address": "Nieuwe Boteringestraat 28", "postal_code": "9716 JJ", "city": "Groningen", "country": "NL", "ip": "192.168.1.1" }, "shipping_consumer": { "address": "Javastraat 122", "city": "Den Haag" } } Retrieve multiple orders ======================== Retrieve multiple orders in a single request with optional filtering. The result is ordered by Order ID, lowest first. This resource uses :doc:`/concepts/pagination`. - Use :ref:`basic-auth` to retrieve all orders this application has access to. - Use a :ref:`cognito-token` to retrieve all orders created by the user represented by this token. Filtering --------- ================== ============================= Field name Description ================== ============================= event Event URI exact match event__in Event URI in (list) external_reference Event UID exact match status Order state exact match status__ne Order state not equal status__in Order state in (list) created__lt Created less-than created__lte Created less-than or equal created__gt Created greater than created__gte Created greater than or equal ================== ============================= Response -------- The response will contain a list of orders and :doc:`/concepts/pagination` data. For documentation on data in ``shop:order``: see :ref:`get-order` above. .. code-block:: bash [GET] https://shopping-api.paylogic.com/orders?status=completed .. code-block:: javascript { "_links": { "self": { "href": "https://shopping-api.paylogic.com/orders?page=2" }, "curies": [ { "name": "shop", "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html", "templated": true, "type": "text/html" }, ], "profile": { "href": "https://shopping-api-docs.paylogic.com/documentation/orders.html", "type": "text/html" }, "search": { "href": "https://shopping-api.paylogic.com/orders?status=completed", "templated": true }, "first": { "href": "https://shopping-api.paylogic.com/products" }, "prev": { "href": "https://shopping-api.paylogic.com/products?page=1" }, "next": { "href": "https://shopping-api.paylogic.com/products?page=3" }, "last": { "href": "https://shopping-api.paylogic.com/products?page=7" } }, "item_count": 128, "_embedded": { "shop:order": [ { ... }, { ... }, ] } } Product recommendations for orders ================================== Product recommendations are suggestions for the fan of the order to buy more products. They can be configured either with- or without dynamic shopping. Once correctly configured, a list of product recommendations can be retrieved for a given order. Authentication -------------- This request can be authenticated using :ref:`basic-auth`, in addition to an :ref:`order-token` or :ref:`cognito-token`. Link relations -------------- * ``upsell_shop``: A link to the shop where the user can buy the new products. * ``shop:upsell_sale``: A link to the sale resource related to the upsell shop. Example ------- .. code-block:: bash [GET] https://shopping-api.paylogic.com/orders/87a2195h3gd162fb35c5a3dbd7bapo1l/upsell-recommendation .. code-block:: javascript { "_links":{ "shop:upsell_sale":{ "href":"https://shopping-api.paylogic.com/sales/0de86b2cbb674529a681b8e3fe99f1f7" }, "upsell_shop":{ "href":"https://shop.paylogic.com/094a04f823654cb3a7c2cd39386546b9/" }, "curies":[ { "href":"https://shopping-api-docs.paylogic.com/documentation/{rel}.html", "name":"shop", "templated":true, "type":"text/html" } ] }, "show_images":false, "products":[ { "_links":{ "self":{ "href":"https://shopping-api.paylogic.com/products/050887415a754149a9e8b911b5b45840" }, "shop:event":{ "href":"https://shopping-api.paylogic.com/events/6dd4462cba8b430cb91d73b8a1101593" }, "profile":{ "href":"https://shopping-api-docs.paylogic.com/documentation/product.html", "type":"text/html" }, "curies":[ { "href":"https://shopping-api-docs.paylogic.com/documentation/{rel}.html", "name":"shop", "templated":true, "type":"text/html" } ] }, "uid":"050887415a754149a9e8b911b5b45840", "reference":"5", "name":{ "en":"Simple product 3", "nl":"Gewoon product 3", "de":"", "es":"", "fr":"", "pt":"" }, "label":"None", "subtitle":{ "en":"", "nl":"", "de":"", "es":"", "fr":"", "pt":"" }, "price":{ "amount":"2.50", "currency":"EUR" }, "sold_out_text":{ "en":"", "nl":"", "de":"", "es":"", "fr":"", "pt":"" }, "sale_start":"2022-12-05T15:10:34Z", "sale_end":"2023-01-26T15:10:34Z", "min_per_order":"None", "max_per_order":"None", "separately_saleable":true, "additional_information":{ "en":"", "nl":"", "de":"", "es":"", "fr":"", "pt":"" }, "viewing_order":3, "parents":"None", "combo":"None", "personalization_required":false, "types":[ "NULL", "NULL", "NULL" ], "requires_membership":false, "provides_membership":false, "images":[ ], "price_breakdown":{ "unit_price_including_service_costs":{ "amount":"4.50", "currency":"EUR" }, "unit_price_excluding_service_costs":{ "amount":"2.50", "currency":"EUR" }, "unit_price_service_costs":{ "amount":"2.00", "currency":"EUR" }, "total_including_service_costs":{ "amount":"4.50", "currency":"EUR" }, "total_excluding_service_costs":{ "amount":"2.50", "currency":"EUR" }, "total_service_costs":{ "amount":"2.00", "currency":"EUR" } } }, { "_links":{ "self":{ "href":"https://shopping-api.paylogic.com/products/80c1078ec52b48f3adc68fe9b32457fc" }, "shop:event":{ "href":"https://shopping-api.paylogic.com/events/6dd4462cba8b430cb91d73b8a1101593" }, "profile":{ "href":"https://shopping-api-docs.paylogic.com/documentation/product.html", "type":"text/html" }, "curies":[ { "href":"https://shopping-api-docs.paylogic.com/documentation/{rel}.html", "name":"shop", "templated":true, "type":"text/html" } ] }, "uid":"80c1078ec52b48f3adc68fe9b32457fc", "reference":"6", "name":{ "en":"Simple product 5", "nl":"Gewoon product 5", "de":"", "es":"", "fr":"", "pt":"" }, "label":"None", "subtitle":{ "en":"", "nl":"", "de":"", "es":"", "fr":"", "pt":"" }, "price":{ "amount":"2.50", "currency":"EUR" }, "sold_out_text":{ "en":"", "nl":"", "de":"", "es":"", "fr":"", "pt":"" }, "sale_start":"2022-12-05T15:10:34Z", "sale_end":"2023-01-26T15:10:34Z", "min_per_order":"None", "max_per_order":"None", "separately_saleable":true, "additional_information":{ "en":"", "nl":"", "de":"", "es":"", "fr":"", "pt":"" }, "viewing_order":5, "parents":"None", "combo":"None", "personalization_required":false, "types":[ "NULL", "NULL", "NULL" ], "requires_membership":false, "provides_membership":false, "images":[ ], "price_breakdown":{ "unit_price_including_service_costs":{ "amount":"4.50", "currency":"EUR" }, "unit_price_excluding_service_costs":{ "amount":"2.50", "currency":"EUR" }, "unit_price_service_costs":{ "amount":"2.00", "currency":"EUR" }, "total_including_service_costs":{ "amount":"4.50", "currency":"EUR" }, "total_excluding_service_costs":{ "amount":"2.50", "currency":"EUR" }, "total_service_costs":{ "amount":"2.00", "currency":"EUR" } } } ] } Retrying a failed payment ========================= A payment may fail, either because a fan canceled a payment or because there was a downstream error with one of our payment service providers. When a payment fails, the fan will be sent to the ``redirect_url`` that was given when the order was created. If you want to provide the option to retry a payment, you can do the following: 1. On your order redirect page, retrieve the order using the Shopping API. If ``shop:repayment`` is available in the ``_links`` section, retrying the payment is possible. .. code-block:: javascript "_links":{ "shop:repayment":{ "href": "https://shopping-api.paylogic.com/orders/0de86b2cbb674529a681b8e3fe99f1f7/repayment" } // other order links... } "status": "pending", // other order data ... 2. ``POST`` to this URL using the same authentication as when you created the order. There is no request body for this call. If succesful, the response will look like the response below. If retrying the payment was not or no longer possible, you will get a Bad Request (400) response. Retrying the payment is possible until the original order's expiry time. .. code-block:: javascript // Success response with a URL containing parameters: // - order_token // - channel // - basket {"checkout_url": "https://checkout.paylogic.com/?order_token=AKWcWucI5b4oGoFJfczJ9KJOLQnoZJRhAtkRRuDi&channel=http%3A%2F%2Fshopping-api.paylogic.com%3A8011%2Fchannels%2Faf5935f693f0445486bc9417ba296d43&basket=http%3A%2F%2Fshopping-api.paylogic.com%3A8011%2Fbaskets%2F0de86b2cbb674529a681b8e3fe99f1f7"} 3. Now the order is reset to a basket, and can be changed and paid again. **We only allow changes to the basket's payment method and consumer** at this point. Changes to the basket contents are not possible and will result in a Bad Request (400) response. If you want to use Paylogic's UI to allow retrying the payment, you can send the fan to the URL of the example response above. If you want to provide your own UI, you can continue the flow at :ref:`order-from-basket`. Make sure that your UI does not allow making changes to the basket contents. Use the value of the ``basket`` query parameter in the ``checkout_url`` to supply the ``basket`` parameter. You can also include an updated ``consumer`` and/or ``payment_method``. Use ``Order-Token: `` to authenticate this API call. Retrieve refund access to a order ================================= When a refund can be requested by the fan this resource will send an email to the fan containing the instructions to request a refund. .. code-block:: bash [POST] https://shopping-api.paylogic.com/orders/refund_access .. code-block:: javascript { "email": "johndoe@somewhere.com", "order_id": "1234" }