Upcoming Release

Reverse a charge for an account

POST /accounts/{account_id}/line_items/charge_reversals/{line_item_id}

Path parameters

Body Required

Body of request to create charge reversal.

  • external_fields array[object] | null

    An array of static references to fields in a third party system.

    Not more than 10 elements.

    Hide external_fields attributes Show external_fields attributes array[object] | null
    • key string

      Key - i.e. Name of the External Party

    • value string

      Value - i.e. External Account ID

  • Additional properties are NOT allowed

Responses

POST /accounts/{account_id}/line_items/charge_reversals/{line_item_id} 
curl \
 -X POST https://sandbox-api.canopyservicing.com/accounts/31mNprzLd2bKl6koVna68ARM/line_items/charge_reversals/31mNprzLd2bKl6koVna68ARM \
 -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"
    }
  ]
}
Request examples 
{
  "external_fields": [
    {
      "key": "Globex Card Processing Account ID",
      "value": "22445702-a389-431f-927d-07b8d0750787"
    }
  ]
}