Skip to content

Commit

Permalink
removes: PUT API endpoints
Browse files Browse the repository at this point in the history
removes 'change payment status' endpoint from doc for security reason.
  • Loading branch information
AkmElias committed May 17, 2024
1 parent 954f550 commit 2f0e2f9
Showing 1 changed file with 0 additions and 46 deletions.
46 changes: 0 additions & 46 deletions source/includes/_entries.md
Original file line number Diff line number Diff line change
Expand Up @@ -515,49 +515,3 @@ This end point removes/deletes an entry/submission for the given form id. You al
| ------------- | ---- | -------- | -------------------------- |
| submission_id | int | true | The specific `entry id` |
| form_id | int | true | The `form ID` of the entry |

## Change payment status

```php

```

```python

```

```shell
curl "https://yourdomain.com/wp-json/wppayform/v2/forms/entries/{id}/pay-status" \
-H "Authorization: BASIC USERNAME:APPLICATION_PASSWORD"
-H "Request type: PUT"
```


> The above command returns json structured like this:
```json
{
"message": "Payment status successfully changed"
}
```

> On given existing payment status, the endpoint return json structured like this:
```json
{
"message": "The submission have the same status"
}
```

This end point change payment status of an specific entry. Given the entry/submission id.

### Http request

`PUT https://yourdomain.com/wp-json/wppayform/v2/forms/entries/{id}/pay-status`

### URL parameters

| Parameter | type | Required | Description |
| ------------------ | ------ | -------- | ------------------------------------------------------------- |
| submission_id | int | true | The specific `entry id` |
| new_payment_status | string | true | The new payment status values are: `paid, pending, failed, refunded`. |

0 comments on commit 2f0e2f9

Please sign in to comment.