Get payment history

curl --request GET \
  --url https://v2.prod.halliday.xyz/payments/history \
  --header 'Authorization: Bearer <token>'

{
  "payment_statuses": [
    {
      "payment_id": "<string>",
      "status": "PENDING",
      "funded": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "initiate_fund_by": "2023-11-07T05:31:56Z",
      "quoted": {
        "output_amount": {
          "asset": "ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          "amount": "1"
        },
        "fees": {
          "total_fees": "<string>",
          "conversion_fees": "<string>",
          "network_fees": "<string>",
          "business_fees": "<string>",
          "currency_symbol": "USD"
        },
        "route": [
          {
            "type": "ONRAMP",
            "net_effect": {
              "consume": [
                {
                  "account": "USER",
                  "resource": {
                    "asset": "<string>",
                    "property": "APPROVAL"
                  },
                  "amount": {
                    "amount": "<string>"
                  }
                }
              ],
              "produce": [
                {
                  "account": "USER",
                  "resource": {
                    "asset": "<string>",
                    "property": "APPROVAL"
                  },
                  "amount": {
                    "amount": "<string>"
                  }
                }
              ]
            },
            "pieces_info": [
              {
                "type": "onramp"
              }
            ],
            "step_index": 123
          }
        ],
        "onramp": "<string>",
        "onramp_method": "credit_card"
      },
      "fulfilled": {
        "route": [
          {
            "status": "PENDING",
            "type": "ONRAMP",
            "net_effect": {
              "consume": [
                {
                  "account": "USER",
                  "resource": {
                    "asset": "<string>",
                    "property": "APPROVAL"
                  },
                  "amount": {
                    "amount": "<string>"
                  }
                }
              ],
              "produce": [
                {
                  "account": "USER",
                  "resource": {
                    "asset": "<string>",
                    "property": "APPROVAL"
                  },
                  "amount": {
                    "amount": "<string>"
                  }
                }
              ]
            },
            "pieces_info": [
              {
                "type": "onramp"
              }
            ],
            "step_index": 123,
            "transaction_hash": "<string>"
          }
        ],
        "output_amount": {
          "asset": "ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          "amount": "1"
        },
        "fees": {
          "total_fees": "<string>",
          "conversion_fees": "<string>",
          "network_fees": "<string>",
          "business_fees": "<string>",
          "currency_symbol": "USD"
        },
        "onramp": "<string>",
        "onramp_method": "credit_card"
      },
      "current_prices": {
        "USD": "1.00",
        "ethereum:0x": "4200",
        "ethereum:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": "1.00"
      },
      "price_currency": "USD",
      "processing_addresses": [
        {
          "chain": "ethereum",
          "address": "<string>"
        }
      ],
      "owner_address": "<string>",
      "destination_address": "<string>",
      "completed_at": "2023-11-07T05:31:56Z",
      "quote_request": {
        "request": {
          "kind": "FIXED_INPUT",
          "fixed_input_amount": {
            "asset": "ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
            "amount": "1"
          },
          "output_asset": "ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
        },
        "price_currency": "USD",
        "onramps": [
          "moonpay",
          "coinbase"
        ],
        "onramp_methods": [
          "credit_card",
          "ach",
          "apple_pay"
        ],
        "customer_ip_address": "<string>",
        "customer_id": "<string>",
        "customer_geolocation": {
          "alpha3_country_code": "<string>",
          "state_code": "<string>"
        },
        "parent_payment_id": "<string>"
      },
      "customer_id": "<string>",
      "next_instruction": {
        "type": "ONRAMP",
        "payment_id": "<string>",
        "funding_page_url": "https://app.halliday.xyz/funding/${payment_id}",
        "deposit_info": [
          {
            "deposit_token": "base:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
            "deposit_amount": "4.8",
            "deposit_address": "0xaddress",
            "deposit_chain": "base"
          }
        ]
      }
    }
  ],
  "next_pagination_key": "42ff9b02-037f-4a90-87fb-a4d2ca128565_2025-11-12T22:08:52.517Z"
}

GET

payments

history

Get payment history

curl --request GET \
  --url https://v2.prod.halliday.xyz/payments/history \
  --header 'Authorization: Bearer <token>'

{
  "payment_statuses": [
    {
      "payment_id": "<string>",
      "status": "PENDING",
      "funded": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "initiate_fund_by": "2023-11-07T05:31:56Z",
      "quoted": {
        "output_amount": {
          "asset": "ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          "amount": "1"
        },
        "fees": {
          "total_fees": "<string>",
          "conversion_fees": "<string>",
          "network_fees": "<string>",
          "business_fees": "<string>",
          "currency_symbol": "USD"
        },
        "route": [
          {
            "type": "ONRAMP",
            "net_effect": {
              "consume": [
                {
                  "account": "USER",
                  "resource": {
                    "asset": "<string>",
                    "property": "APPROVAL"
                  },
                  "amount": {
                    "amount": "<string>"
                  }
                }
              ],
              "produce": [
                {
                  "account": "USER",
                  "resource": {
                    "asset": "<string>",
                    "property": "APPROVAL"
                  },
                  "amount": {
                    "amount": "<string>"
                  }
                }
              ]
            },
            "pieces_info": [
              {
                "type": "onramp"
              }
            ],
            "step_index": 123
          }
        ],
        "onramp": "<string>",
        "onramp_method": "credit_card"
      },
      "fulfilled": {
        "route": [
          {
            "status": "PENDING",
            "type": "ONRAMP",
            "net_effect": {
              "consume": [
                {
                  "account": "USER",
                  "resource": {
                    "asset": "<string>",
                    "property": "APPROVAL"
                  },
                  "amount": {
                    "amount": "<string>"
                  }
                }
              ],
              "produce": [
                {
                  "account": "USER",
                  "resource": {
                    "asset": "<string>",
                    "property": "APPROVAL"
                  },
                  "amount": {
                    "amount": "<string>"
                  }
                }
              ]
            },
            "pieces_info": [
              {
                "type": "onramp"
              }
            ],
            "step_index": 123,
            "transaction_hash": "<string>"
          }
        ],
        "output_amount": {
          "asset": "ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          "amount": "1"
        },
        "fees": {
          "total_fees": "<string>",
          "conversion_fees": "<string>",
          "network_fees": "<string>",
          "business_fees": "<string>",
          "currency_symbol": "USD"
        },
        "onramp": "<string>",
        "onramp_method": "credit_card"
      },
      "current_prices": {
        "USD": "1.00",
        "ethereum:0x": "4200",
        "ethereum:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": "1.00"
      },
      "price_currency": "USD",
      "processing_addresses": [
        {
          "chain": "ethereum",
          "address": "<string>"
        }
      ],
      "owner_address": "<string>",
      "destination_address": "<string>",
      "completed_at": "2023-11-07T05:31:56Z",
      "quote_request": {
        "request": {
          "kind": "FIXED_INPUT",
          "fixed_input_amount": {
            "asset": "ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
            "amount": "1"
          },
          "output_asset": "ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
        },
        "price_currency": "USD",
        "onramps": [
          "moonpay",
          "coinbase"
        ],
        "onramp_methods": [
          "credit_card",
          "ach",
          "apple_pay"
        ],
        "customer_ip_address": "<string>",
        "customer_id": "<string>",
        "customer_geolocation": {
          "alpha3_country_code": "<string>",
          "state_code": "<string>"
        },
        "parent_payment_id": "<string>"
      },
      "customer_id": "<string>",
      "next_instruction": {
        "type": "ONRAMP",
        "payment_id": "<string>",
        "funding_page_url": "https://app.halliday.xyz/funding/${payment_id}",
        "deposit_info": [
          {
            "deposit_token": "base:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
            "deposit_amount": "4.8",
            "deposit_address": "0xaddress",
            "deposit_chain": "base"
          }
        ]
      }
    }
  ],
  "next_pagination_key": "42ff9b02-037f-4a90-87fb-a4d2ca128565_2025-11-12T22:08:52.517Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

owner_address

string

required

Owner address to filter payments by

pagination_key

string

Pagination key from previous response to fetch next page

limit

number

Maximum number of results to return

Response

Payment history retrieved successfully

payment_statuses

object[]

required

Array of payment status objects

Show child attributes

payment_statuses.payment_id

string

required

payment_statuses.status

enum<string>

required

Available options:

PENDING,

COMPLETE,

FAILED,

EXPIRED,

WITHDRAWN,

TAINTED

payment_statuses.funded

boolean

required

Whether the payment has been funded

payment_statuses.created_at

string<date-time>

required

payment_statuses.updated_at

string<date-time>

required

payment_statuses.initiate_fund_by

string<date-time>

required

Deadline for funding the payment.

payment_statuses.quoted

object

required

Show child attributes

payment_statuses.quoted.output_amount

object

required

Show child attributes

payment_statuses.quoted.output_amount.asset

string

required

Identifier in the token format ("chain:address") or fiat currency code ("USD")

Example:

"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

payment_statuses.quoted.output_amount.amount

string

required

Amount as a string to preserve precision

Example:

"1"

payment_statuses.quoted.fees

object

required

Show child attributes

payment_statuses.quoted.fees.total_fees

string

required

Total fees amount

payment_statuses.quoted.fees.conversion_fees

string

required

Ramps + bridge + DEX fees

payment_statuses.quoted.fees.network_fees

string

required

Blockchain gas fees

payment_statuses.quoted.fees.business_fees

string

required

Developer integration fees

payment_statuses.quoted.fees.currency_symbol

string

required

Currency symbol that the fees are denominated in (e.g., "USD", "USDC")

Example:

"USD"

payment_statuses.quoted.route

object[]

required

Quoted workflow steps and their effects

Show child attributes

payment_statuses.quoted.route.type

enum<string>

required

Available options:

ONRAMP,

ONCHAIN_STEP,

USER_FUND

payment_statuses.quoted.route.net_effect

object

required

Show child attributes

payment_statuses.quoted.route.net_effect.consume

object[]

required

Show child attributes

payment_statuses.quoted.route.net_effect.consume.account

enum<string>

required

Available options:

USER,

DEST,

HALLIDAY,

PROCESSING_ADDRESS,

REV_SHARE,

BRIDGE

payment_statuses.quoted.route.net_effect.consume.resource

object

required

Show child attributes

payment_statuses.quoted.route.net_effect.consume.resource.asset

string

required

payment_statuses.quoted.route.net_effect.consume.resource.property

enum<string>

required

Available options:

APPROVAL,

BALANCE

payment_statuses.quoted.route.net_effect.consume.amount

object

required

Show child attributes

payment_statuses.quoted.route.net_effect.consume.amount.amount

string

required

payment_statuses.quoted.route.net_effect.produce

object[]

required

Show child attributes

payment_statuses.quoted.route.net_effect.produce.account

enum<string>

required

Available options:

USER,

DEST,

HALLIDAY,

PROCESSING_ADDRESS,

REV_SHARE,

BRIDGE

payment_statuses.quoted.route.net_effect.produce.resource

object

required

Show child attributes

payment_statuses.quoted.route.net_effect.produce.resource.asset

string

required

payment_statuses.quoted.route.net_effect.produce.resource.property

enum<string>

required

Available options:

APPROVAL,

BALANCE

payment_statuses.quoted.route.net_effect.produce.amount

object

required

Show child attributes

payment_statuses.quoted.route.net_effect.produce.amount.amount

string

required

payment_statuses.quoted.route.pieces_info

object[]

required

Show child attributes

payment_statuses.quoted.route.pieces_info.type

enum<string>

required

Available options:

onramp,

poll,

bridge,

transfer_out,

rev_share,

convert

payment_statuses.quoted.route.step_index

number

payment_statuses.quoted.onramp

string

Onramp provider name

payment_statuses.quoted.onramp_method

string

Payment method

Example:

"credit_card"

payment_statuses.fulfilled

object

required

Show child attributes

payment_statuses.fulfilled.route

object[]

required

In-progress workflow steps, statuses, and their effects

Show child attributes

payment_statuses.fulfilled.route.status

enum<string>

required

Available options:

PENDING,

COMPLETE,

UNREACHABLE,

FAILED

payment_statuses.fulfilled.route.type

enum<string>

required

Available options:

ONRAMP,

ONCHAIN_STEP,

USER_FUND

payment_statuses.fulfilled.route.net_effect

object

required

Show child attributes

payment_statuses.fulfilled.route.net_effect.consume

object[]

required

Show child attributes

payment_statuses.fulfilled.route.net_effect.consume.account

enum<string>

required

Available options:

USER,

DEST,

HALLIDAY,

PROCESSING_ADDRESS,

REV_SHARE,

BRIDGE

payment_statuses.fulfilled.route.net_effect.consume.resource

object

required

Show child attributes

payment_statuses.fulfilled.route.net_effect.consume.resource.asset

string

required

payment_statuses.fulfilled.route.net_effect.consume.resource.property

enum<string>

required

Available options:

APPROVAL,

BALANCE

payment_statuses.fulfilled.route.net_effect.consume.amount

object

required

Show child attributes

payment_statuses.fulfilled.route.net_effect.consume.amount.amount

string

required

payment_statuses.fulfilled.route.net_effect.produce

object[]

required

Show child attributes

payment_statuses.fulfilled.route.net_effect.produce.account

enum<string>

required

Available options:

USER,

DEST,

HALLIDAY,

PROCESSING_ADDRESS,

REV_SHARE,

BRIDGE

payment_statuses.fulfilled.route.net_effect.produce.resource

object

required

Show child attributes

payment_statuses.fulfilled.route.net_effect.produce.resource.asset

string

required

payment_statuses.fulfilled.route.net_effect.produce.resource.property

enum<string>

required

Available options:

APPROVAL,

BALANCE

payment_statuses.fulfilled.route.net_effect.produce.amount

object

required

Show child attributes

payment_statuses.fulfilled.route.net_effect.produce.amount.amount

string

required

payment_statuses.fulfilled.route.pieces_info

object[]

required

Show child attributes

payment_statuses.fulfilled.route.pieces_info.type

enum<string>

required

Available options:

onramp,

poll,

bridge,

transfer_out,

rev_share,

convert

payment_statuses.fulfilled.route.step_index

number

payment_statuses.fulfilled.route.transaction_hash

string

Blockchain transaction hash for the step

payment_statuses.fulfilled.output_amount

object

Show child attributes

payment_statuses.fulfilled.output_amount.asset

string

required

Identifier in the token format ("chain:address") or fiat currency code ("USD")

Example:

"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

payment_statuses.fulfilled.output_amount.amount

string

required

Amount as a string to preserve precision

Example:

"1"

payment_statuses.fulfilled.fees

object

Show child attributes

payment_statuses.fulfilled.fees.total_fees

string

required

Total fees amount

payment_statuses.fulfilled.fees.conversion_fees

string

required

Ramps + bridge + DEX fees

payment_statuses.fulfilled.fees.network_fees

string

required

Blockchain gas fees

payment_statuses.fulfilled.fees.business_fees

string

required

Developer integration fees

payment_statuses.fulfilled.fees.currency_symbol

string

required

Currency symbol that the fees are denominated in (e.g., "USD", "USDC")

Example:

"USD"

payment_statuses.fulfilled.onramp

string

Onramp provider name

payment_statuses.fulfilled.onramp_method

string

Payment method

Example:

"credit_card"

payment_statuses.current_prices

object

required

Mapping of asset symbols to their unit prices

Show child attributes

payment_statuses.current_prices.{key}

string

Example:

{
  "USD": "1.00",
  "ethereum:0x": "4200",
  "ethereum:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": "1.00"
}

payment_statuses.price_currency

string

required

Currency that all prices are denominated in

Example:

"USD"

payment_statuses.processing_addresses

object[]

required

Show child attributes

payment_statuses.processing_addresses.chain

string

required

Blockchain network

Example:

"ethereum"

payment_statuses.processing_addresses.address

string

required

Payment processing contract address

payment_statuses.owner_address

string

required

Address of the owner of the payment

payment_statuses.destination_address

string

required

Address of the destination of the payment

payment_statuses.completed_at

string<date-time>

payment_statuses.quote_request

object

Optional reference to the original quote request.

Show child attributes

payment_statuses.quote_request.request

object

required

Show child attributes

payment_statuses.quote_request.request.kind

enum<string>

required

Available options:

FIXED_INPUT

payment_statuses.quote_request.request.fixed_input_amount

object

required

Show child attributes

payment_statuses.quote_request.request.fixed_input_amount.asset

string

required

Identifier in the token format ("chain:address") or fiat currency code ("USD")

Example:

"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

payment_statuses.quote_request.request.fixed_input_amount.amount

string

required

Amount as a string to preserve precision

Example:

"1"

payment_statuses.quote_request.request.output_asset

string

required

Identifier in the token format ("chain:address") or fiat currency code ("USD")

Example:

"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

payment_statuses.quote_request.price_currency

string

required

Currency that all prices are denominated in

Example:

"USD"

payment_statuses.quote_request.onramps

string[]

Filter by specific onramp providers

Example:

["moonpay", "coinbase"]

payment_statuses.quote_request.onramp_methods

string[]

Filter by onramp payment methods

Example:

["credit_card", "ach", "apple_pay"]

payment_statuses.quote_request.customer_ip_address

string

IP address of the customer

payment_statuses.quote_request.customer_id

string

Customer ID for tracking

payment_statuses.quote_request.customer_geolocation

object

Geolocation information

Show child attributes

payment_statuses.quote_request.customer_geolocation.alpha3_country_code

string

required

Three-letter ISO country code

payment_statuses.quote_request.customer_geolocation.state_code

string

State or region code when applicable. Use an empty string when not applicable.

payment_statuses.quote_request.parent_payment_id

string

Optional parent payment identifier used when creating a quote from an existing payment.

payment_statuses.customer_id

string

ID of the customer who created the payment

payment_statuses.next_instruction

object

Instruction payload that returns the funding pages if the payment requires funding.

Show child attributes

payment_statuses.next_instruction.type

enum<string>

required

Discriminator for this instruction type.

Available options:

ONRAMP,

TRANSFER_IN

payment_statuses.next_instruction.payment_id

string

required

The payment this instruction is associated with.

payment_statuses.next_instruction.funding_page_url

string<uri>

required

URL where the user can complete funding for this payment.

payment_statuses.next_instruction.deposit_info

object[]

required

One or more deposit routes to fund the payment.

Show child attributes

payment_statuses.next_instruction.deposit_info.deposit_token

string

required

Identifier in the token format ("chain:address") or fiat currency code ("USD")

Example:

"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

payment_statuses.next_instruction.deposit_info.deposit_amount

string

required

Amount to deposit, as a decimal string.

Example:

"4.8"

payment_statuses.next_instruction.deposit_info.deposit_address

string

required

Address to which funds will be deposited.

payment_statuses.next_instruction.deposit_info.deposit_chain

string

required

Network on which the deposit will be made (e.g., base, ethereum).

Example:

"base"

Example:

{
  "type": "ONRAMP",
  "payment_id": "<string>",
  "funding_page_url": "https://app.halliday.xyz/funding/${payment_id}",
  "deposit_info": [
    {
      "deposit_token": "base:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
      "deposit_amount": "4.8",
      "deposit_address": "0xaddress",
      "deposit_chain": "base"
    }
  ]
}

next_pagination_key

string

Pagination key to fetch the next page of results

Example:

"42ff9b02-037f-4a90-87fb-a4d2ca128565_2025-11-12T22:08:52.517Z"

Get payment status Get payment quotes

⌘I

Chains

Assets

Payments

Get payment history

Authorizations

Query Parameters

Response