Cancel a Payment Initiation

1min
Cancel a payment initiation by id
POST
Request
Path Params
id
required
String
Payment initiation id, it will be returned when POST /scheduled is called
Header Parameters
Authorization
required
String
JWT bearer token
Body Parameters
cancelledBy
required
String
The cpf of the user that wanted to cancel
Curl
Node.js
JS
Python
Ruby
curl --location --globoff 'https://api-testing.klavi.ai/payment/customer/v1/scheduled/payments/{id}/cancel' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"cancelledBy":"string"}'
curl --location --globoff 'https://api-testing.klavi.ai/payment/customer/v1/scheduled/payments/{id}/cancel' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"cancelledBy":"string"}'
Responses
200
{
    "id": "1d1ba7cf-82e0-4df5-9656-cba20d18f18d", // Required
    "date": "2024-01-23", // Required
    "createAt": "2024-01-23T03:29:51.796Z", // Required
    "updateAt": "2024-01-23T03:31:40.628Z", // Required
    "consentId": "urn:raidiambank:ea1764e8-4110-40b8-8266-deca50e8f00c", // Optional
    "endToEndId": "E44471172202401230330U82b4161726", // Optional
    "status": "CANCELED", // Required
    "amount": "133300", // Optional
    "externalId": "41820a0-34372-ccg-782", // Optional
    "scheduleId": "19b0af8a-ff3b-4ac0-b388-d5941099e1c1" // Required
}
{
    "id": "1d1ba7cf-82e0-4df5-9656-cba20d18f18d", // Required
    "date": "2024-01-23", // Required
    "createAt": "2024-01-23T03:29:51.796Z", // Required
    "updateAt": "2024-01-23T03:31:40.628Z", // Required
    "consentId": "urn:raidiambank:ea1764e8-4110-40b8-8266-deca50e8f00c", // Optional
    "endToEndId": "E44471172202401230330U82b4161726", // Optional
    "status": "CANCELED", // Required
    "amount": "133300", // Optional
    "externalId": "41820a0-34372-ccg-782", // Optional
    "scheduleId": "19b0af8a-ff3b-4ac0-b388-d5941099e1c1" // Required
}
﻿
﻿
Updated 30 May 2024
Did this page help you?
Await for Payment Status
Generate Access Token