Delete Token

Delete recurrenceToken

Payers should be able to delete payment tokens that are associated to them. How to delete a recurrenceToken is described in the example below. Note that the value of state must be Deleted when deleting the token. No other states are supported.

Delete Token Request

Request

Copy json to clipboard

1
2
3
4

PATCH /psp/invoice/payments/instrumentData/5a17c24e-d459-4567-bbad-aa0f17a76119 HTTP/1.1
Host: api.externalintegration.payex.com
Authorization: Bearer <AccessToken>
Content-Type: application/json

1
2
3
4

{
    "state": "Deleted",
    "comment": "Comment on why the deletion is happening"
}

Delete Token Response

Response

Copy json to clipboard

1
2

HTTP/1.1 200 OK
Content-Type: application/json

1
2
3
4
5
6
7
8
9

{   
    "instrumentData": {
        "id": "/psp/invoice/payments/instrumentData/5a17c24e-d459-4567-bbad-aa0f17a76119",
        "paymentToken": "5a17c24e-d459-4567-bbad-aa0f17a76119",
        "payeeId": "5cabf558-5283-482f-b252-4d58e06f6f3b",
        "isDeleted": true 
    }
    
}