Reverses a payment for an account
POST
/accounts/{account_id}/line_items/payment_reversals/{line_item_id}
Path parameters
-
account_id string Required
ID of the Account
-
line_item_id string Required
Line Item ID of the original payment to be reversed
Body Required
Body of request to create payment reversal.
-
external_fields array[object] | null
An array of static references to fields in a third party system.
Not more than
10elements.
POST /accounts/{account_id}/line_items/payment_reversals/{line_item_id}
curl \
-X POST https://<your_environment_name>-uat-api.canopyservicing.com/accounts/can_52322/line_items/payment_reversals/can_52322 \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"external_fields":[{"key":"Globex Card Processing Account ID","value":"22445702-a389-431f-927d-07b8d0750787"}]}'
Request example
{
"external_fields": [
{
"key": "Globex Card Processing Account ID",
"value": "22445702-a389-431f-927d-07b8d0750787"
}
]
}