تخطَّ إلى المحتوى
افتح بيئة اختبار API

04التكامل

مرجع API

عقد HTTP ثابت للفواتير وحالاتها، مع مبالغ نصية ومفاتيح منع التكرار.

في هذه الصفحة

المصادقة

Authorization
Authorization: Bearer nbta_test_<prefix>_<secret>

العنوان الأساسي: https://nbta.sbarah.com/api

أرسل Content-Type: application/json مع أجسام الطلبات. يلزم Idempotency-Key بطول 16 إلى 128 محرفاً لعمليات POST. أعد استخدام المفتاح نفسه والجسم نفسه لإعادة المحاولة، واستخدم مفتاحاً جديداً لعملية جديدة. إعادة استخدام المفتاح مع بيانات مختلفة تنتج تعارض 409. المبالغ نصوص عشرية وليست أرقام JSON.

POST/v1/invoices

إنشاء فاتورة

Create an invoice with an exact-amount reservation

المصادقة: مفتاح المشروع في Authorization: Bearer.

المعاملالموقعمطلوبالقواعد
Idempotency-Keyheaderنعم{"type":"string","minLength":16,"maxLength":128}
الحقلمطلوبالقواعد
external_idنعم{"type":"string","minLength":1,"maxLength":128}
amountنعم{"type":"string","pattern":"^[0-9]{1,12}(?:\\.[0-9]{1,6})?$"}
payment_route_idنعم{"type":"string","format":"uuid"}
expires_in_secondsلا{"type":"integer","minimum":300,"maximum":3600}
metadataلا{"type":"object","additionalProperties":true,"maxProperties":32}
success_urlلا{"type":"string","format":"uri","minLength":9,"maxLength":2048,"pattern":"^https?://","description":"Absolute https URL without user info, whitespace, bidirectional\noverrides or zero width characters. Test API keys may also use http\non localhost, 127.0.0.1 or [::1].\n"}
cancel_urlلا{"type":"string","format":"uri","minLength":9,"maxLength":2048,"pattern":"^https?://","description":"Absolute https URL without user info, whitespace, bidirectional\noverrides or zero width characters. Test API keys may also use http\non localhost, 127.0.0.1 or [::1].\n"}
customerلا{"type":"object","additionalProperties":false,"minProperties":1,"anyOf":[{"required":["email"]},{"required":["name"]}],"description":"Optional customer details with email, name or both. Never shown on the\npublic checkout. When the project turned on payer receipts, the email\nalso receives one receipt once the invoice is paid or late_paid.\n","properties":{"email":{"type":"string","format":"email","maxLength":254},"name":{"type":"string","minLength":1,"maxLength":120,"description":"Trimmed before storage; 1 to 120 characters after trimming, without\ncontrol characters, bidirectional overrides or zero width\ncharacters.\n"}}}
عقد جسم الطلب الكامل
JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "external_id",
    "amount",
    "payment_route_id"
  ],
  "properties": {
    "external_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "amount": {
      "type": "string",
      "pattern": "^[0-9]{1,12}(?:\\.[0-9]{1,6})?$"
    },
    "payment_route_id": {
      "type": "string",
      "format": "uuid"
    },
    "expires_in_seconds": {
      "type": "integer",
      "minimum": 300,
      "maximum": 3600
    },
    "metadata": {
      "type": "object",
      "additionalProperties": true,
      "maxProperties": 32
    },
    "success_url": {
      "type": "string",
      "format": "uri",
      "minLength": 9,
      "maxLength": 2048,
      "pattern": "^https?://",
      "description": "Absolute https URL without user info, whitespace, bidirectional\noverrides or zero width characters. Test API keys may also use http\non localhost, 127.0.0.1 or [::1].\n"
    },
    "cancel_url": {
      "type": "string",
      "format": "uri",
      "minLength": 9,
      "maxLength": 2048,
      "pattern": "^https?://",
      "description": "Absolute https URL without user info, whitespace, bidirectional\noverrides or zero width characters. Test API keys may also use http\non localhost, 127.0.0.1 or [::1].\n"
    },
    "customer": {
      "type": "object",
      "additionalProperties": false,
      "minProperties": 1,
      "anyOf": [
        {
          "required": [
            "email"
          ]
        },
        {
          "required": [
            "name"
          ]
        }
      ],
      "description": "Optional customer details with email, name or both. Never shown on the\npublic checkout. When the project turned on payer receipts, the email\nalso receives one receipt once the invoice is paid or late_paid.\n",
      "properties": {
        "email": {
          "type": "string",
          "format": "email",
          "maxLength": 254
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 120,
          "description": "Trimmed before storage; 1 to 120 characters after trimming, without\ncontrol characters, bidirectional overrides or zero width\ncharacters.\n"
        }
      }
    }
  }
}

الاستجابات

201 Invoice created or the original idempotent response returned.

ترويسات الاستجابة: Location, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "public_id",
    "external_id",
    "status",
    "asset",
    "amount",
    "payment",
    "expires_at",
    "created_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "public_id": {
      "type": "string",
      "description": "`pub_<32 hex>` for a live invoice. A sandbox invoice (test key) has\n`sandbox_<32 hex>`; it is not served by `/public/invoices`.\n"
    },
    "external_id": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "observed",
        "paid",
        "expired",
        "late_paid",
        "payment_exception",
        "cancelled"
      ]
    },
    "livemode": {
      "type": "boolean"
    },
    "environment": {
      "type": "string",
      "enum": [
        "test",
        "live"
      ]
    },
    "asset": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "route",
        "display_name",
        "network",
        "network_standard",
        "contract",
        "decimals"
      ],
      "properties": {
        "route": {
          "type": "string",
          "description": "`usdt_tron` is paused and currently unavailable.",
          "enum": [
            "usdt_tron",
            "bsc_usd_bep20",
            "usdc_bsc",
            "polygon_usdc",
            "polygon_usdt",
            "base_usdc",
            "base_usdt",
            "arbitrum_usdc",
            "arbitrum_usdt",
            "nbta_sandbox_usdt"
          ]
        },
        "display_name": {
          "type": "string"
        },
        "network": {
          "type": "string"
        },
        "network_standard": {
          "type": "string",
          "description": "TRC-20 belongs to `usdt_tron`, which is paused and currently unavailable.",
          "enum": [
            "TRC-20",
            "BEP-20",
            "ERC-20"
          ]
        },
        "chain_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "contract": {
          "type": [
            "string",
            "null"
          ]
        },
        "decimals": {
          "type": "integer"
        }
      }
    },
    "amount": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "base_atomic",
        "payable_atomic",
        "display_decimals"
      ],
      "properties": {
        "base_atomic": {
          "type": "string",
          "pattern": "^[0-9]+$",
          "description": "Integer atomic units serialized as a string."
        },
        "payable_atomic": {
          "type": "string",
          "pattern": "^[0-9]+$",
          "description": "Integer atomic units serialized as a string."
        },
        "display_decimals": {
          "type": "integer"
        }
      }
    },
    "payment": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "address",
        "url"
      ],
      "properties": {
        "address": {
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      }
    },
    "success_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "maxLength": 2048
    },
    "cancel_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "maxLength": 2048
    },
    "customer": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "required": [
        "email",
        "name"
      ],
      "description": "Customer details sent at creation, or null when none were sent.",
      "properties": {
        "email": {
          "type": [
            "string",
            "null"
          ],
          "format": "email"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "expires_at": {
      "type": "string",
      "format": "date-time"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}
400 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
409 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
413 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
422 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
GET/v1/invoices/{invoice_id}

قراءة فاتورة

Read one project invoice

المصادقة: مفتاح المشروع في Authorization: Bearer.

المعاملالموقعمطلوبالقواعد
invoice_idpathنعم{"type":"string","format":"uuid"}

الاستجابات

200 Invoice state.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "external_id",
    "status",
    "revision",
    "base_amount_atomic",
    "payable_amount_atomic",
    "display_decimals",
    "expires_at",
    "created_at",
    "updated_at",
    "payment_route"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "external_id": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "observed",
        "paid",
        "expired",
        "late_paid",
        "payment_exception",
        "cancelled"
      ]
    },
    "livemode": {
      "type": "boolean"
    },
    "environment": {
      "type": "string",
      "enum": [
        "test",
        "live"
      ]
    },
    "revision": {
      "type": "integer",
      "minimum": 1
    },
    "base_amount_atomic": {
      "type": "string",
      "pattern": "^[0-9]+$",
      "description": "Integer atomic units serialized as a string."
    },
    "payable_amount_atomic": {
      "type": "string",
      "pattern": "^[0-9]+$",
      "description": "Integer atomic units serialized as a string."
    },
    "received_amount_atomic": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^[0-9]+$",
      "description": "Integer atomic units serialized as a string, or null."
    },
    "overpaid_amount_atomic": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^[0-9]+$",
      "description": "Integer atomic units serialized as a string, or null."
    },
    "display_decimals": {
      "type": "integer"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time"
    },
    "observed_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "paid_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "payment_route": {
      "type": "string"
    },
    "success_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "maxLength": 2048
    },
    "cancel_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "maxLength": 2048
    },
    "customer": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "required": [
        "email",
        "name"
      ],
      "description": "Customer details sent at creation, or null when none were sent.",
      "properties": {
        "email": {
          "type": [
            "string",
            "null"
          ],
          "format": "email"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
404 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
GET/v1/invoices

قائمة الفواتير

List project invoices using an opaque signed cursor

المصادقة: مفتاح المشروع في Authorization: Bearer.

المعاملالموقعمطلوبالقواعد
limitqueryلا{"type":"integer","minimum":1,"maximum":100,"default":25}
afterqueryلا{"type":"string","minLength":20}
statusqueryلا{"type":"string","enum":["pending","observed","paid","expired","late_paid","payment_exception","cancelled"]}

الاستجابات

200 Invoice page.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "page"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "external_id",
          "status",
          "revision",
          "base_amount_atomic",
          "payable_amount_atomic",
          "display_decimals",
          "expires_at",
          "created_at",
          "updated_at",
          "payment_route"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "external_id": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "observed",
              "paid",
              "expired",
              "late_paid",
              "payment_exception",
              "cancelled"
            ]
          },
          "livemode": {
            "type": "boolean"
          },
          "environment": {
            "type": "string",
            "enum": [
              "test",
              "live"
            ]
          },
          "revision": {
            "type": "integer",
            "minimum": 1
          },
          "base_amount_atomic": {
            "type": "string",
            "pattern": "^[0-9]+$",
            "description": "Integer atomic units serialized as a string."
          },
          "payable_amount_atomic": {
            "type": "string",
            "pattern": "^[0-9]+$",
            "description": "Integer atomic units serialized as a string."
          },
          "received_amount_atomic": {
            "type": [
              "string",
              "null"
            ],
            "pattern": "^[0-9]+$",
            "description": "Integer atomic units serialized as a string, or null."
          },
          "overpaid_amount_atomic": {
            "type": [
              "string",
              "null"
            ],
            "pattern": "^[0-9]+$",
            "description": "Integer atomic units serialized as a string, or null."
          },
          "display_decimals": {
            "type": "integer"
          },
          "expires_at": {
            "type": "string",
            "format": "date-time"
          },
          "observed_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "paid_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "payment_route": {
            "type": "string"
          },
          "success_url": {
            "type": [
              "string",
              "null"
            ],
            "format": "uri",
            "maxLength": 2048
          },
          "cancel_url": {
            "type": [
              "string",
              "null"
            ],
            "format": "uri",
            "maxLength": 2048
          },
          "customer": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "required": [
              "email",
              "name"
            ],
            "description": "Customer details sent at creation, or null when none were sent.",
            "properties": {
              "email": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "email"
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ]
              }
            }
          }
        }
      }
    },
    "page": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "has_more",
        "next_cursor"
      ],
      "properties": {
        "has_more": {
          "type": "boolean"
        },
        "next_cursor": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
422 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
GET/v1/payment-routes

طرق الدفع

List enabled routes for the authenticated project

المصادقة: مفتاح المشروع في Authorization: Bearer.

الاستجابات

200 Enabled routes.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "route",
          "display_name",
          "network",
          "network_standard",
          "contract",
          "decimals",
          "receiving_address",
          "is_default"
        ],
        "properties": {
          "monitoring_available": {
            "type": "boolean",
            "description": "Whether payment monitoring is currently available."
          },
          "monitoring_status": {
            "type": "string",
            "enum": [
              "available",
              "monitoring_unavailable"
            ]
          },
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "route": {
            "type": "string",
            "description": "`usdt_tron` is paused and currently unavailable.",
            "enum": [
              "usdt_tron",
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt",
              "nbta_sandbox_usdt"
            ]
          },
          "display_name": {
            "type": "string"
          },
          "network": {
            "type": "string"
          },
          "network_standard": {
            "type": "string",
            "description": "TRC-20 belongs to `usdt_tron`, which is paused and currently unavailable.",
            "enum": [
              "TRC-20",
              "BEP-20",
              "ERC-20"
            ]
          },
          "chain_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "contract": {
            "type": [
              "string",
              "null"
            ]
          },
          "decimals": {
            "type": "integer",
            "minimum": 0,
            "maximum": 30
          },
          "receiving_address": {
            "type": [
              "string",
              "null"
            ]
          },
          "is_default": {
            "type": "boolean"
          }
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
POST/v1/invoices/{invoice_id}/cancel

إلغاء فاتورة

Cancel a pending invoice using an expected revision

المصادقة: مفتاح المشروع في Authorization: Bearer.

المعاملالموقعمطلوبالقواعد
invoice_idpathنعم{"type":"string","format":"uuid"}
Idempotency-Keyheaderنعم{"type":"string","minLength":16,"maxLength":128}
الحقلمطلوبالقواعد
expected_revisionنعم{"type":"integer","minimum":1}
عقد جسم الطلب الكامل
JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "expected_revision"
  ],
  "properties": {
    "expected_revision": {
      "type": "integer",
      "minimum": 1
    }
  }
}

الاستجابات

200 Cancelled invoice state.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "status",
    "revision",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "observed",
        "paid",
        "expired",
        "late_paid",
        "payment_exception",
        "cancelled"
      ]
    },
    "revision": {
      "type": "integer"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}
400 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
409 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
422 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
POST/v1/invoices/{invoice_id}/claim-transaction

إرسال معاملة للمراجعة

Submit a transaction for review without changing invoice payment state

المصادقة: مفتاح المشروع في Authorization: Bearer.

المعاملالموقعمطلوبالقواعد
invoice_idpathنعم{"type":"string","format":"uuid"}
Idempotency-Keyheaderنعم{"type":"string","minLength":16,"maxLength":128}
الحقلمطلوبالقواعد
tx_idنعم{"type":"string","minLength":32,"maxLength":128}
عقد جسم الطلب الكامل
JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "tx_id"
  ],
  "properties": {
    "tx_id": {
      "type": "string",
      "minLength": 32,
      "maxLength": 128
    }
  }
}

الاستجابات

202 Claim accepted for review.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "invoice_id",
    "tx_id",
    "status",
    "created_at",
    "invoice_status_changed"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "invoice_id": {
      "type": "string",
      "format": "uuid"
    },
    "tx_id": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "submitted",
        "reviewing",
        "accepted",
        "rejected"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "invoice_status_changed": {
      "const": false
    }
  }
}
400 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
409 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
422 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
POST/v1/test/invoices/{invoice_id}/simulate

محاكاة اختبار

Apply a fake-money scenario to a sandbox invoice

Requires a nbta_test_ API key. This endpoint never calls a blockchain, never uses a real receiving address, and never changes a live invoice. Read the result with `GET /v1/invoices/{invoice_id}` using the same test key; a sandbox invoice has no public checkout page.

المصادقة: مفتاح المشروع في Authorization: Bearer.

المعاملالموقعمطلوبالقواعد
invoice_idpathنعم{"type":"string","format":"uuid"}
Idempotency-Keyheaderنعم{"type":"string","minLength":16,"maxLength":128}
الحقلمطلوبالقواعد
scenarioنعم{"type":"string","enum":["paid_immediately","confirmation_delayed","wrong_amount","wrong_network","expired_unpaid","late_payment","webhook_retry"]}
عقد جسم الطلب الكامل
JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "scenario"
  ],
  "properties": {
    "scenario": {
      "type": "string",
      "enum": [
        "paid_immediately",
        "confirmation_delayed",
        "wrong_amount",
        "wrong_network",
        "expired_unpaid",
        "late_payment",
        "webhook_retry"
      ]
    }
  }
}

الاستجابات

200 The isolated sandbox event produced by the scenario.
application/json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "type",
    "livemode",
    "environment",
    "delivery_status",
    "data"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^evt_test_"
    },
    "type": {
      "type": "string",
      "pattern": "^invoice\\."
    },
    "livemode": {
      "const": false
    },
    "environment": {
      "const": "test"
    },
    "delivery_status": {
      "type": "string",
      "enum": [
        "delivered",
        "retrying"
      ]
    },
    "data": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "invoice_id",
        "status",
        "transaction_id",
        "scenario"
      ],
      "properties": {
        "invoice_id": {
          "type": "string",
          "format": "uuid"
        },
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "observed",
            "paid",
            "expired",
            "late_paid",
            "payment_exception",
            "cancelled"
          ]
        },
        "transaction_id": {
          "type": "string",
          "pattern": "^sim_tx_"
        },
        "scenario": {
          "type": "string"
        },
        "customer": {
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": false,
          "required": [
            "email",
            "name"
          ],
          "description": "Customer details sent at creation, or null when none were sent.",
          "properties": {
            "email": {
              "type": [
                "string",
                "null"
              ],
              "format": "email"
            },
            "name": {
              "type": [
                "string",
                "null"
              ]
            }
          }
        }
      }
    }
  }
}
400 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
404 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
409 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
422 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
GET/public/invoices/{public_id}

قراءة الدفع العام

Read the minimal public checkout projection

The payload includes `server_time`, the gateway clock for this response; judge `expires_at` against it, not the device clock. The endpoint answers `429` with `Retry-After` when the client address or the invoice exceeds its per-minute limit.

عام، لا يحتاج إلى مفتاح API.

المعاملالموقعمطلوبالقواعد
public_idpathنعم{"type":"string","pattern":"^pub_[a-f0-9]{32}$"}

الاستجابات

200 Public invoice projection.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "public_id",
    "project_name",
    "status",
    "payable_amount_atomic",
    "display_decimals",
    "expires_at",
    "receiving_address",
    "payment_route",
    "display_name",
    "network",
    "network_standard",
    "contract_address"
  ],
  "properties": {
    "monitoring_available_until": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "monitoring_available": {
      "type": "boolean",
      "description": "Whether payment monitoring is currently available."
    },
    "monitoring_status": {
      "type": "string",
      "enum": [
        "available",
        "monitoring_unavailable"
      ]
    },
    "server_time": {
      "type": "string",
      "format": "date-time",
      "description": "The gateway clock when this response was produced. Compare\n`expires_at` with this time, not with the device clock, so a device\nwith a wrong clock does not show the invoice expired early or late.\n"
    },
    "public_id": {
      "type": "string"
    },
    "project_name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "observed",
        "paid",
        "expired",
        "late_paid",
        "payment_exception",
        "cancelled"
      ]
    },
    "payable_amount_atomic": {
      "type": "string",
      "pattern": "^[0-9]+$",
      "description": "Integer atomic units serialized as a string."
    },
    "accepted_max_amount_atomic": {
      "type": "string",
      "pattern": "^[0-9]+$",
      "description": "Integer atomic units serialized as a string."
    },
    "received_amount_atomic": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^[0-9]+$",
      "description": "Integer atomic units serialized as a string, or null."
    },
    "overpaid_amount_atomic": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^[0-9]+$",
      "description": "Integer atomic units serialized as a string, or null."
    },
    "display_decimals": {
      "type": "integer"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time"
    },
    "observed_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "paid_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "receiving_address": {
      "type": [
        "string",
        "null"
      ]
    },
    "payment_route": {
      "type": "string"
    },
    "display_name": {
      "type": "string"
    },
    "network": {
      "type": "string"
    },
    "network_standard": {
      "type": "string",
      "description": "TRC-20 belongs to `usdt_tron`, which is paused and currently unavailable.",
      "enum": [
        "TRC-20",
        "BEP-20",
        "ERC-20"
      ]
    },
    "chain_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "contract_address": {
      "type": "string"
    },
    "explorer_base_url": {
      "type": "string",
      "format": "uri",
      "description": "Transaction URL prefix of the network's explorer. Append `transaction.tx_id` to link the settling transfer."
    },
    "finality_confirmations": {
      "type": "integer",
      "minimum": 0,
      "description": "The network's finality depth. 0 or 1 means the gateway counts a\ntransfer once its block is at or below the provider's finalized\nhead; a depth N above 1 also holds back the newest N - 1\nfinalized blocks. The gateway only settles finalized transfers,\nso a transfer appears here once and does not move back.\n"
    },
    "transaction": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "tx_id",
            "block_timestamp",
            "finalized_at"
          ],
          "properties": {
            "tx_id": {
              "type": "string",
              "minLength": 32,
              "maxLength": 128,
              "pattern": "^(?:0x)?[0-9a-fA-F]{30,128}$",
              "description": "Hex hash, bare on TRON and 0x prefixed on EVM networks. Safe to append to `explorer_base_url`."
            },
            "block_timestamp": {
              "type": "string",
              "format": "date-time"
            },
            "finalized_at": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            }
          }
        },
        {
          "type": "null"
        }
      ],
      "description": "The finalized transfer that settled the invoice. Null until the invoice is matched."
    },
    "receipt_email": {
      "type": "boolean",
      "description": "True when the payer will get a receipt email: for a paid or\nlate_paid invoice, a receipt is queued, being sent or sent; for an\nopen invoice, one will be queued when it is paid (the project\nopted in, the invoice carries a customer email and the mailer is\nconfigured). False for a receipt that failed or was cancelled.\nThe address itself is never public.\n"
    },
    "success_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "maxLength": 2048
    },
    "cancel_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "maxLength": 2048
    }
  }
}
404 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
POST/public/invoices/{public_id}/cancel

إلغاء الدافع من صفحة الدفع

The payer leaves an unpaid checkout

Called by the hosted checkout when the payer chooses Cancel and return. It cancels a still pending invoice that has a `cancel_url`, so the project receives the signed `invoice.cancelled` webhook at once instead of waiting for expiry. Repeating it is a no-op and sends no second event. A transfer that still arrives is reconciled as for any cancelled invoice. An invoice that is paid, expired, observed or has no `cancel_url` answers `409 invoice_not_cancellable`. Limited to 10 requests a minute per client address and invoice.

عام، لا يحتاج إلى مفتاح API.

المعاملالموقعمطلوبالقواعد
public_idpathنعم{"type":"string","pattern":"^pub_[a-f0-9]{32}$"}

الاستجابات

200 The invoice is cancelled.
application/json: JSON Schema
{
  "type": "object",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "cancelled"
      ]
    }
  }
}
404 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
409 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
GET/v1/health

حالة الخدمة

Read the gateway liveness state

عام، لا يحتاج إلى مفتاح API.

الاستجابات

200 Gateway process is reachable.
application/json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "status",
    "service",
    "environment"
  ],
  "properties": {
    "status": {
      "const": "ok"
    },
    "service": {
      "const": "nbta-gateway"
    },
    "environment": {
      "type": "string"
    }
  }
}
404 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
GET/v1/account

قراءة الحساب

Read the owner, this key, available networks and wallets

Needs no scope. `wallets` is null unless the key holds `wallets:read`. `networks[].available` is false while payment monitoring on that network cannot accept new liability; such networks cannot be attached. `usdt_tron` (USDT on TRON) is paused and currently unavailable: it is not listed and cannot be attached or invoiced.

المصادقة: مفتاح وكيل الحساب في Authorization: Bearer.

الاستجابات

200 Account overview.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "required": [
    "owner_id",
    "key",
    "networks",
    "wallets",
    "project_count"
  ],
  "properties": {
    "owner_id": {
      "type": "string",
      "format": "uuid"
    },
    "key": {
      "type": "object",
      "required": [
        "id",
        "label",
        "prefix",
        "scopes",
        "project_ids",
        "expires_at",
        "created_at",
        "last_used_at",
        "revoked_at",
        "status"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "label": {
          "type": "string"
        },
        "prefix": {
          "type": "string"
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "projects:read",
              "projects:write",
              "keys:write",
              "webhooks:write",
              "invoices:read",
              "invoices:write",
              "wallets:read",
              "wallets:write"
            ]
          }
        },
        "project_ids": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string",
            "format": "uuid"
          }
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "created_by": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "last_used_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "revoked_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "expired",
            "revoked"
          ]
        }
      }
    },
    "networks": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "asset_name",
          "symbol",
          "network",
          "network_standard",
          "available",
          "status"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "asset_name": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          },
          "network": {
            "type": "string"
          },
          "network_standard": {
            "type": "string"
          },
          "default_wallet_label": {
            "type": "string"
          },
          "available": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "available",
              "monitoring_unavailable"
            ]
          }
        }
      }
    },
    "wallets": {
      "type": [
        "array",
        "null"
      ],
      "description": "Null unless the key holds wallets:read.",
      "items": {
        "type": "object",
        "required": [
          "id",
          "network_asset_id",
          "address",
          "label"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "asset_name": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          },
          "network": {
            "type": "string"
          },
          "network_standard": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "archived_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "projects": {
            "type": "array",
            "description": "Present on `GET /v1/account/wallets`: the projects this wallet\nreceives for, limited to the projects the key can reach.\n",
            "items": {
              "type": "object",
              "required": [
                "id",
                "name",
                "slug",
                "route_id",
                "is_default"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "name": {
                  "type": "string"
                },
                "slug": {
                  "type": "string"
                },
                "route_id": {
                  "type": "string",
                  "format": "uuid"
                },
                "is_default": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      }
    },
    "project_count": {
      "type": "integer"
    },
    "api_base_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri"
    },
    "checkout_base_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri"
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
POST/v1/account/setup

تجهيز مشروع بطلب واحد

Set up a project for an integration in one call

Scopes: `projects:write` and `keys:write`, plus `webhooks:write` when `webhook_url` is sent or `rotate_webhook` is true, and `invoices:read` or `invoices:write` (the project key receives the invoice scopes this key holds). Idempotent by slug: an existing project with the slug is reused, its current wallet per network kept. `slug` defaults to one derived from the `site_url` host, else the name. The project key is shown only once, on the call that creates it. Store `env` in the integrating project's `.env` on the first setup. A key is minted only when the project has no active live key or `rotate_key` is true (`key_created: true`, `api_key.api_key` holds the raw key). Otherwise `key_created` is false and `api_key` describes the newest active live key without its secret. The webhook endpoint is created when missing and updated when `webhook_url` differs; `webhook.changed` tells whether this call did either, and `webhook.signing_secret` is present only then. The same URL changes nothing. Pass `rotate_key: true` only when the stored key is lost, and `rotate_webhook: true` only to replace a leaked signing secret. `wallets[].receiving_address` is present only when the key holds `wallets:read`. When a requested network has no active wallet or more than one, the call changes nothing and answers 409 `wallet_selection_required` with `selections`. Repeat it with `wallet_ids` holding one choice per listed network, or ask the owner to add a wallet in the dashboard.

المصادقة: مفتاح وكيل الحساب في Authorization: Bearer.

الصلاحيات المطلوبة: projects:write, keys:write

الحقلمطلوبالقواعد
nameنعم{"type":"string","minLength":2,"maxLength":80}
slugلا{"type":"string","minLength":2,"maxLength":48,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"}
site_urlلا{"type":"string","format":"uri","pattern":"^https://","description":"The store's public URL. Used to derive the slug when none is sent."}
webhook_urlلا{"type":"string","format":"uri","pattern":"^https://","maxLength":2048}
networksلا{"type":"array","maxItems":10,"items":{"type":"string","pattern":"^[a-z0-9_]{2,40}$","description":"Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n","examples":["bsc_usd_bep20","usdc_bsc","polygon_usdc","polygon_usdt","base_usdc","base_usdt","arbitrum_usdc","arbitrum_usdt"]}}
wallet_idsلا{"type":"array","maxItems":10,"description":"One chosen wallet per network, from a previous wallet_selection_required answer.","items":{"type":"string","format":"uuid"}}
key_labelلا{"type":"string","minLength":2,"maxLength":80,"description":"Label of the issued project key. Defaults to \"Agent setup\"."}
rotate_keyلا{"type":"boolean","description":"Issue a new project key for an existing project. Only pass it when\nthe stored key is lost; the previous key stays active until the\nowner revokes it.\n"}
rotate_webhookلا{"type":"boolean","description":"Rotate the webhook signing secret even when the URL is unchanged.\nRequires `webhooks:write`. The previous secret stays valid for one\nhour.\n"}
عقد جسم الطلب الكامل
JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 80
    },
    "slug": {
      "type": "string",
      "minLength": 2,
      "maxLength": 48,
      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
    },
    "site_url": {
      "type": "string",
      "format": "uri",
      "pattern": "^https://",
      "description": "The store's public URL. Used to derive the slug when none is sent."
    },
    "webhook_url": {
      "type": "string",
      "format": "uri",
      "pattern": "^https://",
      "maxLength": 2048
    },
    "networks": {
      "type": "array",
      "maxItems": 10,
      "items": {
        "type": "string",
        "pattern": "^[a-z0-9_]{2,40}$",
        "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
        "examples": [
          "bsc_usd_bep20",
          "usdc_bsc",
          "polygon_usdc",
          "polygon_usdt",
          "base_usdc",
          "base_usdt",
          "arbitrum_usdc",
          "arbitrum_usdt"
        ]
      }
    },
    "wallet_ids": {
      "type": "array",
      "maxItems": 10,
      "description": "One chosen wallet per network, from a previous wallet_selection_required answer.",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "key_label": {
      "type": "string",
      "minLength": 2,
      "maxLength": 80,
      "description": "Label of the issued project key. Defaults to \"Agent setup\"."
    },
    "rotate_key": {
      "type": "boolean",
      "description": "Issue a new project key for an existing project. Only pass it when\nthe stored key is lost; the previous key stays active until the\nowner revokes it.\n"
    },
    "rotate_webhook": {
      "type": "boolean",
      "description": "Rotate the webhook signing secret even when the URL is unchanged.\nRequires `webhooks:write`. The previous secret stays valid for one\nhour.\n"
    }
  }
}

الاستجابات

200 Existing project set up again. Without `rotate_key` no key is minted and no secret is returned.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "required": [
    "status",
    "project",
    "wallets",
    "key_created",
    "api_key",
    "webhook",
    "env"
  ],
  "properties": {
    "status": {
      "type": "string",
      "const": "ready"
    },
    "key_created": {
      "type": "boolean",
      "description": "True when this call issued a project key; `api_key.api_key` then\nholds it, once. False when the project already had an active live\nkey and `rotate_key` was not set: `api_key` then describes that\nkey without its secret.\n"
    },
    "project": {
      "type": "object",
      "required": [
        "id",
        "name",
        "slug",
        "status",
        "created"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "slug": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "created": {
          "type": "boolean"
        }
      }
    },
    "wallets": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "wallet_id",
          "route_id",
          "changed"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "wallet_id": {
            "type": "string",
            "format": "uuid"
          },
          "receiving_address": {
            "type": "string",
            "description": "Present only when the key holds wallets:read."
          },
          "route_id": {
            "type": "string",
            "format": "uuid",
            "description": "Use as payment_route_id when creating invoices."
          },
          "changed": {
            "type": "boolean"
          }
        }
      }
    },
    "api_key": {
      "type": "object",
      "required": [
        "prefix"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "prefix": {
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "environment": {
          "type": "string",
          "enum": [
            "live",
            "test"
          ]
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "api_key": {
          "type": "string",
          "description": "Raw project key, present only when key_created is true."
        },
        "project_id": {
          "type": "string",
          "format": "uuid"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "webhook": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "url": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "signing_secret": {
          "type": "string",
          "description": "Present only when this call created or changed the endpoint (changed is true)."
        },
        "changed": {
          "type": "boolean",
          "description": "True when this call created the endpoint, changed its URL,\nre-activated it or rotated its secret.\n"
        },
        "project_id": {
          "type": "string",
          "format": "uuid"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "site_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "api_base_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "checkout_base_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "env": {
      "type": "string",
      "description": "Ready .env lines: NBTA_API_URL, plus NBTA_API_KEY and\nNBTA_WEBHOOK_SECRET when this call returned them.\n"
    }
  }
}
201 Project created and set up.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "required": [
    "status",
    "project",
    "wallets",
    "key_created",
    "api_key",
    "webhook",
    "env"
  ],
  "properties": {
    "status": {
      "type": "string",
      "const": "ready"
    },
    "key_created": {
      "type": "boolean",
      "description": "True when this call issued a project key; `api_key.api_key` then\nholds it, once. False when the project already had an active live\nkey and `rotate_key` was not set: `api_key` then describes that\nkey without its secret.\n"
    },
    "project": {
      "type": "object",
      "required": [
        "id",
        "name",
        "slug",
        "status",
        "created"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "slug": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "created": {
          "type": "boolean"
        }
      }
    },
    "wallets": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "wallet_id",
          "route_id",
          "changed"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "wallet_id": {
            "type": "string",
            "format": "uuid"
          },
          "receiving_address": {
            "type": "string",
            "description": "Present only when the key holds wallets:read."
          },
          "route_id": {
            "type": "string",
            "format": "uuid",
            "description": "Use as payment_route_id when creating invoices."
          },
          "changed": {
            "type": "boolean"
          }
        }
      }
    },
    "api_key": {
      "type": "object",
      "required": [
        "prefix"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "prefix": {
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "environment": {
          "type": "string",
          "enum": [
            "live",
            "test"
          ]
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "api_key": {
          "type": "string",
          "description": "Raw project key, present only when key_created is true."
        },
        "project_id": {
          "type": "string",
          "format": "uuid"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "webhook": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "url": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "signing_secret": {
          "type": "string",
          "description": "Present only when this call created or changed the endpoint (changed is true)."
        },
        "changed": {
          "type": "boolean",
          "description": "True when this call created the endpoint, changed its URL,\nre-activated it or rotated its secret.\n"
        },
        "project_id": {
          "type": "string",
          "format": "uuid"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "site_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "api_base_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "checkout_base_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "env": {
      "type": "string",
      "description": "Ready .env lines: NBTA_API_URL, plus NBTA_API_KEY and\nNBTA_WEBHOOK_SECRET when this call returned them.\n"
    }
  }
}
400 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
404 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
409 `wallet_selection_required` (with `selections`), `network_unavailable` or `project_slug_conflict`.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
413 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
GET/v1/account/projects

قائمة المشاريع

List the projects this key can reach

المصادقة: مفتاح وكيل الحساب في Authorization: Bearer.

الصلاحيات المطلوبة: projects:read

الاستجابات

200 Projects with their attached wallets and webhook.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "name",
          "slug",
          "status",
          "payer_receipts_enabled",
          "wallets",
          "webhook",
          "active_api_keys"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "disabled"
            ]
          },
          "payer_receipts_enabled": {
            "type": "boolean",
            "description": "True when payers whose invoice carries customer.email get a receipt email once it is paid."
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "wallets": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "network_asset_id",
                "wallet_id",
                "route_id",
                "is_default"
              ],
              "properties": {
                "network_asset_id": {
                  "type": "string",
                  "pattern": "^[a-z0-9_]{2,40}$",
                  "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
                  "examples": [
                    "bsc_usd_bep20",
                    "usdc_bsc",
                    "polygon_usdc",
                    "polygon_usdt",
                    "base_usdc",
                    "base_usdt",
                    "arbitrum_usdc",
                    "arbitrum_usdt"
                  ]
                },
                "wallet_id": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "uuid"
                },
                "receiving_address": {
                  "type": "string",
                  "description": "Present only when the key holds wallets:read."
                },
                "route_id": {
                  "type": "string",
                  "format": "uuid",
                  "description": "Use as payment_route_id when creating invoices."
                },
                "is_default": {
                  "type": "boolean"
                }
              }
            }
          },
          "webhook": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "url": {
                "type": "string"
              },
              "status": {
                "type": "string"
              }
            }
          },
          "active_api_keys": {
            "type": "integer"
          }
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
POST/v1/account/projects

إنشاء مشروع

Create a project

Refused with `project_not_allowed` for keys restricted to selected projects.

المصادقة: مفتاح وكيل الحساب في Authorization: Bearer.

الصلاحيات المطلوبة: projects:write

الحقلمطلوبالقواعد
nameنعم{"type":"string","minLength":2,"maxLength":80}
slugلا{"type":"string","minLength":2,"maxLength":48,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"}
عقد جسم الطلب الكامل
JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 80
    },
    "slug": {
      "type": "string",
      "minLength": 2,
      "maxLength": 48,
      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
    }
  }
}

الاستجابات

201 Project created.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "required": [
    "id",
    "name",
    "slug",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "disabled"
      ]
    },
    "payer_receipts_enabled": {
      "type": "boolean",
      "description": "Returned by the update. True when payers get a receipt email."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}
400 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
409 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
413 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
POST/v1/account/projects/{project_id}/keys

إصدار مفتاح مشروع

Issue a project API key

The key's scopes must be a subset of the agent key's scopes. The raw `api_key` is returned once; write it to the project's `.env` as `NBTA_API_KEY`. The key records the member who created the agent key and is revoked if that member is removed or demoted.

المصادقة: مفتاح وكيل الحساب في Authorization: Bearer.

الصلاحيات المطلوبة: keys:write

المعاملالموقعمطلوبالقواعد
project_idpathنعم{"type":"string","format":"uuid"}
الحقلمطلوبالقواعد
labelلا{"type":"string","minLength":2,"maxLength":80,"default":"Agent key"}
scopesلا{"type":"array","minItems":1,"items":{"type":"string","enum":["invoices:read","invoices:write"]},"default":["invoices:read","invoices:write"]}
environmentلا{"type":"string","enum":["live","test"],"default":"live"}
عقد جسم الطلب الكامل
JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "label": {
      "type": "string",
      "minLength": 2,
      "maxLength": 80,
      "default": "Agent key"
    },
    "scopes": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "string",
        "enum": [
          "invoices:read",
          "invoices:write"
        ]
      },
      "default": [
        "invoices:read",
        "invoices:write"
      ]
    },
    "environment": {
      "type": "string",
      "enum": [
        "live",
        "test"
      ],
      "default": "live"
    }
  }
}

الاستجابات

201 Key created. `api_key` is shown only here.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "required": [
    "id",
    "project_id",
    "prefix",
    "label",
    "environment",
    "scopes",
    "api_key",
    "created_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "project_id": {
      "type": "string",
      "format": "uuid"
    },
    "prefix": {
      "type": "string"
    },
    "label": {
      "type": "string"
    },
    "environment": {
      "type": "string",
      "enum": [
        "live",
        "test"
      ]
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "invoices:read",
          "invoices:write"
        ]
      }
    },
    "api_key": {
      "type": "string",
      "description": "Raw project key, shown once. Store it as NBTA_API_KEY."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}
400 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
404 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
413 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
POST/v1/account/projects/{project_id}/webhooks

ضبط webhook المشروع

Set the project's webhook endpoint and rotate its signing secret

A project has one endpoint. Calling this again changes the URL and rotates the secret; the previous secret stays valid for one hour. Write `signing_secret` to the project's `.env` as `NBTA_WEBHOOK_SECRET`. Saving an endpoint also releases events held for up to 7 days after a previous endpoint answered `410`; they are sent again in their original order.

المصادقة: مفتاح وكيل الحساب في Authorization: Bearer.

الصلاحيات المطلوبة: webhooks:write

المعاملالموقعمطلوبالقواعد
project_idpathنعم{"type":"string","format":"uuid"}
الحقلمطلوبالقواعد
urlنعم{"type":"string","format":"uri","maxLength":2048,"pattern":"^https://"}
عقد جسم الطلب الكامل
JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "pattern": "^https://"
    }
  }
}

الاستجابات

201 Endpoint set. `signing_secret` is shown only here.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "required": [
    "id",
    "project_id",
    "url",
    "status",
    "signing_secret"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "project_id": {
      "type": "string",
      "format": "uuid"
    },
    "url": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "signing_secret": {
      "type": "string",
      "description": "Signing secret, shown once. Store it as NBTA_WEBHOOK_SECRET."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}
400 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
404 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
413 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
GET/v1/account/projects/{project_id}/webhook

حالة webhook المشروع

Read the project's webhook health

Read only. Reports whether the project has an endpoint, its status, how many events wait in each state and the latest delivery attempt. An endpoint that answered `410` is `disabled`; the project's other pending events are then `held` for up to 7 days and `earliest_held_until` shows the soonest hold end. Saving a new endpoint (`POST /v1/account/projects/{project_id}/webhooks`) sends held events again in their original order; held events that pass their hold become `expired` and are never deleted. The response never contains a signing secret, a signature or an event payload.

المصادقة: مفتاح وكيل الحساب في Authorization: Bearer.

الصلاحيات المطلوبة: projects:read

المعاملالموقعمطلوبالقواعد
project_idpathنعم{"type":"string","format":"uuid"}

الاستجابات

200 Webhook health of the project.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "required": [
    "project_id",
    "configured",
    "url",
    "status",
    "events",
    "earliest_held_until",
    "last_attempt"
  ],
  "properties": {
    "project_id": {
      "type": "string",
      "format": "uuid"
    },
    "configured": {
      "type": "boolean",
      "description": "True when the project has a webhook endpoint."
    },
    "endpoint_id": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "description": "The stored endpoint URL, as the project list reports it."
    },
    "status": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "active",
        "disabled",
        null
      ],
      "description": "Endpoint status. `disabled` after a `410` answer."
    },
    "events": {
      "type": "object",
      "required": [
        "pending",
        "processing",
        "held",
        "expired",
        "dead",
        "delivered_7d"
      ],
      "properties": {
        "pending": {
          "type": "integer"
        },
        "processing": {
          "type": "integer"
        },
        "held": {
          "type": "integer",
          "description": "Parked for up to 7 days after a `410`; replayed when a new endpoint is saved."
        },
        "expired": {
          "type": "integer",
          "description": "Held events whose hold ended. Never deleted."
        },
        "dead": {
          "type": "integer"
        },
        "delivered_7d": {
          "type": "integer",
          "description": "Delivered in the last 7 days."
        }
      }
    },
    "earliest_held_until": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the soonest held event expires, or null."
    },
    "last_attempt": {
      "type": [
        "object",
        "null"
      ],
      "description": "The latest delivery attempt across the project, or null.",
      "required": [
        "attempted_at",
        "http_status",
        "error_code"
      ],
      "properties": {
        "attempted_at": {
          "type": "string",
          "format": "date-time"
        },
        "http_status": {
          "type": [
            "integer",
            "null"
          ]
        },
        "error_code": {
          "type": [
            "string",
            "null"
          ],
          "description": "Coarse class such as `http_4xx`, `http_5xx`, `http_429` or `delivery_failed`; null on success."
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
404 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
GET/v1/account/wallets

قائمة المحافظ

List the account's receiving wallets

Active wallets by default; `include_archived=true` adds archived ones. `projects` lists the projects each wallet receives for, limited to the projects this key can reach.

المصادقة: مفتاح وكيل الحساب في Authorization: Bearer.

الصلاحيات المطلوبة: wallets:read

المعاملالموقعمطلوبالقواعد
include_archivedqueryلا{"type":"boolean","default":false}

الاستجابات

200 Receiving wallets with the projects they are attached to.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "network_asset_id",
          "address",
          "label"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "asset_name": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          },
          "network": {
            "type": "string"
          },
          "network_standard": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "archived_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "projects": {
            "type": "array",
            "description": "Present on `GET /v1/account/wallets`: the projects this wallet\nreceives for, limited to the projects the key can reach.\n",
            "items": {
              "type": "object",
              "required": [
                "id",
                "name",
                "slug",
                "route_id",
                "is_default"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "name": {
                  "type": "string"
                },
                "slug": {
                  "type": "string"
                },
                "route_id": {
                  "type": "string",
                  "format": "uuid"
                },
                "is_default": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
POST/v1/account/wallets

إضافة محفظة

Add a receiving wallet to the account

Needs `wallets:write`, which is off by default because a receiving address decides where money goes. Prefer asking the owner to add wallets in the dashboard. Refused with 409 `network_unavailable` while monitoring on the network cannot accept new liability.

المصادقة: مفتاح وكيل الحساب في Authorization: Bearer.

الصلاحيات المطلوبة: wallets:write

الحقلمطلوبالقواعد
network_asset_idنعم{"type":"string","pattern":"^[a-z0-9_]{2,40}$","description":"Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n","examples":["bsc_usd_bep20","usdc_bsc","polygon_usdc","polygon_usdt","base_usdc","base_usdt","arbitrum_usdc","arbitrum_usdt"]}
addressنعم{"type":"string","minLength":20,"maxLength":128}
labelلا{"type":"string","minLength":1,"maxLength":80}
عقد جسم الطلب الكامل
JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "network_asset_id",
    "address"
  ],
  "properties": {
    "network_asset_id": {
      "type": "string",
      "pattern": "^[a-z0-9_]{2,40}$",
      "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
      "examples": [
        "bsc_usd_bep20",
        "usdc_bsc",
        "polygon_usdc",
        "polygon_usdt",
        "base_usdc",
        "base_usdt",
        "arbitrum_usdc",
        "arbitrum_usdt"
      ]
    },
    "address": {
      "type": "string",
      "minLength": 20,
      "maxLength": 128
    },
    "label": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    }
  }
}

الاستجابات

201 Wallet created.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

application/json: JSON Schema
{
  "type": "object",
  "required": [
    "id",
    "network_asset_id",
    "address",
    "label"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "network_asset_id": {
      "type": "string",
      "pattern": "^[a-z0-9_]{2,40}$",
      "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
      "examples": [
        "bsc_usd_bep20",
        "usdc_bsc",
        "polygon_usdc",
        "polygon_usdt",
        "base_usdc",
        "base_usdt",
        "arbitrum_usdc",
        "arbitrum_usdt"
      ]
    },
    "asset_name": {
      "type": "string"
    },
    "symbol": {
      "type": "string"
    },
    "network": {
      "type": "string"
    },
    "network_standard": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "label": {
      "type": "string"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "archived_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "projects": {
      "type": "array",
      "description": "Present on `GET /v1/account/wallets`: the projects this wallet\nreceives for, limited to the projects the key can reach.\n",
      "items": {
        "type": "object",
        "required": [
          "id",
          "name",
          "slug",
          "route_id",
          "is_default"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "route_id": {
            "type": "string",
            "format": "uuid"
          },
          "is_default": {
            "type": "boolean"
          }
        }
      }
    }
  }
}
400 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
401 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
403 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
409 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
413 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
429 The caller exhausted the current fixed-window quota.

ترويسات الاستجابة: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After

application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
503 RFC 9457-style problem response.
application/problem+json: JSON Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "request_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "selections": {
      "type": "array",
      "description": "Present on wallet_selection_required only.",
      "items": {
        "type": "object",
        "required": [
          "network_asset_id",
          "reason",
          "choices"
        ],
        "properties": {
          "network_asset_id": {
            "type": "string",
            "pattern": "^[a-z0-9_]{2,40}$",
            "description": "Payment network and asset. `usdt_tron` (USDT on TRON) is paused and\ncurrently unavailable: routes on it are not listed, invoices on it\nfail with `payment_route_unavailable` and wallets cannot be attached\nto it.\n",
            "examples": [
              "bsc_usd_bep20",
              "usdc_bsc",
              "polygon_usdc",
              "polygon_usdt",
              "base_usdc",
              "base_usdt",
              "arbitrum_usdc",
              "arbitrum_usdt"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "no_wallet",
              "multiple_wallets"
            ]
          },
          "choices": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "address"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "label": {
                  "type": "string"
                },
                "address": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

صيغة الأخطاء

application/problem+json
{
  "type": "https://nbta.sbarah.com/docs/errors/idempotency_conflict",
  "title": "Idempotency conflict",
  "status": 409,
  "code": "idempotency_conflict",
  "detail": "The idempotency key was already used with a different request.",
  "request_id": "00000000-0000-4000-8000-000000000042"
}

401: مفتاح مفقود أو غير صالح. 403: صلاحية أو بيئة غير مسموحة. 409: تعارض منع التكرار أو المراجعة أو حالة الفاتورة. 422: بيانات غير صالحة. 429: انتظر Retry-After قبل الإعادة. 503: الخدمة غير متاحة مؤقتاً، أعد المحاولة تدريجياً بنفس مفتاح منع التكرار. احتفظ بـ request_id للدعم ولا تسجل المفاتيح السرية. راجع جدول كل مسار لمعرفة الحالات المتاحة له.