> For the complete documentation index, see [llms.txt](https://docs.spurtcommerce.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.spurtcommerce.com/api-reference/store/orders/order-payments.md).

# Order Payments

Retry order payments and retrieve payment status.

## Get payment status by order prefix ID.

> Get payment status by order prefix ID.\
> \
> \*\*Authentication:\*\* Customer bearer token required.\
> \
> \*\*Feature area:\*\* Orders\
> \
> \*\*Implementation source:\*\* \`src/api/store/controllers/CustomerOrderController.ts\`\
> \
> \*\*Request example provenance:\*\* Response data object illustrative; source comment confirms operation and response envelope.\
> \
> \*\*Response example provenance:\*\* Response data object illustrative; source comment confirms operation and response envelope.\
> \
> \> \*\*Example status: Illustrative.\*\* The example is included to demonstrate request/response shape in the reference UI; verify the owning controller and request DTO before using it as a contract.

```json
{"openapi":"3.0.3","info":{"title":"SpurtCommerce Store API","version":"6.0.0"},"tags":[{"name":"Order payments","description":"Retry order payments and retrieve payment status."}],"servers":[{"url":"https://api.example.com","description":"Replace with your SpurtCommerce API host. Paths include the /api prefix."}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Paste the JWT access token returned by the corresponding login endpoint."}}},"paths":{"/api/orders/get-order-payment-status":{"get":{"operationId":"getApiOrdersGetOrderPaymentStatus","summary":"Get payment status by order prefix ID.","description":"Get payment status by order prefix ID.\n\n**Authentication:** Customer bearer token required.\n\n**Feature area:** Orders\n\n**Implementation source:** `src/api/store/controllers/CustomerOrderController.ts`\n\n**Request example provenance:** Response data object illustrative; source comment confirms operation and response envelope.\n\n**Response example provenance:** Response data object illustrative; source comment confirms operation and response envelope.\n\n> **Example status: Illustrative.** The example is included to demonstrate request/response shape in the reference UI; verify the owning controller and request DTO before using it as a contract.","tags":["Order payments"],"parameters":[{"name":"orderPrefixId","in":"query","required":false,"schema":{"type":"string"},"description":"Query parameter orderPrefixId."}],"responses":{"200":{"description":"Successful response. Response data object illustrative; source comment confirms operation and response envelope. Example is illustrative and does not guarantee a stable response contract.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"orderPrefixId":{"type":"string"},"paymentStatus":{"type":"string"}},"additionalProperties":true}},"additionalProperties":true}}}}}}}}}
```

## Retry payment for a previously created order.

> Retry payment for a previously created order.\
> \
> \*\*Authentication:\*\* Customer bearer token required.\
> \
> \*\*Feature area:\*\* Orders\
> \
> \*\*Implementation source:\*\* \`src/api/store/controllers/CustomerOrderController.ts\`\
> \
> \*\*Request example provenance:\*\* Request fields are source-defined; provider-specific response is illustrative.\
> \
> \*\*Response example provenance:\*\* Request fields are source-defined; provider-specific response is illustrative.\
> \
> \> \*\*Example status: Illustrative.\*\* The example is included to demonstrate request/response shape in the reference UI; verify the owning controller and request DTO before using it as a contract.

```json
{"openapi":"3.0.3","info":{"title":"SpurtCommerce Store API","version":"6.0.0"},"tags":[{"name":"Order payments","description":"Retry order payments and retrieve payment status."}],"servers":[{"url":"https://api.example.com","description":"Replace with your SpurtCommerce API host. Paths include the /api prefix."}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Paste the JWT access token returned by the corresponding login endpoint."}}},"paths":{"/api/orders/retry-payment":{"put":{"operationId":"putApiOrdersRetryPayment","summary":"Retry payment for a previously created order.","description":"Retry payment for a previously created order.\n\n**Authentication:** Customer bearer token required.\n\n**Feature area:** Orders\n\n**Implementation source:** `src/api/store/controllers/CustomerOrderController.ts`\n\n**Request example provenance:** Request fields are source-defined; provider-specific response is illustrative.\n\n**Response example provenance:** Request fields are source-defined; provider-specific response is illustrative.\n\n> **Example status: Illustrative.** The example is included to demonstrate request/response shape in the reference UI; verify the owning controller and request DTO before using it as a contract.","tags":["Order payments"],"responses":{"200":{"description":"Successful response. Request fields are source-defined; provider-specific response is illustrative. Example is illustrative and does not guarantee a stable response contract.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"data":{"type":"object","properties":{},"additionalProperties":true}},"additionalProperties":true}}}}},"requestBody":{"required":false,"description":"Sample request body. Request fields are source-defined; provider-specific response is illustrative. Treat this as an illustrative example, not a complete DTO contract.","content":{"application/json":{"schema":{"type":"object","properties":{"orderPrefixId":{"type":"string"},"paymentPluginId":{"type":"string"},"isMobile":{"type":"string"}},"additionalProperties":true}}}}}}}}
```