2020-06-24 10:34:09 +09:00
{
"paths" : {
"/api/v1/stores/{storeId}/pull-payments" : {
"parameters" : [
{
"name" : "storeId" ,
"in" : "path" ,
"required" : true ,
"description" : "The store ID" ,
2022-04-24 05:19:34 +02:00
"schema" : {
"type" : "string"
}
2020-06-24 10:34:09 +09:00
}
] ,
"get" : {
2020-12-04 12:03:27 +01:00
"operationId" : "PullPayments_GetPullPayments" ,
2020-06-24 10:34:09 +09:00
"summary" : "Get store's pull payments" ,
"parameters" : [
{
"name" : "includeArchived" ,
"in" : "query" ,
"required" : false ,
"description" : "Whether this should list archived pull payments" ,
"schema" : {
"type" : "boolean" ,
"default" : false
}
}
] ,
"description" : "Get the pull payments of a store" ,
"responses" : {
"200" : {
"description" : "List of pull payments" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PullPaymentDataList"
}
}
}
}
} ,
2022-04-24 05:19:34 +02:00
"tags" : [
"Pull payments (Management)"
] ,
2020-06-24 10:34:09 +09:00
"security" : [
{
2022-02-02 03:12:48 -08:00
"API_Key" : [
2020-06-24 10:34:09 +09:00
"btcpay.store.canmanagepullpayments"
] ,
"Basic" : [ ]
}
]
} ,
"post" : {
2020-12-04 12:03:27 +01:00
"operationId" : "PullPayments_CreatePullPayment" ,
2020-06-24 10:34:09 +09:00
"summary" : "Create a new pull payment" ,
"description" : "A pull payment allows its receiver to ask for payouts up to `amount` of `currency` every `period`." ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"properties" : {
"name" : {
"type" : "string" ,
"description" : "The name of the pull payment" ,
"nullable" : true
} ,
2022-02-09 21:54:00 -08:00
"description" : {
"type" : "string" ,
"description" : "The description of the pull payment" ,
"nullable" : true
} ,
2020-06-24 10:34:09 +09:00
"amount" : {
"type" : "string" ,
"format" : "decimal" ,
"example" : "0.1" ,
"description" : "The amount in `currency` of this pull payment as a decimal string"
} ,
"currency" : {
"type" : "string" ,
"example" : "BTC" ,
2021-10-18 05:37:59 +02:00
"description" : "The currency of the amount."
2020-06-24 10:34:09 +09:00
} ,
"period" : {
"type" : "integer" ,
"format" : "decimal" ,
"example" : 604800 ,
"nullable" : true ,
"description" : "The length of each period in seconds."
} ,
2022-01-24 20:17:09 +09:00
"BOLT11Expiration" : {
"type" : "string" ,
"example" : 30 ,
"default" : 30 ,
"nullable" : true ,
"description" : "If lightning is activated, do not accept BOLT11 invoices with expiration less than … days"
} ,
2022-04-29 08:58:17 +02:00
"autoApproveClaims" : {
"type" : "boolean" ,
"example" : false ,
"default" : false ,
"nullable" : true ,
"description" : "Any payouts created for this pull payment will skip the approval phase upon creation"
} ,
2020-06-24 10:34:09 +09:00
"startsAt" : {
"type" : "integer" ,
2021-03-30 04:18:00 +02:00
"format" : "unix timestamp in seconds" ,
2020-06-24 10:34:09 +09:00
"example" : 1592312018 ,
"nullable" : true ,
2021-03-30 04:18:00 +02:00
"description" : "When this pull payment is effective. Already started if null or unspecified."
2020-06-24 10:34:09 +09:00
} ,
"expiresAt" : {
"type" : "integer" ,
2021-03-30 04:18:00 +02:00
"format" : "unix timestamp in seconds" ,
2020-06-24 10:34:09 +09:00
"example" : 1593129600 ,
"nullable" : true ,
2021-03-30 04:18:00 +02:00
"description" : "When this pull payment expires. Never expires if null or unspecified."
2020-06-24 10:34:09 +09:00
} ,
"paymentMethods" : {
"type" : "array" ,
2021-10-18 05:37:59 +02:00
"description" : "The list of supported payment methods supported by this pull payment. Available options can be queried from the `StorePaymentMethods_GetStorePaymentMethods` endpoint" ,
2020-06-24 10:34:09 +09:00
"items" : {
"type" : "string" ,
"example" : "BTC"
}
}
}
}
}
}
} ,
"responses" : {
"200" : {
"description" : "The create pull payment" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PullPaymentData"
}
}
}
} ,
"422" : {
"description" : "Unable to validate the request" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ValidationProblemDetails"
}
}
}
}
} ,
2022-04-24 05:19:34 +02:00
"tags" : [
"Pull payments (Management)"
] ,
2020-06-24 10:34:09 +09:00
"security" : [
{
2022-02-02 03:12:48 -08:00
"API_Key" : [
2020-06-24 10:34:09 +09:00
"btcpay.store.canmanagepullpayments"
] ,
"Basic" : [ ]
}
]
}
} ,
"/api/v1/pull-payments/{pullPaymentId}" : {
"parameters" : [
{
"name" : "pullPaymentId" ,
"in" : "path" ,
"required" : true ,
"description" : "The ID of the pull payment" ,
2022-04-24 05:19:34 +02:00
"schema" : {
"type" : "string"
}
2020-06-24 10:34:09 +09:00
}
] ,
"get" : {
2020-12-04 12:03:27 +01:00
"summary" : "Get Pull Payment" ,
"operationId" : "PullPayments_GetPullPayment" ,
2020-06-24 10:34:09 +09:00
"description" : "Get a pull payment" ,
"responses" : {
"200" : {
"description" : "Information about the pull payment" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PullPaymentData"
}
}
}
} ,
"404" : {
"description" : "Pull payment not found"
}
} ,
2022-04-24 05:19:34 +02:00
"tags" : [
"Pull payments (Public)"
] ,
2020-06-24 10:34:09 +09:00
"security" : [ ]
}
} ,
"/api/v1/stores/{storeId}/pull-payments/{pullPaymentId}" : {
"parameters" : [
{
"name" : "storeId" ,
"in" : "path" ,
"required" : true ,
"description" : "The ID of the store" ,
2022-04-24 05:19:34 +02:00
"schema" : {
"type" : "string"
}
2020-06-24 10:34:09 +09:00
} ,
{
"name" : "pullPaymentId" ,
"in" : "path" ,
"required" : true ,
"description" : "The ID of the pull payment" ,
2022-04-24 05:19:34 +02:00
"schema" : {
"type" : "string"
}
2020-06-24 10:34:09 +09:00
}
] ,
"delete" : {
2020-12-04 12:03:27 +01:00
"operationId" : "PullPayments_ArchivePullPayment" ,
2020-06-24 10:34:09 +09:00
"summary" : "Archive a pull payment" ,
"description" : "Archive this pull payment (Will cancel all payouts awaiting for payment)" ,
"responses" : {
"200" : {
"description" : "The pull payment has been archived"
} ,
"404" : {
"description" : "The pull payment has not been found, or does not belong to this store"
}
} ,
2022-04-24 05:19:34 +02:00
"tags" : [
"Pull payments (Management)"
] ,
2020-06-24 10:34:09 +09:00
"security" : [
{
2022-02-02 03:12:48 -08:00
"API_Key" : [
2020-06-24 10:34:09 +09:00
"btcpay.store.canmanagepullpayments"
] ,
"Basic" : [ ]
}
]
}
} ,
"/api/v1/pull-payments/{pullPaymentId}/payouts" : {
"parameters" : [
{
"name" : "pullPaymentId" ,
"in" : "path" ,
"required" : true ,
"description" : "The ID of the pull payment" ,
2022-04-24 05:19:34 +02:00
"schema" : {
"type" : "string"
}
2020-06-24 10:34:09 +09:00
}
] ,
"get" : {
2020-12-04 12:03:27 +01:00
"summary" : "Get Payouts" ,
"operationId" : "PullPayments_GetPayouts" ,
2020-06-24 10:34:09 +09:00
"description" : "Get payouts" ,
"parameters" : [
{
"name" : "includeCancelled" ,
"in" : "query" ,
"required" : false ,
"description" : "Whether this should list cancelled payouts" ,
"schema" : {
"type" : "boolean" ,
"default" : false
}
}
] ,
"responses" : {
"200" : {
"description" : "The payouts of the pull payment" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PayoutDataList"
}
}
}
} ,
"404" : {
"description" : "Pull payment not found"
}
} ,
2022-04-24 05:19:34 +02:00
"tags" : [
"Pull payments (Public)"
] ,
2020-06-24 10:34:09 +09:00
"security" : [ ]
} ,
"post" : {
2020-12-04 12:03:27 +01:00
"summary" : "Create Payout" ,
2020-06-24 10:34:09 +09:00
"description" : "Create a new payout" ,
2020-12-04 12:03:27 +01:00
"operationId" : "PullPayments_CreatePayout" ,
"requestBody" : {
"x-name" : "request" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreatePayoutRequest"
}
}
} ,
"required" : true ,
"x-position" : 1
} ,
2020-06-24 10:34:09 +09:00
"responses" : {
"200" : {
"description" : "A new payout has been created" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PayoutData"
}
}
}
} ,
"404" : {
"description" : "Pull payment not found"
} ,
"422" : {
"description" : "Unable to validate the request" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ValidationProblemDetails"
}
}
}
} ,
"400" : {
"description" : "Wellknown error codes are: `duplicate-destination`, `expired`, `not-started`, `archived`, `overdraft`, `amount-too-low`, `payment-method-not-supported`" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
} ,
2022-04-24 05:19:34 +02:00
"tags" : [
"Pull payments (Public)"
] ,
2020-06-24 10:34:09 +09:00
"security" : [ ]
}
} ,
2021-11-14 21:25:59 -08:00
"/api/v1/pull-payments/{pullPaymentId}/payouts/{payoutId}" : {
"parameters" : [
{
"name" : "pullPaymentId" ,
"in" : "path" ,
"required" : true ,
"description" : "The ID of the pull payment" ,
2022-04-24 05:19:34 +02:00
"schema" : {
"type" : "string"
}
2021-11-14 21:25:59 -08:00
} ,
{
"name" : "payoutId" ,
"in" : "path" ,
"required" : true ,
"description" : "The ID of the pull payment payout" ,
2022-04-24 05:19:34 +02:00
"schema" : {
"type" : "string"
}
2021-11-14 21:25:59 -08:00
}
] ,
"get" : {
"summary" : "Get Payout" ,
"operationId" : "PullPayments_GetPayout" ,
"description" : "Get payout" ,
"responses" : {
"200" : {
"description" : "A specific payout of a pull payment" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PayoutData"
}
}
}
} ,
"404" : {
"description" : "Pull payment payout not found"
}
} ,
2022-04-24 05:19:34 +02:00
"tags" : [
"Pull payments (Public)" ,
"Pull payments payout (Public)"
] ,
"security" : [ ]
}
} ,
"/api/v1/stores/{storeId}/payouts" : {
"parameters" : [
{
"name" : "storeId" ,
"in" : "path" ,
"required" : true ,
"description" : "The ID of the store" ,
"schema" : {
"type" : "string"
}
}
] ,
"post" : {
"summary" : "Create Payout " ,
"description" : "Create a new payout" ,
"operationId" : "Payouts_CreatePayoutThroughStore" ,
"requestBody" : {
"x-name" : "request" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreatePayoutThroughStoreRequest"
}
}
} ,
"required" : true ,
"x-position" : 1
} ,
"responses" : {
"200" : {
"description" : "A new payout has been created" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PayoutData"
}
}
}
} ,
"404" : {
"description" : "store not found"
} ,
"422" : {
"description" : "Unable to validate the request" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ValidationProblemDetails"
}
}
}
} ,
"400" : {
"description" : "Wellknown error codes are: `duplicate-destination`, `expired`, `not-started`, `archived`, `overdraft`, `amount-too-low`, `payment-method-not-supported`" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
} ,
"tags" : [
"Stores (Payouts)"
] ,
"security" : [
{
"API_Key" : [
"btcpay.store.canmanagepullpayments"
] ,
"Basic" : [ ]
}
]
} ,
"get" : {
"summary" : "Get Store Payouts" ,
"operationId" : "PullPayments_GetStorePayouts" ,
"description" : "Get payouts" ,
"parameters" : [
{
"name" : "includeCancelled" ,
"in" : "query" ,
"required" : false ,
"description" : "Whether this should list cancelled payouts" ,
"schema" : {
"type" : "boolean" ,
"default" : false
}
}
] ,
"responses" : {
"200" : {
"description" : "The payouts of the store" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PayoutDataList"
}
}
}
} ,
"404" : {
"description" : "Pull payment not found"
}
} ,
"tags" : [
"Stores (Payouts)"
] ,
2021-11-14 21:25:59 -08:00
"security" : [ ]
}
} ,
2020-06-24 10:34:09 +09:00
"/api/v1/stores/{storeId}/payouts/{payoutId}" : {
"parameters" : [
{
"name" : "storeId" ,
"in" : "path" ,
"required" : true ,
"description" : "The ID of the store" ,
2022-04-24 05:19:34 +02:00
"schema" : {
"type" : "string"
}
2020-06-24 10:34:09 +09:00
} ,
{
"name" : "payoutId" ,
"in" : "path" ,
"required" : true ,
"description" : "The ID of the payout" ,
2022-04-24 05:19:34 +02:00
"schema" : {
"type" : "string"
}
2020-06-24 10:34:09 +09:00
}
] ,
2020-06-24 13:44:26 +09:00
"post" : {
2020-12-04 12:03:27 +01:00
"summary" : "Approve Payout" ,
"operationId" : "PullPayments_ApprovePayout" ,
2020-06-24 13:44:26 +09:00
"description" : "Approve a payout" ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"properties" : {
"revision" : {
"type" : "integer" ,
"description" : "The revision number of the payout being modified"
} ,
"rateRule" : {
"type" : "string" ,
"nullable" : true ,
"example" : "kraken(BTC_USD)" ,
"description" : "The rate rule to calculate the rate of the payout. This can also be a fixed decimal. (if null or unspecified, will use the same rate setting as the store's settings)"
}
}
}
}
}
} ,
"responses" : {
"200" : {
"description" : "The payout has been approved, transitioning to `AwaitingPayment` state." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PayoutData"
}
}
}
} ,
"422" : {
"description" : "Unable to validate the request" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ValidationProblemDetails"
}
}
}
} ,
"400" : {
"description" : "Wellknown error codes are: `rate-unavailable`, `invalid-state`, `amount-too-low`, `old-revision`" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
} ,
"404" : {
"description" : "The payout is not found"
}
2020-07-17 22:30:53 +09:00
} ,
2022-04-24 05:19:34 +02:00
"tags" : [
"Stores (Payouts)"
] ,
2020-07-17 22:30:53 +09:00
"security" : [
{
2022-02-02 03:12:48 -08:00
"API_Key" : [
2020-07-17 22:30:53 +09:00
"btcpay.store.canmanagepullpayments"
] ,
"Basic" : [ ]
}
]
2020-06-24 13:44:26 +09:00
} ,
2020-06-24 10:34:09 +09:00
"delete" : {
2020-12-04 12:03:27 +01:00
"summary" : "Cancel Payout" ,
2020-06-24 10:34:09 +09:00
"description" : "Cancel the payout" ,
2020-12-04 12:03:27 +01:00
"operationId" : "PullPayments_CancelPayout" ,
2020-06-24 10:34:09 +09:00
"responses" : {
"200" : {
"description" : "The payout has been cancelled"
} ,
"404" : {
"description" : "The payout is not found"
}
} ,
2022-04-24 05:19:34 +02:00
"tags" : [
"Stores (Payouts)"
] ,
2020-06-24 10:34:09 +09:00
"security" : [
{
2022-02-02 03:12:48 -08:00
"API_Key" : [
2020-06-24 10:34:09 +09:00
"btcpay.store.canmanagepullpayments"
] ,
"Basic" : [ ]
2021-06-10 11:43:45 +02:00
}
]
}
} ,
"/api/v1/stores/{storeId}/payouts/{payoutId}/mark-paid" : {
"parameters" : [
{
"name" : "storeId" ,
"in" : "path" ,
"required" : true ,
"description" : "The ID of the store" ,
2022-04-24 05:19:34 +02:00
"schema" : {
"type" : "string"
}
2021-06-10 11:43:45 +02:00
} ,
{
"name" : "payoutId" ,
"in" : "path" ,
"required" : true ,
"description" : "The ID of the payout" ,
2022-04-24 05:19:34 +02:00
"schema" : {
"type" : "string"
}
2021-06-10 11:43:45 +02:00
}
] ,
"post" : {
"summary" : "Mark Payout as Paid" ,
"operationId" : "PullPayments_MarkPayoutPaid" ,
"description" : "Mark a payout as paid" ,
"responses" : {
"200" : {
2022-04-24 05:19:34 +02:00
"description" : "The payout has been marked paid, transitioning to `Completed` state."
2021-06-10 11:43:45 +02:00
} ,
"422" : {
"description" : "Unable to validate the request" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ValidationProblemDetails"
}
}
}
} ,
"400" : {
"description" : "Wellknown error codes are: `invalid-state`" ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
} ,
"404" : {
"description" : "The payout is not found"
}
} ,
2022-04-24 05:19:34 +02:00
"tags" : [
"Stores (Payouts)"
] ,
2021-06-10 11:43:45 +02:00
"security" : [
{
2022-02-02 03:12:48 -08:00
"API_Key" : [
2021-06-10 11:43:45 +02:00
"btcpay.store.canmanagepullpayments"
] ,
"Basic" : [ ]
2020-06-24 10:34:09 +09:00
}
]
}
}
} ,
"components" : {
"schemas" : {
"PullPaymentDataList" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/PullPaymentData"
}
} ,
"PayoutDataList" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/PayoutData"
}
} ,
2020-12-04 12:03:27 +01:00
"CreatePayoutRequest" : {
"type" : "object" ,
2022-04-21 12:30:49 +09:00
"properties" : {
2020-12-04 12:03:27 +01:00
"destination" : {
"type" : "string" ,
"example" : "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2" ,
"description" : "The destination of the payout (can be an address or a BIP21 url)"
} ,
"amount" : {
"type" : "string" ,
"format" : "decimal" ,
"example" : "10399.18" ,
"description" : "The amount of the payout in the currency of the pull payment (eg. USD)."
} ,
"paymentMethod" : {
"type" : "string" ,
"example" : "BTC" ,
"description" : "The payment method of the payout"
}
2022-04-21 12:30:49 +09:00
}
2020-12-04 12:03:27 +01:00
} ,
2022-04-24 05:19:34 +02:00
"CreatePayoutThroughStoreRequest" : {
"allOf" : [
{
"$ref" : "#/components/schemas/CreatePayoutRequest"
} ,
{
"type" : "object" ,
"properties" : {
"pullPaymentId" : {
"type" : "string" ,
"description" : "The pull payment to create this for. Optional."
} ,
"approved" : {
"type" : "boolean" ,
"description" : "Whether to approve this payout automatically upon creation"
}
}
}
]
} ,
2020-06-24 10:34:09 +09:00
"PayoutData" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"description" : "The id of the payout"
} ,
2020-06-24 13:44:26 +09:00
"revision" : {
"type" : "integer" ,
"description" : "The revision number of the payout. This revision number is incremented when the payout amount or destination is modified before the approval."
} ,
2020-06-24 10:34:09 +09:00
"pullPaymentId" : {
"type" : "string" ,
"description" : "The id of the pull payment this payout belongs to"
} ,
"date" : {
"type" : "string" ,
"description" : "The creation date of the payout as a unix timestamp"
} ,
"destination" : {
"type" : "string" ,
"example" : "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2" ,
"description" : "The destination of the payout (can be an address or a BIP21 url)"
} ,
"amount" : {
"type" : "string" ,
"format" : "decimal" ,
"example" : "10399.18" ,
2020-06-24 13:44:26 +09:00
"description" : "The amount of the payout in the currency of the pull payment (eg. USD)."
2020-06-24 10:34:09 +09:00
} ,
"paymentMethod" : {
"type" : "string" ,
"example" : "BTC" ,
2021-11-14 21:25:59 -08:00
"description" : "The payment method of the payout (e.g., \"BTC\" or \"BTC_LightningLike\""
} ,
"cryptoCode" : {
"type" : "string" ,
"example" : "BTC" ,
"description" : "Crypto code of the payment method of the payout (e.g., \"BTC\" or \"LTC\")"
2020-06-24 10:34:09 +09:00
} ,
"paymentMethodAmount" : {
"type" : "string" ,
"format" : "decimal" ,
2020-06-24 13:44:26 +09:00
"nullable" : true ,
2020-06-24 10:34:09 +09:00
"example" : "1.12300000" ,
2020-06-24 13:44:26 +09:00
"description" : "The amount of the payout in the currency of the payment method (eg. BTC). This is only available from the `AwaitingPayment` state."
2020-06-24 10:34:09 +09:00
} ,
"state" : {
"type" : "string" ,
"example" : "AwaitingPayment" ,
2020-06-24 13:44:26 +09:00
"description" : "The state of the payout (`AwaitingApproval`, `AwaitingPayment`, `InProgress`, `Completed`, `Cancelled`)" ,
2020-06-24 10:34:09 +09:00
"x-enumNames" : [
2020-06-24 13:44:26 +09:00
"AwaitingApproval" ,
2020-06-24 10:34:09 +09:00
"AwaitingPayment" ,
"InProgress" ,
"Completed" ,
"Cancelled"
] ,
"enum" : [
2020-06-24 13:44:26 +09:00
"AwaitingApproval" ,
2020-06-24 10:34:09 +09:00
"AwaitingPayment" ,
"InProgress" ,
"Completed" ,
"Cancelled"
]
}
}
} ,
"PullPaymentData" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"description" : "Id of the pull payment"
} ,
"name" : {
"type" : "string" ,
2022-02-09 21:54:00 -08:00
"description" : "Name given to pull payment when it was created"
} ,
"description" : {
"type" : "string" ,
"description" : "Description given to pull payment when it was created"
2020-06-24 10:34:09 +09:00
} ,
"currency" : {
"type" : "string" ,
"example" : "BTC" ,
"description" : "The currency of the pull payment's amount"
} ,
"amount" : {
"type" : "string" ,
"format" : "decimal" ,
"example" : "1.12000000" ,
"description" : "The amount in the currency of this pull payment as a decimal string"
} ,
"period" : {
"type" : "integer" ,
"example" : 604800 ,
"nullable" : true ,
"description" : "The length of each period in seconds"
} ,
2022-01-24 20:17:09 +09:00
"BOLT11Expiration" : {
"type" : "string" ,
"example" : 30 ,
"description" : "If lightning is activated, do not accept BOLT11 invoices with expiration less than … days"
} ,
2022-04-29 08:58:17 +02:00
"autoApproveClaims" : {
"type" : "boolean" ,
"example" : false ,
"default" : false ,
"nullable" : true ,
"description" : "Any payouts created for this pull payment will skip the approval phase upon creation"
} ,
2020-06-24 10:34:09 +09:00
"archived" : {
"type" : "boolean" ,
"description" : "Whether this pull payment is archived"
} ,
"viewLink" : {
"type" : "string" ,
"description" : "The link to a page to claim payouts to this pull payment"
}
}
}
}
2022-04-21 12:30:49 +09:00
} ,
"tags" : [
{
"name" : "Pull payments (Management)"
} ,
{
"name" : "Pull payments (Public)"
} ,
{
"name" : "Pull payments payout (Public)"
}
]
2020-06-24 10:34:09 +09:00
}
