RecipesCreate a remittance
Create a remittance
Move value across currencies or countries with an internal origin and an external payout destination.
A remittance moves value from a funded Conomy account to a recipient outside the platform. Use it when the business intent is cross-border payout, marketplace settlement, family transfer, or provider payout where currency and destination data may differ from the origin.
Validate the recipient document, destination rail, and destination currency before capture. Remittance failures are usually caused by missing country-specific payout fields.
Confirm the source account has enough available balance.
Collect document, bank, and country-specific payout fields.
Submit the origin account and payout destination.
Commit the payout for processing.
Wait for the terminal webhook state.
Create the remittance
Section titled “Create the remittance”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": "remittance-1001",
"identityId": "<IDENTITY_ID>",
"accountNumber": "<ACCOUNT_NUMBER>",
"product": "USD:COP",
"type": "REMITTANCE",
"purchaseAmount": "250.00",
"purchaseCurrency": "USD",
"currency": "COP",
"origins": [
{
"type": "ACCOUNT",
"amount": "250.00",
"currency": "USD",
"identity": {
"identityId": "<IDENTITY_ID>"
},
"account": {
"accountNumber": "<ACCOUNT_NUMBER>"
}
}
],
"destinations": [
{
"type": "BANK_ACCOUNT",
"currency": "COP",
"bank": {
"accountNumber": "0312345678",
"bank": "BANCOLOMBIA",
"currency": "COP",
"typeAccount": "SAVINGS",
"accountHolder": "Jane Doe",
"accountHolderDni": "1000000000",
"country": "CO"
},
"customer": {
"firstName": "Jane",
"lastName": "Doe",
"documentNumber": "1000000000",
"country": "COL",
"email": "jane@example.com"
}
}
]
}{
"id": "<PAYMENT_ID>",
"externalId": "remittance-1001",
"type": "REMITTANCE",
"status": "CREATED"
}Capture and track it
Section titled “Capture and track it”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
Accept: application/json{
"id": "<PAYMENT_ID>",
"type": "REMITTANCE",
"status": "CAPTURED"
}