PayssageAPIIntents
Cancel a payment intent
Cancels a pending payment intent and returns its updated state. Only intents still `pending` (or otherwise cancellable) can be cancelled.
POST
/intents/{intent_id}/cancelCancels a pending payment intent and returns its updated state.
Only intents still pending (or otherwise cancellable) can be
cancelled.
AuthorizationBearer <token>
JWT issued by IdentityX, signed with Ed25519
In: header
Path Parameters
intent_id*string
Payment intent ID.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/intents/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"{
"code": 0,
"message": "string",
"error": {
"code": "BAD_REQUEST",
"message": "string",
"fields": [
{
"field": "string",
"message": "string"
}
],
"meta": {},
"debug": {
"raw_error": "string",
"stack_trace": "string"
}
},
"pagination": {
"page": 1,
"limit": 1,
"total": 0,
"has_next": true,
"has_prev": true,
"next_page": 0,
"prev_page": 0
},
"timestamp": "2019-08-24T14:15:22Z",
"module": "string",
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"wallet_id": "d9a8fbfc-848f-43a2-9168-911ed3a04a48",
"seller_id": "28f4dc41-8499-4ead-9976-f2fa20a45fd1",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"amount_cents": 0,
"currency": "string",
"sandbox": true,
"provider": "string",
"status": "pending",
"status_detail": "insufficient_funds",
"provider_data": {},
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}{
"code": 0,
"message": "string",
"error": {
"code": "BAD_REQUEST",
"message": "string",
"fields": [
{
"field": "string",
"message": "string"
}
],
"meta": {},
"debug": {
"raw_error": "string",
"stack_trace": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"module": "string"
}{
"code": 0,
"message": "string",
"error": {
"code": "BAD_REQUEST",
"message": "string",
"fields": [
{
"field": "string",
"message": "string"
}
],
"meta": {},
"debug": {
"raw_error": "string",
"stack_trace": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"module": "string"
}{
"code": 0,
"message": "string",
"error": {
"code": "BAD_REQUEST",
"message": "string",
"fields": [
{
"field": "string",
"message": "string"
}
],
"meta": {},
"debug": {
"raw_error": "string",
"stack_trace": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"module": "string"
}{
"code": 0,
"message": "string",
"error": {
"code": "BAD_REQUEST",
"message": "string",
"fields": [
{
"field": "string",
"message": "string"
}
],
"meta": {},
"debug": {
"raw_error": "string",
"stack_trace": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"module": "string"
}