Pay Orders

List PayOrders

get

Retrieve a paginated list of pay orders for the authenticated organization

Authorizations

APIKeyHeader

X-API-KEYstringRequired

Query parameters

limitanyOptional

Number of items to return (default: 20, max: 100)

offsetanyOptional

Number of items to skip (default: 0)

Header parameters

X-API-KEYstringRequired

API key for authentication

Responses

200

List of pay orders with pagination info

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/pay-orders

HTTPcURLJavaScriptPython

GET /v2/pay-orders HTTP/1.1
X-API-KEY: text
Accept: */*

{
  "data": [
    {
      "created_at": "2023-01-01T00:00:00Z",
      "deposit_tx_hash": "0x1234...abcd",
      "fulfillment": {
        "amount": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "asset": {
          "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "chain_id": 30000000000001,
          "decimals": 6,
          "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
          "name": "USD Coin",
          "price_usd": 1,
          "ticker": "USDC"
        }
      },
      "id": "cuidjkhg3e289y74u5t6v",
      "metadata": {
        "refund": {
          "additional_info": "Item was never shipped",
          "currency": "USD",
          "name": "Order Cancellation",
          "reason": "Customer requested refund",
          "refund_amount": 99.98
        }
      },
      "mode": "DEPOSIT",
      "organization_id": "org_1234567890abcdef",
      "payment": {
        "deposit_address": "5xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ5xVt",
        "destination_tx_hash": "0x5678...efgh",
        "dst": {
          "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "chain_id": 30000000000001,
          "currency_amount": {
            "raw_amount": "2400000",
            "ui_amount": 2.4,
            "ui_amount_display": "2.4",
            "value_usd": 123.45
          },
          "decimals": 6,
          "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
          "name": "USD Coin",
          "price_usd": 1,
          "ticker": "USDC"
        },
        "expires_at": "2025-11-03T12:30:00Z",
        "fee_tx_hash": "0xfee1...fee2",
        "receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
        "refund_address": "7xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ7xVt",
        "refund_tx_hash": "0x9abc...ijkl",
        "source_tx_hash": "0x1234...abcd",
        "src": {
          "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "base": {
            "raw_amount": "2400000",
            "ui_amount": 2.4,
            "ui_amount_display": "2.4",
            "value_usd": 123.45
          },
          "chain_id": 30000000000001,
          "currency_amount": {
            "raw_amount": "2400000",
            "ui_amount": 2.4,
            "ui_amount_display": "2.4",
            "value_usd": 123.45
          },
          "decimals": 6,
          "fees": {
            "custom_fee": {
              "raw_amount": "2400000",
              "ui_amount": 2.4,
              "ui_amount_display": "2.4",
              "value_usd": 123.45
            },
            "protocol_fee": {
              "raw_amount": "2400000",
              "ui_amount": 2.4,
              "ui_amount_display": "2.4",
              "value_usd": 123.45
            },
            "total_fee": {
              "raw_amount": "2400000",
              "ui_amount": 2.4,
              "ui_amount_display": "2.4",
              "value_usd": 123.45
            }
          },
          "gas": {
            "raw_amount": "2400000",
            "ui_amount": 2.4,
            "ui_amount_display": "2.4",
            "value_usd": 123.45
          },
          "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
          "name": "USD Coin",
          "price_usd": 1,
          "ticker": "USDC",
          "total": {
            "raw_amount": "2400000",
            "ui_amount": 2.4,
            "ui_amount_display": "2.4",
            "value_usd": 123.45
          }
        }
      },
      "receiving_tx_hash": "0x5678...efgh",
      "refund_tx_hash": "0x9abc...ijkl",
      "request": {
        "amount": {
          "fiat": {
            "amount": 100,
            "unit": "USD"
          },
          "token": {
            "raw_amount": "100000000",
            "ui_amount": 100
          }
        },
        "currency": {
          "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "chain_id": 30000000000001,
          "decimals": 6,
          "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
          "name": "USD Coin",
          "price_usd": 1,
          "ticker": "USDC"
        },
        "receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"
      },
      "status": "PENDING",
      "updated_at": "2023-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total_count": 42
  }
}

Create a PayOrder

post

Create a new PayOrder for cryptocurrency payment processing

Authorizations

APIKeyHeaderAuthorization

X-API-KEYstringRequired

Header parameters

X-API-KEYstringRequired

API key for authentication

Authorization-SignaturestringRequired

Authorization header format: 'APIKey=<api_key>,signature=,timestamp=<unix_timestamp>'

Body

application/json

modestring · enumRequiredExample: SALEPossible values:

metadataany ofOptional

or

nullOptional

Responses

201

PayOrder created successfully

application/json

400

Bad Request - Invalid request body or validation failed

application/json

401

Unauthorized - Authentication required

application/json

500

Internal Server Error

application/json

post

/pay-orders

HTTPcURLJavaScriptPython

POST /v2/pay-orders HTTP/1.1
X-API-KEY: text
Authorization-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 422

{
  "intent": {
    "amount": {
      "fiat": {
        "amount": 100,
        "unit": "USD"
      },
      "token_amount": 100
    },
    "asset": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "chain_id": 30000000000001
    },
    "receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"
  },
  "metadata": {
    "refund": {
      "additional_info": "Item was never shipped",
      "currency": "USD",
      "name": "Order Cancellation",
      "reason": "Customer requested refund",
      "refund_amount": 99.98
    }
  },
  "mode": "SALE"
}

{
  "created_at": "2023-01-01T00:00:00Z",
  "deposit_tx_hash": "0x1234...abcd",
  "fulfillment": {
    "amount": {
      "raw_amount": "2400000",
      "ui_amount": 2.4,
      "ui_amount_display": "2.4",
      "value_usd": 123.45
    },
    "asset": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "chain_id": 30000000000001,
      "decimals": 6,
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC"
    }
  },
  "id": "cuidjkhg3e289y74u5t6v",
  "metadata": {
    "refund": {
      "additional_info": "Item was never shipped",
      "currency": "USD",
      "name": "Order Cancellation",
      "reason": "Customer requested refund",
      "refund_amount": 99.98
    }
  },
  "mode": "DEPOSIT",
  "organization_id": "org_1234567890abcdef",
  "payment": {
    "deposit_address": "5xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ5xVt",
    "destination_tx_hash": "0x5678...efgh",
    "dst": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "chain_id": 30000000000001,
      "currency_amount": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "decimals": 6,
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC"
    },
    "expires_at": "2025-11-03T12:30:00Z",
    "fee_tx_hash": "0xfee1...fee2",
    "receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
    "refund_address": "7xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ7xVt",
    "refund_tx_hash": "0x9abc...ijkl",
    "source_tx_hash": "0x1234...abcd",
    "src": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "base": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "chain_id": 30000000000001,
      "currency_amount": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "decimals": 6,
      "fees": {
        "custom_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "protocol_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "total_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        }
      },
      "gas": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC",
      "total": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      }
    }
  },
  "receiving_tx_hash": "0x5678...efgh",
  "refund_tx_hash": "0x9abc...ijkl",
  "request": {
    "amount": {
      "fiat": {
        "amount": 100,
        "unit": "USD"
      },
      "token": {
        "raw_amount": "100000000",
        "ui_amount": 100
      }
    },
    "currency": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "chain_id": 30000000000001,
      "decimals": 6,
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC"
    },
    "receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"
  },
  "status": "PENDING",
  "updated_at": "2023-01-01T00:00:00Z"
}

Get PayOrder

get

Retrieve details of a specific PayOrder

Authorizations

APIKeyHeader

X-API-KEYstringRequired

Path parameters

payorder_idstringRequired

Header parameters

X-API-KEYstringRequired

API key for authentication

Responses

200

PayOrder details

application/json

idstringRequiredExample: cuidjkhg3e289y74u5t6v

created_atstring · date-timeRequiredExample: 2023-01-01T00:00:00Z

updated_atstring · date-timeRequiredExample: 2023-01-01T00:00:00Z

organization_idstringRequiredExample: org_1234567890abcdef

modestring · enumRequiredExample: DEPOSITPossible values:

statusstring · enumRequiredExample: PENDINGPossible values:

paymentany ofOptional

or

nullOptional

metadataany ofOptional

or

nullOptional

deposit_tx_hashstring · nullableOptionalExample: 0x1234...abcd

receiving_tx_hashstring · nullableOptionalExample: 0x5678...efgh

refund_tx_hashstring · nullableOptionalExample: 0x9abc...ijkl

401

Unauthorized - Authentication required

application/json

404

Not Found - PayOrder not found

application/json

500

Internal Server Error

application/json

get

/pay-orders/{payorder_id}

HTTPcURLJavaScriptPython

GET /v2/pay-orders/{payorder_id} HTTP/1.1
X-API-KEY: text
Accept: */*

{
  "created_at": "2023-01-01T00:00:00Z",
  "deposit_tx_hash": "0x1234...abcd",
  "fulfillment": {
    "amount": {
      "raw_amount": "2400000",
      "ui_amount": 2.4,
      "ui_amount_display": "2.4",
      "value_usd": 123.45
    },
    "asset": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "chain_id": 30000000000001,
      "decimals": 6,
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC"
    }
  },
  "id": "cuidjkhg3e289y74u5t6v",
  "metadata": {
    "refund": {
      "additional_info": "Item was never shipped",
      "currency": "USD",
      "name": "Order Cancellation",
      "reason": "Customer requested refund",
      "refund_amount": 99.98
    }
  },
  "mode": "DEPOSIT",
  "organization_id": "org_1234567890abcdef",
  "payment": {
    "deposit_address": "5xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ5xVt",
    "destination_tx_hash": "0x5678...efgh",
    "dst": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "chain_id": 30000000000001,
      "currency_amount": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "decimals": 6,
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC"
    },
    "expires_at": "2025-11-03T12:30:00Z",
    "fee_tx_hash": "0xfee1...fee2",
    "receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
    "refund_address": "7xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ7xVt",
    "refund_tx_hash": "0x9abc...ijkl",
    "source_tx_hash": "0x1234...abcd",
    "src": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "base": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "chain_id": 30000000000001,
      "currency_amount": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "decimals": 6,
      "fees": {
        "custom_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "protocol_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "total_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        }
      },
      "gas": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC",
      "total": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      }
    }
  },
  "receiving_tx_hash": "0x5678...efgh",
  "refund_tx_hash": "0x9abc...ijkl",
  "request": {
    "amount": {
      "fiat": {
        "amount": 100,
        "unit": "USD"
      },
      "token": {
        "raw_amount": "100000000",
        "ui_amount": 100
      }
    },
    "currency": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "chain_id": 30000000000001,
      "decimals": 6,
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC"
    },
    "receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"
  },
  "status": "PENDING",
  "updated_at": "2023-01-01T00:00:00Z"
}

Get Payment Details

post

Get payment details for a PayOrder

Authorizations

APIKeyHeader

X-API-KEYstringRequired

Path parameters

payorder_idstringRequired

Header parameters

X-API-KEYstringRequired

API key for authentication

Body

application/json

source_currencyany ofOptional

or

nullOptional

refund_addressstring · nullableOptional

quote_idstring · nullableOptional

Responses

200

Payment details

application/json

payorder_idstringRequiredExample: cuidjkhg3e289y74u5t6v

statusstring · enumRequiredExample: AWAITING_PAYMENTPossible values:

400

Bad Request - Invalid request body

application/json

401

Unauthorized - Authentication required

application/json

500

Internal Server Error

application/json

post

/pay-orders/{payorder_id}/payment-details

HTTPcURLJavaScriptPython

POST /v2/pay-orders/{payorder_id}/payment-details HTTP/1.1
X-API-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "source_currency": {
    "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "chain_id": 30000000000001
  }
}

{
  "data": {
    "deposit_address": "5xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ5xVt",
    "dst": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "chain_id": 30000000000001,
      "currency_amount": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "decimals": 6,
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC"
    },
    "expires_at": "2025-11-03T12:30:00Z",
    "receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
    "refund_address": "7xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ7xVt",
    "src": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "base": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "chain_id": 30000000000001,
      "currency_amount": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "decimals": 6,
      "fees": {
        "custom_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "protocol_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "total_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        }
      },
      "gas": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC",
      "total": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      }
    }
  },
  "payorder_id": "cuidjkhg3e289y74u5t6v",
  "status": "AWAITING_PAYMENT"
}

Quote PayOrder

post

Get payment quotes for a PayOrder

Authorizations

APIKeyHeader

X-API-KEYstringRequired

Path parameters

payorder_idstringRequired

Header parameters

X-API-KEYstringRequired

API key for authentication

Body

application/json

wallet_addressstringRequiredExample: 0x1234...abcd

chain_typestring · enumRequiredExample: EVMPossible values:

chain_idsinteger · int64[]OptionalExample: [1,10,137]

Responses

200

Quote results

application/json

idstringRequiredExample: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v

addressstring · nullableOptionalExample: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v

chain_idinteger · int64RequiredExample: 30000000000001

decimalsinteger · int64RequiredExample: 6

namestring · nullableOptionalExample: USD Coin

tickerstring · nullableOptionalExample: USDC

image_uristring · nullableOptionalExample: https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png

price_usdnumber · nullableOptionalExample: 1

ownerstringOptionalExample: 9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM

400

Bad Request - Invalid request body

application/json

401

Unauthorized - Authentication required

application/json

404

Not Found - PayOrder not found

application/json

500

Internal Server Error

application/json

501

Not Implemented - Feature not yet supported

application/json

post

/pay-orders/{payorder_id}/quote

HTTPcURLJavaScriptPython

POST /v2/pay-orders/{payorder_id}/quote HTTP/1.1
X-API-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "chain_ids": [
    1,
    10,
    137
  ],
  "chain_type": "EVM",
  "wallet_address": "0x1234...abcd"
}

[
  {
    "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "balance": {
      "raw_amount": "2400000",
      "ui_amount": 2.4,
      "ui_amount_display": "2.4",
      "value_usd": 123.45
    },
    "chain_id": 30000000000001,
    "decimals": 6,
    "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
    "name": "USD Coin",
    "owner": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
    "price_usd": 1,
    "ticker": "USDC"
  }
]

Create Refund

post

Create a refund for a PayOrder

Authorizations

Authorization

Path parameters

payorder_idstringRequired

Header parameters

Authorization-SignaturestringRequired

Authorization header format: 'APIKey=<api_key>,signature=,timestamp=<unix_timestamp>'

Body

application/json

metadataany ofOptional

or

nullOptional

Responses

200

Refund created successfully

application/json

idstringRequiredExample: cuidjkhg3e289y74u5t6v

created_atstring · date-timeRequiredExample: 2023-01-01T00:00:00Z

updated_atstring · date-timeRequiredExample: 2023-01-01T00:00:00Z

organization_idstringRequiredExample: org_1234567890abcdef

modestring · enumRequiredExample: DEPOSITPossible values:

statusstring · enumRequiredExample: PENDINGPossible values:

paymentany ofOptional

or

nullOptional

metadataany ofOptional

or

nullOptional

deposit_tx_hashstring · nullableOptionalExample: 0x1234...abcd

receiving_tx_hashstring · nullableOptionalExample: 0x5678...efgh

refund_tx_hashstring · nullableOptionalExample: 0x9abc...ijkl

400

Bad Request - Invalid request body or validation failed

application/json

401

Unauthorized - Authentication required

application/json

404

Not Found - PayOrder not found

application/json

422

Unprocessable Entity - PayOrder not completed or already refunded

application/json

500

Internal Server Error

application/json

post

/pay-orders/{payorder_id}/refund

HTTPcURLJavaScriptPython

POST /v2/pay-orders/{payorder_id}/refund HTTP/1.1
Authorization-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 408

{
  "intent": {
    "amount": {
      "fiat": {
        "amount": 100,
        "unit": "USD"
      },
      "token_amount": 100
    },
    "asset": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "chain_id": 30000000000001
    },
    "receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"
  },
  "metadata": {
    "refund": {
      "additional_info": "Item was never shipped",
      "currency": "USD",
      "name": "Order Cancellation",
      "reason": "Customer requested refund",
      "refund_amount": 99.98
    }
  }
}

{
  "created_at": "2023-01-01T00:00:00Z",
  "deposit_tx_hash": "0x1234...abcd",
  "fulfillment": {
    "amount": {
      "raw_amount": "2400000",
      "ui_amount": 2.4,
      "ui_amount_display": "2.4",
      "value_usd": 123.45
    },
    "asset": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "chain_id": 30000000000001,
      "decimals": 6,
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC"
    }
  },
  "id": "cuidjkhg3e289y74u5t6v",
  "metadata": {
    "refund": {
      "additional_info": "Item was never shipped",
      "currency": "USD",
      "name": "Order Cancellation",
      "reason": "Customer requested refund",
      "refund_amount": 99.98
    }
  },
  "mode": "DEPOSIT",
  "organization_id": "org_1234567890abcdef",
  "payment": {
    "deposit_address": "5xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ5xVt",
    "destination_tx_hash": "0x5678...efgh",
    "dst": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "chain_id": 30000000000001,
      "currency_amount": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "decimals": 6,
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC"
    },
    "expires_at": "2025-11-03T12:30:00Z",
    "fee_tx_hash": "0xfee1...fee2",
    "receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
    "refund_address": "7xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ7xVt",
    "refund_tx_hash": "0x9abc...ijkl",
    "source_tx_hash": "0x1234...abcd",
    "src": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "base": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "chain_id": 30000000000001,
      "currency_amount": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "decimals": 6,
      "fees": {
        "custom_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "protocol_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "total_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        }
      },
      "gas": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC",
      "total": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      }
    }
  },
  "receiving_tx_hash": "0x5678...efgh",
  "refund_tx_hash": "0x9abc...ijkl",
  "request": {
    "amount": {
      "fiat": {
        "amount": 100,
        "unit": "USD"
      },
      "token": {
        "raw_amount": "100000000",
        "ui_amount": 100
      }
    },
    "currency": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "chain_id": 30000000000001,
      "decimals": 6,
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC"
    },
    "receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"
  },
  "status": "PENDING",
  "updated_at": "2023-01-01T00:00:00Z"
}