Skip to main content
POST
/
api
/
partner
/
v2
/
off-ramp
/
execute
Execute an off-ramp transaction
curl --request POST \
  --url https://staging-api.capa.fi/api/partner/v2/off-ramp/execute \
  --header 'Content-Type: application/json' \
  --header 'partner-api-key: <partner-api-key>' \
  --data '
{
  "transactionId": "8374f327-38bd-4b0b-b8a7-2524599eb903"
}
'
{
  "success": true,
  "data": {
    "id": "8374f327-38bd-4b0b-b8a7-2524599eb903",
    "status": "PENDING"
  }
}
Executes a previously created off-ramp transaction. This endpoint triggers the actual processing of the off-ramp transaction after crypto funds have been received.

​
Headers

HeaderDescription
partner-api-keyAPI key associated with your partner account. Required. See API Key Generation Guide.
This endpoint requires authentication using a valid partner-api-key.

​
Request Body

ParameterTypeRequiredDescription
transactionIdstringYesUUID identifier for the off-ramp transaction to execute. This should be the id returned from the Create Off-Ramp endpoint.

​
Example Request

curl --request POST \
     --url https://staging-api.capa.fi/api/partner/v2/off-ramp/execute \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'partner-api-key: API-KEY' \
     --data '
{
  "transactionId": "8374f327-38bd-4b0b-b8a7-2524599eb903"
}
'

​
Response Body

FieldTypeDescription
idstringUUID of the executed transaction.
statusstringCurrent status of the transaction after execution attempt.

​
Transaction Status Values

StatusDescription
PENDINGTransaction is pending processing.
IN_PROGRESSTransaction is being processed.
COMPLETEDTransaction has completed successfully.
FAILEDTransaction has failed.
CANCELLEDTransaction was cancelled.
EXPIREDTransaction has expired.
CRYPTO_RECEIVEDCrypto payment has been received.
CRYPTO_NOT_RECEIVEDCrypto payment was not received.
COMPLETED_CRYPTO_RECEIVALCrypto receival process has completed.
BANK_TRANSFER_PENDINGBank transfer is pending.
READY_BANK_TRANSFERReady to initiate bank transfer.

​
Example Response

{
    "success": true,
    "data": {
        "id": "8374f327-38bd-4b0b-b8a7-2524599eb903",
        "status": "PENDING"
    }
}

​
Important Notes & Requirements

  • Partner API Key is mandatory: All requests must include a valid partner-api-key in the header. Get your API key.
  • Transaction must exist: The transactionId must reference a valid off-ramp transaction created via the Create Off-Ramp endpoint.
  • Partner ownership: The transaction must belong to the partner associated with the API key.

​
Use Cases

  • Manual Execution: Trigger execution of an off-ramp transaction after verifying crypto receipt.
  • Workflow Integration: Integrate into automated workflows where transaction execution needs to be controlled separately from creation.

​
Error Codes

​
Common Errors

HTTP StatusCodeMessage
401UNAUTHORIZED”API Key is missing”
401UNAUTHORIZED”Invalid API Key format”
401UNAUTHORIZED”Invalid API Key”

​
Endpoint-Specific Errors

HTTP StatusCodeMessage
400INVALID_USER_INPUT_ERROR”Invalid User Input”
404TRANSACTION_NOT_FOUND”Transaction not found”
403TRANSACTION_ACCESS_DENIED”Transaction does not belong to this partner”

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Body

application/json
​
transactionId
string<uuid>
required

Identifier for the off-ramp transaction to execute

Example:

"8374f327-38bd-4b0b-b8a7-2524599eb903"

Response

200 - application/json

Transaction execution initiated successfully

​
success
boolean
Example:

true

​
data
object