Strike API

https://docs.strike.me/
Admin
A payments API that uses Bitcoin and the Lightning Network to enable borderless money transactions...
Tokens:86,126
Snippets:494
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Initiate Payout Python Example

Source: https://docs.strike.me/api/initiate-a-payout

Initiate a payout using Python. This example uses the 'requests' library to send a PATCH request.

```python
import requests

url = "https://api.strike.me/v1/payouts/:payoutId/initiate"

headers = {
    'Accept': 'application/json'
}

response = requests.patch(url, headers=headers)

print(response.text)
```

--------------------------------

### Get Currency Exchange Quote Response Example

Source: https://docs.strike.me/walkthrough/exchanging-currencies

This is an example response from the get currency exchange quote endpoint. It shows a completed quote with source and target currency details, conversion rate, and completion timestamp.

```json
{
  "id": "6a3af0ed-ba86-44fc-a3be-1ea92696f331",
  "created": "2023-05-11T20:56:13.925967+00:00",
  "validUntil": "2023-05-11T20:56:26.477+00:00",
  "source": {
    "amount": "5.00",
    "currency": "USD"
  },
  "target": {
    "amount": "0.000184",
    "currency": "BTC"
  },
  "conversionRate": {
    "amount": "0.0000368",
    "sourceCurrency": "USD",
    "targetCurrency": "BTC"
  },
  "state": "COMPLETED",
  "completed": "2023-05-11T20:56:24.295406+00:00"
}

```

--------------------------------

### Initiate Payout Node.js Example

Source: https://docs.strike.me/api/initiate-a-payout

Initiate a payout using Node.js. This example demonstrates making a PATCH request to the payout initiation endpoint.

```javascript
const options = {
  method: 'PATCH',
  headers: {
    'Accept': 'application/json'
  }
};

fetch('https://api.strike.me/v1/payouts/:payoutId/initiate', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
```

--------------------------------

### cURL Example

Source: https://docs.strike.me/api/find-receive-request-by-id

Example of how to call the API using cURL to retrieve a receive request by its ID. Replace ':receiveRequestId' with the actual ID.

```cURL
curl -L -X GET 'https://api.strike.me/v1/receive-requests/:receiveRequestId' \
-H 'Accept: application/json'
```

--------------------------------

### Webhook Subscription Response Example

Source: https://docs.strike.me/walkthrough/exchanging-currencies

This is an example of a webhook subscription response for the currency-exchange-quote.updated event. It indicates that the state of a currency exchange quote has changed.

```json
{
  "id": "34f43981-fe06-4d05-9fc4-e858e8f9529b4",
  "eventType": "currency-exchange-quote.updated",
  "webhookVersion": "v1",
  "data": {
    "entityId": "11aa533f-232b-5bff-b967-abba2beef13",
    "changes": [
      "state"
    ]
  },
  "created": "2023-02-03T03:34:34+00:00"
}

```

--------------------------------

### Payment Details Response

Source: https://docs.strike.me/walkthrough/sending-payments

This is an example response from the 'get payment by ID' endpoint. It shows the payment's state, completion time, conversion rates, and amounts. A 'COMPLETED' state signifies a successful payment.

```json
{
  "paymentId": "11aa533f-232b-5bff-b967-abba2beef13",
  "state": "COMPLETED",
  "completed": "2023-02-03T03:28:34+00:00",
  "conversionRate": {
    "amount": "0.00004120",
    "sourceCurrency": "USD",
    "targetCurrency": "BTC"
  },
  "amount": {
    "currency": "USD",
    "amount": "167.00"
  },
  "lightningNetworkFee": {
    "currency": "USD",
    "amount": "0.54"
  },
  "totalAmount": {
    "currency": "USD",
    "amount": "167.54"
  }
}

```

--------------------------------

### API General Error Response Example

Source: https://docs.strike.me/api/introduction

This example shows the structure of a typical API error response, including trace ID, status, error code, and additional values.

```json
{
  "traceId": "7cd128d3-e8a9-4685-b852-c8ce0f4dd5e3",
  "data": {
    "status": 422,
    "code": "USER_CURRENCY_UNAVAILABLE",
    "message": "User does not support the given currency.",
    "values": {
      "currency": "USD"
    }
  }
}
```

--------------------------------

### GET balances

Source: https://docs.strike.me/api

Fetches the account balances.

```APIDOC
## GET balances

### Description
Fetches the account balances.

### Method
GET

### Endpoint
/balances
```

--------------------------------

### GET balances

Source: https://docs.strike.me/api/introduction

Enables fetching account balances.

```APIDOC
## GET balances

### Description
Fetches the current balances for the account.

### Method
GET

### Endpoint
/balances
```

--------------------------------

### Initiate Payout Go Example

Source: https://docs.strike.me/api/initiate-a-payout

Initiate a payout using Go. This code snippet shows how to construct and send a PATCH request to the API.

```go
package main

import (
	"fmt"
	"net/http"
	"bytes"
)

func main() {

	url := "https://api.strike.me/v1/payouts/:payoutId/initiate"

	payload := []byte(``)

	req, err := http.NewRequest("PATCH", url, bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Accept", "application/json")

	client := &http.Client{}
	res, err := client.Do(req)
	if err != nil {
		panic(err)
	}

defer res.Body.Close()

	fmt.Println("response Status:", res.Status)
	// TODO: Read response body
}
```

--------------------------------

### Example Webhook Event History Response

Source: https://docs.strike.me/webhooks/failure-recovery

This is an example paginated response from the get events endpoint, showing missed invoice events. The 'count' field indicates the total number of matching events.

```json
{
  "items": [
    {
      "id": "c1f0b219-4499-4f30-ad47-d35f8aaaa2af",
      "eventType": "invoice.created",
      "webhookVersion": "v1",
      "data": {
        "entityId": "be290e83-f087-470a-99db-88419b17c332"
      },
      "created": "2022-01-25T14:06:01.365+00:00",
      "deliverySuccess": false
    },
    {
      "id": "b8a21c07-7455-4a44-8b9a-e7f69e71393e",
      "eventType": "invoice.updated",
      "webhookVersion": "v1",
      "data": {
        "entityId": "be290e83-f087-470a-99db-88419b17c332",
        "changes": ["state"]
      },
      "created": "2022-01-25T14:06:34.955+00:00",
      "deliverySuccess": false
    }
  ],
  "count": 2
}
```

--------------------------------

### Retrieve Events with cURL

Source: https://docs.strike.me/api/get-events

Example of how to call the Get Events API using cURL. This includes setting the Accept header for JSON response.

```curl
curl -L -X GET 'https://api.strike.me/v1/events' \
-H 'Accept: application/json'
```

--------------------------------

### Get LNURL Details cURL Example

Source: https://docs.strike.me/api/get-lnurl-details

Use this cURL command to retrieve details for a given LNURL. Ensure you replace ':lnAddressOrUrl' with the actual LNURL.

```shell
curl -L -X GET 'https://api.strike.me/v1/payment-quotes/lightning/lnurl/:lnAddressOrUrl' \
-H 'Accept: application/json'
```

--------------------------------

### Initiate Payout cURL Example

Source: https://docs.strike.me/api/initiate-a-payout

Use this cURL command to initiate a payout. Replace ':payoutId' with the actual payout ID. Ensure the Accept header is set to application/json.

```bash
curl -L -X PATCH 'https://api.strike.me/v1/payouts/:payoutId/initiate' \
-H 'Accept: application/json'
```

--------------------------------

### Filtered Get Invoices Response Example

Source: https://docs.strike.me/walkthrough/receiving-payments

This JSON response shows a list of invoices that match the specified filter criteria. The 'count' field indicates the total number of matching invoices.

```json
{
  "items": [
    {
      "invoiceId": "487b2454-31eb-43e0-8743-48d0020738d7",
      "amount": {
        "currency": "USD",
        "amount": "15.00"
      },
      "state": "UNPAID",
      "created": "2021-09-09T03:57:47.829226+02:00",
      "description": "stack sats",
      "issuerId": "bf909224-3432-400b-895a-3010302f80f5",
      "receiverId": "bf909224-3432-400b-895a-3010302f80f5"
    },
    {
      "invoiceId": "6f648c48-882a-4cf8-ad2c-d53cb699a073",
      "amount": {
        "currency": "USD",
        "amount": "150.00"
      },
      "state": "UNPAID",
      "created": "2021-10-30T20:30:27.071595+02:00",
      "correlationId": "224bff37-021f-43e5-9b9c-390e3d834741",
      "description": "Invoice for order 123",
      "issuerId": "bf909224-3432-400b-895a-3010302f80f5",
      "receiverId": "bf909224-3432-400b-895a-3010302f80f5"
    }
  ],
  "count": 2
}
```

--------------------------------

### Create Invoice

Source: https://docs.strike.me/api-keys/authorization

This example demonstrates how to create an invoice by making a POST request to the /v1/invoices endpoint. It includes the necessary Authorization header, Content-Type, and a JSON payload with correlationId, description, and amount details.

```APIDOC
## POST /v1/invoices

### Description
Creates an invoice with specified details.

### Method
POST

### Endpoint
`https://<ENVIRONMENT>/v1/invoices`

### Parameters
#### Headers
- **Authorization** (string) - Required - Your API key in the format `Bearer <API_KEY>`.
- **Content-Type** (string) - Required - `application/json`

#### Request Body
- **correlationId** (string) - Required - A unique identifier for the request.
- **description** (string) - Required - A description for the invoice.
- **amount** (object) - Required - An object containing the currency and amount.
  - **currency** (string) - Required - The currency of the amount (e.g., "USD").
  - **amount** (string) - Required - The monetary amount.

### Request Example
```json
{
  "correlationId": "224bff37-021f-43e5-9b9c-390e3d834750",
  "description": "Invoice for order 123",
  "amount": {
    "currency": "USD",
    "amount": "150.00"
  }
}
```

### Response
#### Success Response (200)
- **invoiceId** (string) - The unique identifier for the created invoice.
- **amount** (object) - The amount details of the invoice.
  - **amount** (string) - The monetary amount.
  - **currency** (string) - The currency of the amount.
- **state** (string) - The current state of the invoice (e.g., "UNPAID").
- **created** (string) - The timestamp when the invoice was created.
- **correlationId** (string) - The correlation ID used in the request.
- **description** (string) - The description of the invoice.
- **issuerId** (string) - The ID of the issuer.
- **receiverId** (string) - The ID of the receiver.

#### Response Example
```json
{
  "invoiceId": "6b91e56d-fce9-4eec-995f-1d08fe6ba380",
  "amount": {
    "amount": "150.00",
    "currency": "USD"
  },
  "state": "UNPAID",
  "created": "2021-11-12T20:08:45.98159+00:00",
  "correlationId": "224bff37-021f-43e5-9b9c-390e3d834750",
  "description": "Invoice for order 123",
  "issuerId": "bf909224-3432-400b-895a-3010302f80f5",
  "receiverId": "bf909224-3432-400b-895a-3010302f80f5"
}
```

### Error Handling
#### Unauthorized Response (401)
- **data** (object) - Contains error details.
  - **status** (integer) - The HTTP status code (401).
  - **code** (string) - The error code (e.g., "UNAUTHORIZED").
  - **message** (string) - A message describing the error (e.g., "Invalid or unspecified identity.").
```

--------------------------------

### Create an Invoice Request

Source: https://docs.strike.me/walkthrough/directing-payments-third-party

Example of an HTTP request to create an invoice. Ensure you replace '<API_KEY>' with your actual API key.

```bash
-H "accept: application/json" \
-H "Authorization: Bearer <API_KEY>"
```

--------------------------------

### cURL Request to Get Onchain Tiers

Source: https://docs.strike.me/api/get-onchain-tiers

Example cURL command to send a POST request to the Strike API to retrieve onchain payment tiers. Ensure to replace placeholders with actual values.

```curl
curl -L -X POST 'https://api.strike.me/v1/payment-quotes/onchain/tiers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "btcAddress": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
  "amount": {
    "amount": "10.99",
    "currency": "USD"
  }
}'
```

--------------------------------

### Create Bank Payment Method for Company Beneficiary

Source: https://docs.strike.me/walkthrough/making-payouts

This example demonstrates creating a bank payment method for a company beneficiary using a US domestic wire transfer. Ensure you replace placeholder values for environment and API key.

```bash
curl -L -X POST 'https://<ENVIRONMENT>/v1/payment-methods/bank' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <API_KEY> \
--data-raw '{ \
  "transferType": "US_DOMESTIC_WIRE", \
  "accountNumber": "1234567890", \
  "routingNumber": "123456789", \
  "accountType": "CHECKING", \
  "bankName": "Chase Bank", \
  "bankAddress": { \
    "country": "US", \
    "state": "TX", \
    "city": "Austin", \
    "postCode": "73301", \
    "line1": "123 Main St" \
  }, \
  "beneficiaries": [ \
    { \
      "type": "COMPANY", \
      "name": "Payments X", \
      "address": { \
        "country": "US", \
        "state": "TX", \
        "city": "Austin", \
        "postCode": "73301", \
        "line1": "123 Main St" \
      } \
    }, \
      "email": "finance@pyamentsx.com", \
      "phoneNumber": "+15551234567", \
      "url": "https://paymentsXexample.com" \
    } \
  ] \
}'
```

--------------------------------

### Payout Creation Response

Source: https://docs.strike.me/walkthrough/making-payouts

This is an example response after successfully creating a payout object. The 'state' is 'NEW', indicating readiness for initiation. Verify the payout details and state.

```json
{
  "id": "252652f5-7f3b-4fac-8149-b3c539e608b9",
  "state": "NEW",
  "paymentMethodId": "c8c48059-7263-44d6-836e-16ef9a90f629",
  "originatorId": "e9e2b5b1-7f2a-4dfb-846d-c2f40c98d381",
  "amount": {
    "amount": "100.00",
    "currency": "USD"
  }
}
```

--------------------------------

### Example Webhook JSON Payload

Source: https://docs.strike.me/webhooks/setting-up-webhooks

This is an example of the JSON payload structure for a webhook notification. It includes event details and data about the trigger.

```json
{
  "id": "245e40d8-f197-411c-8f20-a326d08da402",
  "eventType": "invoice.updated",
  "webhookVersion": "v1",
  "data": {
    "entityId": "602cc206-6b4a-42dd-bc89-9a534bb04034",
    "changes": [
      "state"
    ]
  },
  "created": "2009-01-03T18:15:00+01:00",
  "deliverySuccess": true
}
```

--------------------------------

### Example Account Profile Response

Source: https://docs.strike.me/walkthrough/sending-payments

This JSON response indicates the available currencies for sending payments and the account's default currency. 'isAvailable' shows if a currency can be used for sending.

```json
{
 "handle": "astrid_waters64",
 "canReceive": true,
 "currencies": [
   {
     "currency": "BTC",
     "isDefaultCurrency": false,
     "isAvailable": true,
     "isInvoiceable": false
   },
   {
     "currency": "USD",
     "isDefaultCurrency": true,
     "isAvailable": true,
     "isInvoiceable": true
   }
 ]
}
```

--------------------------------

### Create Payout cURL Example

Source: https://docs.strike.me/api/create-a-payout

Use this cURL command to create a payout. Ensure you set the appropriate Content-Type and Accept headers.

```shell
curl -L -X POST 'https://api.strike.me/v1/payouts' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Create Company Payout-Originator

Source: https://docs.strike.me/walkthrough/making-payouts

This cURL example demonstrates how to create a payout-originator for a company. Remember to substitute <ENVIRONMENT> and <API_KEY> with your specific credentials.

```curl
curl -L -X POST 'https://<ENVIRONMENT>/v1/payout-originators' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <API_KEY> \
--data-raw '{ \
  "type": "COMPANY", \
  "name": "Payment X company", \
  "address": { \
    "country": "US", \
    "state": "TX", \
    "city": "Austin", \
    "postCode": "73301", \
    "line1": "123 Main St" \
  }, \
    "email": "finance@pyamentsx.com", \
    "phoneNumber": "+15551234567", \
    "url": "https://example.com" \
}'

```

--------------------------------

### Get Events API Endpoint

Source: https://docs.strike.me/api/get-events

This snippet shows the basic GET request to retrieve events from the API. Ensure you have the necessary scopes.

```http
GET /v1/events
```

--------------------------------

### Initiate a Payout

Source: https://docs.strike.me/walkthrough/making-payouts

Use this endpoint to initiate a payout using the payout object ID created previously. This action requests the transfer of funds.

```bash
curl -L -X PATCH 'https://<ENVIRONMENT>/v1/payouts/<PayoutId>/initiate' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <API_KEY>
```

--------------------------------

### Create Currency Exchange Quote (Denominated in Sell Currency)

Source: https://docs.strike.me/walkthrough/exchanging-currencies

Use this endpoint to create a quote for exchanging currencies. Specify the currencies to buy and sell, and the amount to sell. Ensure you have sufficient funds to execute the exchange.

```bash
curl -L -X POST 'https://<ENVIRONMENT>/v1/currency-exchange-quotes' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <API_KEY>' \
--data-raw '{ \
  "sell": "USD", \
  "buy": "BTC", \
  "amount": { \
    "amount": "5.00", \
    "currency": "USD" \
  } \
}'
```

```json
{
  "id": "6a3af0ed-ba86-44fc-a3be-1ea92696f331",
  "created": "2023-05-11T20:56:13.9259677+00:00",
  "validUntil": "2023-05-11T20:56:26.477+00:00",
  "source": {
    "amount": "5.00",
    "currency": "USD"
  },
  "target": {
    "amount": "0.000184",
    "currency": "BTC"
  },
  "conversionRate": {
    "amount": "0.0000368",
    "sourceCurrency": "USD",
    "targetCurrency": "BTC"
  },
  "state": "NEW"
}
```

--------------------------------

### Create Payout Originator cURL Example

Source: https://docs.strike.me/api/create-a-payout-originator

Use this cURL command to send a POST request to create a payout originator. Ensure you include the necessary Content-Type and Accept headers.

```curl
curl -L -X POST 'https://api.strike.me/v1/payout-originators' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Example Lightning Invoice QR Code

Source: https://docs.strike.me/walkthrough/directing-payments-third-party

This is an example of a Lightning invoice QR code, which contains all necessary payment information. It is presented here as an alphanumeric string.

```plaintext
LNBC10U1P3PJ257PP5YZTKWJCZ5FTL5LAXKAV23ZMZEKAW37ZK6KMV80PK4XAEV5QHTZ7QDPDWD3XGER9WD5KWM36YPRX7U3QD36KUCMGYP282ETNV3SHJCQZPGXQYZ5VQSP5USYC4LK9CHSFP53KVCNVQ456GANH60D89REYKDNGSMTJ6YW3NHVQ9QYYSSQJCEWM5CJWZ4A6RFJX77C490YCED6PEMK0UPKXHY89CMM7SCT66K8GNEANWYKZGDRWRFJE69H9U5U0W57RRCSYSAS7GADWMZXC8C6T0SPJAZUP6  

```

--------------------------------

### Issue Invoice for Receiver cURL Example

Source: https://docs.strike.me/api/issue-invoice-for-receiver

Example of how to issue an invoice to a receiver using cURL. Replace ':handle' with the actual receiver's handle.

```curl
curl -L -X POST 'https://api.strike.me/v1/invoices/handle/:handle' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "correlationId": "224bff37-021f-43e5-9b9c-390e3d834720",
  "description": "Invoice for order 123",
  "amount": {
    "amount": "10.99",
    "currency": "USD"
  }
}'
```

--------------------------------

### Create Bank Payment Method for Individual Beneficiary

Source: https://docs.strike.me/walkthrough/making-payouts

Use this endpoint to create a bank payment method for an individual beneficiary. It supports ACH transfers and includes optional details like date of birth for faster setup. Replace placeholders with your actual environment and API key.

```bash
curl -L -X POST \
'https://<ENVIRONMENT>/v1/payment-methods/bank' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <API_KEY> \
--data-raw '{ \
  "transferType": "ACH", \
  "accountNumber": "1234567890", \
  "routingNumber": "123456789", \
  "accountType": "CHECKING", \
  "bankName": "Chase Bank", \
  "bankAddress": { \
    "country": "US", \
    "state": "TX", \
    "city": "Austin", \
    "postCode": "73301", \
    "line1": "123 Main St" \
  }, \
  "beneficiaries": [ \
    { \
      "dateOfBirth": "1980-03-02", \
      "type": "INDIVIDUAL", \
      "name": "John Smith", \
      "address": { \
        "country": "US", \
        "state": "TX", \
        "city": "Austin", \
        "postCode": "73301", \
        "line1": "123 Main St" \
      } \
    }, \
    { \
      "email": "AliceSmith@example.com", \
      "phoneNumber": "+15551234567", \
      "url": "https://example.com", \
      "type": "INDIVIDUAL", \
      "name": "Alice Smith", \
      "address": { \
        "country": "US", \
        "state": "TX", \
        "city": "Austin", \
        "postCode": "73301", \
        "line1": "123 Main St" \
      } \
    } \
  ] \
}'
```

--------------------------------

### Get Payment by ID (cURL)

Source: https://docs.strike.me/api/get-payment-by-id

Use this cURL command to make a GET request to retrieve payment details. Replace ':paymentId' with the actual payment identifier.

```bash
curl -L -X GET 'https://api.strike.me/v1/payments/:paymentId' \
-H 'Accept: application/json'
```

--------------------------------

### Example Invoice Response

Source: https://docs.strike.me/walkthrough/directing-payments-third-party

This is an example JSON response for a filtered and ordered invoice retrieval request. The 'count' field indicates the total number of invoices matching the filter.

```json
{
  "items": [
    {
      "invoiceId": "487b2454-31eb-43e0-8743-48d0020738d7",
      "amount": {
        "currency": "USD",
        "amount": "15.00"
      },
      "state": "UNPAID",
      "created": "2021-09-09T03:57:47.829226+02:00",
      "description": "stack sats",
      "issuerId": "bf909224-3432-400b-895a-3010302f80f5",
      "receiverId": "bf909224-3432-400b-895a-3010302f80f5"
    },
    {
      "invoiceId": "6f648c48-882a-4cf8-ad2c-d53cb699a073",
      "amount": {
        "currency": "USD",
        "amount": "150.00"
      },
      "state": "UNPAID",
      "created": "2021-10-30T20:30:27.071595+02:00",
      "correlationId": "224bff37-021f-43e5-9b9c-390e3d834741",
      "description": "Invoice for order 123",
      "issuerId": "bf909224-3432-400b-895a-3010302f80f5",
      "receiverId": "bf909224-3432-400b-895a-3010302f80f5"
    }
  ],
  "count": 3
}
```

--------------------------------

### Example Response for Public Account Profile

Source: https://docs.strike.me/walkthrough/exchanging-currencies

This JSON response shows the available currencies for a Strike user. Check the 'isAvailable' field to determine if a currency can be used for exchanges.

```json
{
  "handle": "astrid_waters64",
  "canReceive": true,
  "currencies": [
    {
      "currency": "BTC",
      "isDefaultCurrency": false,
      "isAvailable": true,
      "isInvoiceable": true
    },
    {
      "currency": "USD",
      "isDefaultCurrency": true,
      "isAvailable": true,
      "isInvoiceable": true
    }
  ]
}
```

--------------------------------

### API Validation Error Response Example

Source: https://docs.strike.me/api/introduction

This example illustrates the structure for API responses when validation errors occur, detailing specific field errors with codes and messages.

```json
{
  "traceId": "7cd128d3-e8a9-4685-b852-c8ce0f4dd5e3",
  "data": {
    "status": 400,
    "validationErrors": {
      "correlationId": [
        {
          "code": "INVALID_DATA_MAXLENGTH",
          "message": "The field correlationId must be a value with a maximum length of '40'",
          "values": {
            "field": "correlationId",
            "maxLength": 40
          }
        }
      ],
      "amount": [
        {
          "code": "INVALID_DATA_REQUIRED",
          "message": "The field amount is required",
          "values": {
            "field": "amount"
          }
        }
      ]
    },
    "code": "INVALID_DATA",
    "message": "One or more validation errors occurred."
  }
}
```

--------------------------------

### Create a Payout Object

Source: https://docs.strike.me/walkthrough/making-payouts

Use this endpoint to create a payout object. It requires a payment-method ID, originator ID, and the amount to be sent. Ensure your account has sufficient balance before creating the payout.

```bash
curl -L -X POST 'https://<ENVIRONMENT>/v1/payouts' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <API_KEY> \
--data-raw '{ \
  "paymentMethodId": "c8c48059-7263-44d6-836e-16ef9a90f629", \
  "originatorId": "e9e2b5b1-7f2a-4dfb-846d-c2f40c98d381", \
  "amount": "100.00" \
}'
```

--------------------------------

### Example 503 Maintenance Mode Response

Source: https://docs.strike.me/maintenance

This is an example of a JSON response received when the Strike API is in maintenance mode. All API requests will return an HTTP 503 status code.

```json
{
  "data": {
    "status": 503,
    "code": "MAINTENANCE_MODE",
    "message": "Maintenance mode is active."
  }
}

```

--------------------------------

### Get Payment by ID

Source: https://docs.strike.me/walkthrough/sending-payments

Retrieves the current state and details of a specific payment using its ID. This is useful after receiving a `payment.updated` webhook event to get the latest payment status.

```APIDOC
## GET /v1/payments/<PAYMENT_ID>

### Description
Retrieves the details of a specific payment, including its current state.

### Method
GET

### Endpoint
/v1/payments/<PAYMENT_ID>

### Parameters
#### Path Parameters
- **PAYMENT_ID** (string) - Required - The unique identifier of the payment.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -X GET \
'https://<ENVIRONMENT>/v1/payments/<PAYMENT_ID>'
-H 'accept: application/json' \
-H 'Authorization: Bearer <API_KEY>'
```

### Response
#### Success Response (200)
- **paymentId** (string) - The ID of the payment.
- **state** (string) - The current state of the payment (e.g., `COMPLETED`, `PENDING`).
- **completed** (string) - The timestamp when the payment was completed.
- **conversionRate** (object) - Information about the currency conversion.
  - **amount** (string) - The conversion rate amount.
  - **sourceCurrency** (string) - The original currency.
  - **targetCurrency** (string) - The target currency.
- **amount** (object) - The amount of the payment.
  - **currency** (string) - The currency of the payment.
  - **amount** (string) - The payment amount.
- **lightningNetworkFee** (object) - The fee for the Lightning Network transaction.
  - **currency** (string) - The currency of the fee.
  - **amount** (string) - The fee amount.
- **totalAmount** (object) - The total amount including fees.
  - **currency** (string) - The currency of the total amount.
  - **amount** (string) - The total amount.

#### Response Example
```json
{
  "paymentId": "11aa533f-232b-5bff-b967-abba2beef13",
  "state": "COMPLETED",
  "completed": "2023-02-03T03:28:34+00:00",
  "conversionRate": {
    "amount": "0.00004120",
    "sourceCurrency": "USD",
    "targetCurrency": "BTC"
  },
  "amount": {
    "currency": "USD",
    "amount": "167.00"
  },
  "lightningNetworkFee": {
    "currency": "USD",
    "amount": "0.54"
  },
  "totalAmount": {
    "currency": "USD",
    "amount": "167.54"
  }
}
```
```

--------------------------------

### Create Currency Exchange Quote (Denominated in Buy Currency)

Source: https://docs.strike.me/walkthrough/exchanging-currencies

Create a currency exchange quote by specifying the amount of the currency you wish to buy. This is useful when you need to acquire a specific quantity of a particular currency.

```bash
curl -L -X POST 'https://<ENVIRONMENT>/v1/currency-exchange-quotes' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <API_KEY>' \
--data-raw '{ \
  "sell": "USD", \
  "buy": "BTC", \
  "amount": { \
    "amount": "0.0001", \
    "currency": "BTC" \
  } \
}'
```

```json
{
  "id": "6a3af0ed-ba86-44fc-a3be-1ea92696f331",
  "created": "2023-05-11T20:56:13.9259677+00:00",
  "validUntil": "2023-05-11T20:56:26.477+00:00",
  "source": {
    "amount": "2.71",
    "currency": "USD"
  },
  "target": {
    "amount": "0.0001",
    "currency": "BTC"
  },
  "conversionRate": {
    "amount": "0.0000369",
    "sourceCurrency": "USD",
    "targetCurrency": "BTC"
  },
  "state": "NEW"
}
```

--------------------------------

### Get Receive Requests

Source: https://docs.strike.me/api/get-receive-requests

This snippet shows how to make a GET request to the /v1/receive-requests endpoint to retrieve a list of receive requests. Ensure you have the necessary API key and scopes for authentication.

```cURL
curl -L -X GET 'https://api.strike.me/v1/receive-requests' \
-H 'Accept: application/json'
```
Tokens:
Raw