Skip to main content
PUT
/
v1
/
ledger
/
{ledger_key}
/
transaction
/
{transaction_key}
/
refund
Refund Transaction
curl --request PUT \
  --url https://api.sandbox.nxos.io/v1/ledger/{ledger_key}/transaction/{transaction_key}/refund \
  --header 'Authorization: <authorization>'
{
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "asset_moves": [
    {
      "asset_move_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_account": {
        "ref": "<string>",
        "id": "<string>"
      },
      "destination_account": {
        "ref": "<string>",
        "id": "<string>"
      },
      "asset_code": "<string>",
      "amount": "<string>",
      "type": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "decline_type": "<string>",
      "categories": [
        "<string>"
      ],
      "metadata": {}
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "transaction_ref": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ledger.nxos.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
required

The Basic Authentication header. Format: "Basic {base64(orgID:apiKey)}"

Path Parameters

​
ledger_key
string
required

The key of the ledger. Examples:

  • "123e4567-e89b-12d3-a456-426614174000"
  • "id:123e4567-e89b-12d3-a456-426614174000"
  • "ref:ledger:customer_a"
​
transaction_key
string
required

The key of the transaction. Examples:

  • "123e4567-e89b-12d3-a456-426614174000"
  • "id:123e4567-e89b-12d3-a456-426614174000"
  • "ref:tx:payment:customer_a:2023-06-15"

Response

200 - application/json

The request has succeeded.

​
transaction_id
string<uuid>
required

The unique internally assigned identifier of the transaction

​
asset_moves
object[]
required

The asset moves for the transaction

​
created_at
string<date-time>
required

The created at timestamp

​
updated_at
string<date-time>
required

The updated at timestamp

​
transaction_ref
string

The externally defined reference of the transaction