Post V 1 Payments | Mint Docs

const url = 'https://api.getmint.money/v1/payments/';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"currency":"string","checkout_id":"string","amount":1.1}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "data": {
    "id": "string",
    "currency": "string",
    "settlement_currency": "string",
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "expires_at": "2024-01-15T09:30:00Z",
    "checkout_id": "string",
    "checkout": {
      "id": "string",
      "name": "string",
      "logo_url": "string"
    },
    "organization_id": "string",
    "status": "pending",
    "status_message": "string",
    "refundable_at": "2024-01-15T09:30:00Z",
    "refund_claim_url": "string",
    "is_test": true,
    "amount": 1.1,
    "settlement_amount": 1.1,
    "settlement_rate_source": "string",
    "payment_attempt": {
      "attempt_id": "string",
      "payment_id": "string",
      "amount": "string",
      "amount_formatted": 1.1,
      "min_amount": "string",
      "expires_at": "2024-01-15T09:30:00Z",
      "settlement_token_address": "string",
      "settlement_config": {
        "chain": "string",
        "asset": "string",
        "asset_name": "string",
        "chain_name": "string",
        "asset_id": "string",
        "chain_hex": "string",
        "chain_family": "string",
        "token_standard": "string",
        "logo_url": "string",
        "chain_logo_url": "string"
      },
      "destination_address": "string",
      "refund_to": "string",
      "refund_url": "string",
      "splitter_factory_address": "string",
      "payment_config_hash": "string",
      "refund_claimed_at": "2024-01-15T09:30:00Z",
      "refund_transaction_hash": "string",
      "payment_provider": "string",
      "payment_address": "string",
      "provider_request_id": "string",
      "provider_status": "string",
      "source_amount": "string",
      "provider_expires_at": "2024-01-15T09:30:00Z",
      "payment_instructions": {
        "type": "relay_deposit_address",
        "provider": "relay",
        "request_id": "string",
        "payment_address": "string",
        "source_chain": "string",
        "source_token": "string",
        "source_amount": "string",
        "source_amount_formatted": "string",
        "expires_at": "2024-01-15T09:30:00Z",
        "refund_to": "string",
        "provider_status": "string"
      },
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "required_confirmations": 1.1,
      "routing": {
        "type": "direct",
        "source": {
          "token": "string",
          "chain": "string"
        },
        "provider": "relay"
      }
    },
    "refund_summary": {
      "attempt_status": "pending",
      "current_refundable_balance": "string",
      "refund_claimed_at": "2024-01-15T09:30:00Z",
      "refund_transaction_hash": "string"
    },
    "payment_address": "string",
    "payment_url": "string",
    "payment_link_email_delivery": {
      "recipientEmail": "string",
      "status": "pending",
      "error": "string",
      "sentAt": "2024-01-15T09:30:00Z"
    },
    "order_id": "string",
    "return_url": "string",
    "customer_id": "string",
    "metadata": {},
    "line_items": [
      {
        "name": "string",
        "quantity": 1.1,
        "image_url": "string",
        "price": 1.1
      }
    ],
    "settlement_fx_rate": 1.1,
    "settlement_rate_updated_at": "2024-01-15T09:30:00Z",
    "settlement": {
      "id": "string",
      "payment_id": "string",
      "checkout_id": "string",
      "organization_id": "string",
      "chain": "string",
      "token": "string",
      "token_symbol": "string",
      "token_decimals": 1,
      "token_standard": "string",
      "splitter_address": "string",
      "settlement_tx_hash": "string",
      "payment_config_hash": "string",
      "gross_amount_base_units": "string",
      "merchant_net_amount_base_units": "string",
      "mint_fee_amount_base_units": "string",
      "referrer_fee_amount_base_units": "string",
      "swept_dust_amount_base_units": "string",
      "residual_amount_base_units": "string",
      "relayer_execution_units": "null",
      "relayer_unit_price_base_units": "null",
      "relayer_native_cost_base_units": "null",
      "relayer_native_token_symbol": "string",
      "relayer_native_token_decimals": 1,
      "relayer_cost_metadata": {},
      "merchant_payout_address": "string",
      "mint_treasury_address": "string",
      "referrer_address": "string",
      "settled_at": "2024-01-15T09:30:00Z"
    }
  },
  "meta": {
    "total": 1.1,
    "offset": 1.1,
    "limit": 1.1
  },
  "error": "string",
  "status": 200
}

Create a new on-chain payment

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

currencystringRequired

checkout_idstringRequired

amountdoubleRequired

order_idstring or nullOptional

return_urlstring or nullOptional<=2048 characters

customer_idstring or nullOptional

metadatamap from strings to strings or doublesOptional

line_itemslist of objectsOptional

recipientEmailstring or nullOptionalformat: "^(?!\.)(?!.*\.\.)([A-Z0-9_'+\-.]*)[A-Z0-9_+-]@([A-Z0-9][A-Z0-9\-]*\.)+[A-Z]{2,}$"<=254 characters

Response

Default Response

dataobject

metaobject or null

errorstring or null

statusdoubleOptionalDefaults to 200