Create a hold

curl --request POST \
  --url https://api.panoqore.example/v1/holds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "accountId": "<string>",
  "amount": "500000",
  "currency": "NGN"
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({accountId: '<string>', amount: '500000', currency: 'NGN'})
};

fetch('https://api.panoqore.example/v1/holds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoqore.example/v1/holds"

payload = {
    "accountId": "<string>",
    "amount": "500000",
    "currency": "NGN"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.panoqore.example/v1/holds"

	payload := strings.NewReader("{\n  \"accountId\": \"<string>\",\n  \"amount\": \"500000\",\n  \"currency\": \"NGN\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "accountId": "<string>",
  "accountName": "<string>",
  "currency": "<string>",
  "amount": "<string>",
  "captured": "<string>",
  "status": "ACTIVE",
  "reason": "<string>",
  "entryId": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "INSUFFICIENT_FUNDS",
    "message": "<string>",
    "details": {},
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_FUNDS",
    "message": "<string>",
    "details": {},
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_FUNDS",
    "message": "<string>",
    "details": {},
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_FUNDS",
    "message": "<string>",
    "details": {},
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_FUNDS",
    "message": "<string>",
    "details": {},
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_FUNDS",
    "message": "<string>",
    "details": {},
    "request_id": "<string>"
  }
}

POST

holds

Create a hold

curl --request POST \
  --url https://api.panoqore.example/v1/holds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "accountId": "<string>",
  "amount": "500000",
  "currency": "NGN"
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({accountId: '<string>', amount: '500000', currency: 'NGN'})
};

fetch('https://api.panoqore.example/v1/holds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoqore.example/v1/holds"

payload = {
    "accountId": "<string>",
    "amount": "500000",
    "currency": "NGN"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.panoqore.example/v1/holds"

	payload := strings.NewReader("{\n  \"accountId\": \"<string>\",\n  \"amount\": \"500000\",\n  \"currency\": \"NGN\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "accountId": "<string>",
  "accountName": "<string>",
  "currency": "<string>",
  "amount": "<string>",
  "captured": "<string>",
  "status": "ACTIVE",
  "reason": "<string>",
  "entryId": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "INSUFFICIENT_FUNDS",
    "message": "<string>",
    "details": {},
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_FUNDS",
    "message": "<string>",
    "details": {},
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_FUNDS",
    "message": "<string>",
    "details": {},
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_FUNDS",
    "message": "<string>",
    "details": {},
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_FUNDS",
    "message": "<string>",
    "details": {},
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_FUNDS",
    "message": "<string>",
    "details": {},
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An API key, pk_live_… or pk_test_….

Headers

Idempotency-Key

string

required

Your unique key for this write, at most 255 characters. A retry with the same key and body gets the first answer back.

Maximum string length: 255

Body

application/json

accountId

string

required

amount

string

required

Minor units, as a string.

Pattern: ^[0-9]+$

Example:

"500000"

currency

string

required

Example:

"NGN"

reason

string

Example:

"Customer unreachable for 180 days"

expiresAt

string<date-time>

Response

string

hld_…

accountId

string

accountName

string

currency

string

amount

string

Minor units, as a string.

captured

string

Minor units, as a string.

status

enum<string>

CAPTURED: fully captured

Available options:

ACTIVE,

CAPTURED,

RELEASED,

EXPIRED

reason

string

entryId

string

the pending entry this hold protects, if any

expiresAt

string<date-time>

createdAt

string<date-time>

updatedAt

string<date-time>

Overview

Core ledger

Money products

Finance operations

Events and webhooks

Tenant setup

Create a hold

Authorizations

Headers

Body

Response