Remove relation from Transaction

POST

https://api.withpersona.com/api/v1/transactions/:transaction-id/remove-relation

POST

/api/v1/transactions/:transaction-id/remove-relation

$ curl -X POST https://api.withpersona.com/api/v1/transactions/transaction-id/remove-relation \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "meta": {
>     "relation-schema-key": "parent-of",
>     "target-object-id": "act_ABC123"
>   }
> }'

1 {
2   "data": {
3     "id": "txn_ABC123",
4     "attributes": {
5       "status": "declined",
6       "fields": {
7         "country": {
8           "type": "string",
9           "value": "US"
10         },
11         "name-first": {
12           "type": "string",
13           "value": "LeBron"
14         },
15         "name-last": {
16           "type": "string",
17           "value": "James"
18         },
19         "selected-id-class": {
20           "type": "string",
21           "value": "dl"
22         },
23         "front-photo": {
24           "type": "file",
25           "value": {
26             "filename": "image.png",
27             "byte-size": 237011,
28             "mime-type": "image/png",
29             "url": "https://files.withpersona.com/image.png?access_token=ACCESS_ABC123"
30           }
31         },
32         "back-photo": {
33           "type": "file",
34           "value": {
35             "filename": "image.png",
36             "byte-size": 237011,
37             "mime-type": "image/png",
38             "url": "https://files.withpersona.com/image.png?access_token=ACCESS_ABC123"
39           }
40         }
41       },
42       "tags": [],
43       "created-at": "2023-05-26T16:49:33.860Z",
44       "updated-at": "2023-05-26T16:49:43.965Z"
45     },
46     "relationships": {
47       "reviewer": {
48         "data": {
49           "type": "workflow-run",
50           "id": "wfr_ABC123"
51         }
52       },
53       "transaction-label": {},
54       "transaction-type": {
55         "data": {
56           "type": "transaction-type",
57           "id": "txntp_ABC123"
58         }
59       },
60       "related-objects": {
61         "data": [
62           {
63             "type": "account",
64             "id": "act_ABC123"
65           },
66           {
67             "type": "verification/government-id",
68             "id": "ver_ABC123"
69           }
70         ]
71       }
72     },
73     "type": "transaction"
74   }
75 }

Removes a relation between this Transaction and a target Account or Transaction. No effect if the relation does not exist.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

transaction-idstringRequired

ID of the transaction to remove the relation from.

Query parameters

includestringOptional

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details.

fieldsmap from strings to stringsOptional

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details.

Request

This endpoint expects an object.

metaobjectRequired

Response

This endpoint returns a Transaction object and (optionally) its related objects in included.

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error