Collect from accounts

Use COLLECT when several internal accounts contribute funds into one destination account. Common examples are pooling user balances, consolidating seller balances, or collecting split obligations into a platform account.

Note

Every origin should include its own amount. The destination amount should match the collected total.

Flow

01

Select origins

Choose the accounts that contribute funds.

02

Assign amounts

Set each origin amount and match the total.

03

Choose destination

Route the total into one account.

04

Capture

Commit the internal movement.

Create the collect payment

Request

HTTPcurlJavaScriptPythonGoRust

POST /sandbox/payments HTTP/1.1
Host: api.conomyhq.com
x-api-key: {YOUR_API_KEY}
Authorization: Bearer {ACCESS_TOKEN}
conomyhq-api-version: 24-04-2025
User-Agent: MyApp/1.0
Content-Type: application/json
Accept: application/json

{
  "externalId": "collect-1001",
  "identityId": "<DESTINATION_IDENTITY_ID>",
  "accountNumber": "<DESTINATION_ACCOUNT_NUMBER>",
  "product": "COP:COP",
  "type": "COLLECT",
  "purchaseAmount": "30000.00",
  "purchaseCurrency": "COP",
  "currency": "COP",
  "origins": [
    {
      "type": "ACCOUNT",
      "amount": "15000.00",
      "currency": "COP",
      "identity": {
        "identityId": "<ORIGIN_IDENTITY_ID_1>"
      },
      "account": {
        "accountNumber": "<ORIGIN_ACCOUNT_NUMBER_1>"
      }
    },
    {
      "type": "ACCOUNT",
      "amount": "15000.00",
      "currency": "COP",
      "identity": {
        "identityId": "<ORIGIN_IDENTITY_ID_2>"
      },
      "account": {
        "accountNumber": "<ORIGIN_ACCOUNT_NUMBER_2>"
      }
    }
  ],
  "destinations": [
    {
      "type": "ACCOUNT",
      "amount": "30000.00",
      "currency": "COP",
      "identity": {
        "identityId": "<DESTINATION_IDENTITY_ID>"
      },
      "account": {
        "accountNumber": "<DESTINATION_ACCOUNT_NUMBER>"
      }
    }
  ]
}

curl -X POST 'https://api.conomyhq.com/sandbox/payments' \
  -H 'x-api-key: {YOUR_API_KEY}' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'conomyhq-api-version: 24-04-2025' \
  -H 'User-Agent: MyApp/1.0' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "externalId": "collect-1001",
    "identityId": "<DESTINATION_IDENTITY_ID>",
    "accountNumber": "<DESTINATION_ACCOUNT_NUMBER>",
    "product": "COP:COP",
    "type": "COLLECT",
    "purchaseAmount": "30000.00",
    "purchaseCurrency": "COP",
    "currency": "COP",
    "origins": [
      {
        "type": "ACCOUNT",
        "amount": "15000.00",
        "currency": "COP",
        "identity": {
          "identityId": "<ORIGIN_IDENTITY_ID_1>"
        },
        "account": {
          "accountNumber": "<ORIGIN_ACCOUNT_NUMBER_1>"
        }
      },
      {
        "type": "ACCOUNT",
        "amount": "15000.00",
        "currency": "COP",
        "identity": {
          "identityId": "<ORIGIN_IDENTITY_ID_2>"
        },
        "account": {
          "accountNumber": "<ORIGIN_ACCOUNT_NUMBER_2>"
        }
      }
    ],
    "destinations": [
      {
        "type": "ACCOUNT",
        "amount": "30000.00",
        "currency": "COP",
        "identity": {
          "identityId": "<DESTINATION_IDENTITY_ID>"
        },
        "account": {
          "accountNumber": "<DESTINATION_ACCOUNT_NUMBER>"
        }
      }
    ]
  }'

const response = await fetch('https://api.conomyhq.com/sandbox/payments', {
  method: 'POST',
  headers: {
    'x-api-key': '{YOUR_API_KEY}',
    'Authorization': 'Bearer {ACCESS_TOKEN}',
    'conomyhq-api-version': '24-04-2025',
    'User-Agent': 'MyApp/1.0',
    'Content-Type': 'application/json',
    'Accept': 'application/json',
  },
  body: JSON.stringify({
    "externalId": "collect-1001",
    "identityId": "<DESTINATION_IDENTITY_ID>",
    "accountNumber": "<DESTINATION_ACCOUNT_NUMBER>",
    "product": "COP:COP",
    "type": "COLLECT",
    "purchaseAmount": "30000.00",
    "purchaseCurrency": "COP",
    "currency": "COP",
    "origins": [
      {
        "type": "ACCOUNT",
        "amount": "15000.00",
        "currency": "COP",
        "identity": {
          "identityId": "<ORIGIN_IDENTITY_ID_1>"
        },
        "account": {
          "accountNumber": "<ORIGIN_ACCOUNT_NUMBER_1>"
        }
      },
      {
        "type": "ACCOUNT",
        "amount": "15000.00",
        "currency": "COP",
        "identity": {
          "identityId": "<ORIGIN_IDENTITY_ID_2>"
        },
        "account": {
          "accountNumber": "<ORIGIN_ACCOUNT_NUMBER_2>"
        }
      }
    ],
    "destinations": [
      {
        "type": "ACCOUNT",
        "amount": "30000.00",
        "currency": "COP",
        "identity": {
          "identityId": "<DESTINATION_IDENTITY_ID>"
        },
        "account": {
          "accountNumber": "<DESTINATION_ACCOUNT_NUMBER>"
        }
      }
    ]
  }),
});

const data = await response.json();

import requests

payload = {
  "externalId": "collect-1001",
  "identityId": "<DESTINATION_IDENTITY_ID>",
  "accountNumber": "<DESTINATION_ACCOUNT_NUMBER>",
  "product": "COP:COP",
  "type": "COLLECT",
  "purchaseAmount": "30000.00",
  "purchaseCurrency": "COP",
  "currency": "COP",
  "origins": [
    {
      "type": "ACCOUNT",
      "amount": "15000.00",
      "currency": "COP",
      "identity": {
        "identityId": "<ORIGIN_IDENTITY_ID_1>"
      },
      "account": {
        "accountNumber": "<ORIGIN_ACCOUNT_NUMBER_1>"
      }
    },
    {
      "type": "ACCOUNT",
      "amount": "15000.00",
      "currency": "COP",
      "identity": {
        "identityId": "<ORIGIN_IDENTITY_ID_2>"
      },
      "account": {
        "accountNumber": "<ORIGIN_ACCOUNT_NUMBER_2>"
      }
    }
  ],
  "destinations": [
    {
      "type": "ACCOUNT",
      "amount": "30000.00",
      "currency": "COP",
      "identity": {
        "identityId": "<DESTINATION_IDENTITY_ID>"
      },
      "account": {
        "accountNumber": "<DESTINATION_ACCOUNT_NUMBER>"
      }
    }
  ]
}

response = requests.post(
    'https://api.conomyhq.com/sandbox/payments',
    headers={
    'x-api-key': '{YOUR_API_KEY}',
    'Authorization': 'Bearer {ACCESS_TOKEN}',
    'conomyhq-api-version': '24-04-2025',
    'User-Agent': 'MyApp/1.0',
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    },
    json=payload,
)

data = response.json()

package main

import (
	"bytes"
	"net/http"
)

func main() {
	payload := []byte(`{
  "externalId": "collect-1001",
  "identityId": "<DESTINATION_IDENTITY_ID>",
  "accountNumber": "<DESTINATION_ACCOUNT_NUMBER>",
  "product": "COP:COP",
  "type": "COLLECT",
  "purchaseAmount": "30000.00",
  "purchaseCurrency": "COP",
  "currency": "COP",
  "origins": [
    {
      "type": "ACCOUNT",
      "amount": "15000.00",
      "currency": "COP",
      "identity": {
        "identityId": "<ORIGIN_IDENTITY_ID_1>"
      },
      "account": {
        "accountNumber": "<ORIGIN_ACCOUNT_NUMBER_1>"
      }
    },
    {
      "type": "ACCOUNT",
      "amount": "15000.00",
      "currency": "COP",
      "identity": {
        "identityId": "<ORIGIN_IDENTITY_ID_2>"
      },
      "account": {
        "accountNumber": "<ORIGIN_ACCOUNT_NUMBER_2>"
      }
    }
  ],
  "destinations": [
    {
      "type": "ACCOUNT",
      "amount": "30000.00",
      "currency": "COP",
      "identity": {
        "identityId": "<DESTINATION_IDENTITY_ID>"
      },
      "account": {
        "accountNumber": "<DESTINATION_ACCOUNT_NUMBER>"
      }
    }
  ]
}`)
	body := bytes.NewReader(payload)
	req, _ := http.NewRequest("POST", "https://api.conomyhq.com/sandbox/payments", body)
	req.Header.Set("x-api-key", "{YOUR_API_KEY}")
	req.Header.Set("Authorization", "Bearer {ACCESS_TOKEN}")
	req.Header.Set("conomyhq-api-version", "24-04-2025")
	req.Header.Set("User-Agent", "MyApp/1.0")
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Accept", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
}

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let payload = json!({
  "externalId": "collect-1001",
  "identityId": "<DESTINATION_IDENTITY_ID>",
  "accountNumber": "<DESTINATION_ACCOUNT_NUMBER>",
  "product": "COP:COP",
  "type": "COLLECT",
  "purchaseAmount": "30000.00",
  "purchaseCurrency": "COP",
  "currency": "COP",
  "origins": [
    {
      "type": "ACCOUNT",
      "amount": "15000.00",
      "currency": "COP",
      "identity": {
        "identityId": "<ORIGIN_IDENTITY_ID_1>"
      },
      "account": {
        "accountNumber": "<ORIGIN_ACCOUNT_NUMBER_1>"
      }
    },
    {
      "type": "ACCOUNT",
      "amount": "15000.00",
      "currency": "COP",
      "identity": {
        "identityId": "<ORIGIN_IDENTITY_ID_2>"
      },
      "account": {
        "accountNumber": "<ORIGIN_ACCOUNT_NUMBER_2>"
      }
    }
  ],
  "destinations": [
    {
      "type": "ACCOUNT",
      "amount": "30000.00",
      "currency": "COP",
      "identity": {
        "identityId": "<DESTINATION_IDENTITY_ID>"
      },
      "account": {
        "accountNumber": "<DESTINATION_ACCOUNT_NUMBER>"
      }
    }
  ]
});

    let response = client
        .post("https://api.conomyhq.com/sandbox/payments")
        .header("x-api-key", "{YOUR_API_KEY}")
        .header("Authorization", "Bearer {ACCESS_TOKEN}")
        .header("conomyhq-api-version", "24-04-2025")
        .header("User-Agent", "MyApp/1.0")
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .json(&payload)
        .send()
        .await?;

    let data: serde_json::Value = response.json().await?;
    Ok(())
}

Response

200

{
  "id": "<PAYMENT_ID>",
  "type": "COLLECT",
  "status": "CREATED"
}

Capture

Request

HTTPcurlJavaScriptPythonGoRust

POST /sandbox/payments/{PAYMENT_ID}/captured HTTP/1.1
Host: api.conomyhq.com
x-api-key: {YOUR_API_KEY}
Authorization: Bearer {ACCESS_TOKEN}
conomyhq-api-version: 24-04-2025
User-Agent: MyApp/1.0
Content-Type: application/json
Accept: application/json

{}

curl -X POST 'https://api.conomyhq.com/sandbox/payments/{PAYMENT_ID}/captured' \
  -H 'x-api-key: {YOUR_API_KEY}' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'conomyhq-api-version: 24-04-2025' \
  -H 'User-Agent: MyApp/1.0' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{}'

const response = await fetch('https://api.conomyhq.com/sandbox/payments/{PAYMENT_ID}/captured', {
  method: 'POST',
  headers: {
    'x-api-key': '{YOUR_API_KEY}',
    'Authorization': 'Bearer {ACCESS_TOKEN}',
    'conomyhq-api-version': '24-04-2025',
    'User-Agent': 'MyApp/1.0',
    'Content-Type': 'application/json',
    'Accept': 'application/json',
  },
  body: JSON.stringify({}),
});

const data = await response.json();

import requests

payload = {}

response = requests.post(
    'https://api.conomyhq.com/sandbox/payments/{PAYMENT_ID}/captured',
    headers={
    'x-api-key': '{YOUR_API_KEY}',
    'Authorization': 'Bearer {ACCESS_TOKEN}',
    'conomyhq-api-version': '24-04-2025',
    'User-Agent': 'MyApp/1.0',
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    },
    json=payload,
)

data = response.json()

package main

import (
	"bytes"
	"net/http"
)

func main() {
	payload := []byte(`{}`)
	body := bytes.NewReader(payload)
	req, _ := http.NewRequest("POST", "https://api.conomyhq.com/sandbox/payments/{PAYMENT_ID}/captured", body)
	req.Header.Set("x-api-key", "{YOUR_API_KEY}")
	req.Header.Set("Authorization", "Bearer {ACCESS_TOKEN}")
	req.Header.Set("conomyhq-api-version", "24-04-2025")
	req.Header.Set("User-Agent", "MyApp/1.0")
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Accept", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
}

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let payload = json!({});

    let response = client
        .post("https://api.conomyhq.com/sandbox/payments/{PAYMENT_ID}/captured")
        .header("x-api-key", "{YOUR_API_KEY}")
        .header("Authorization", "Bearer {ACCESS_TOKEN}")
        .header("conomyhq-api-version", "24-04-2025")
        .header("User-Agent", "MyApp/1.0")
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .json(&payload)
        .send()
        .await?;

    let data: serde_json::Value = response.json().await?;
    Ok(())
}

Response

200

{
  "id": "<PAYMENT_ID>",
  "type": "COLLECT",
  "status": "CAPTURED"
}