JUjustifi
Checkouts

Refund a Checkout

Use to refund a checkout. You may refund the full amount or just a portion. When refunding a portion, multiple refunds are supported up until the full payment amount has been refunded.

post/checkouts/{id}/refunds

Request

Headers

Idempotency-Keystring uuid required

a string to identify your request (we recommend using a generated uuid, but you may use any unique string) see Idempotent Requests

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Request body

amountinteger

Amount to be refunded. If missing, the total amount will be used.

Example request

{
  "amount": 4900,
  "fees": [
    {
      "type": "processing_fee",
      "amount": 175
    }
  ]
}

Response

Refund was created successfully

idstring uuid

the object id, also found in the data object

typestring

the object type, or array of objects

page_infounknown

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "checkout_completion",
  "data": {
    "id": "chr_xyz",
    "status": "succeeded",
    "refund_response": "invalid_amount",
    "refund_amount": 4900,
    "returned_fees": [
      {
        "type": "processing_fee",
        "amount": 175
      }
    ],
    "created_at": "2024-01-01T12:00:00Z",
    "updated_at": "2024-01-01T12:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.