Simulate (Sandbox)

Simulate Offramp Transfer Actions

post

https://api.alignlabs.devhttps://api-sandbox.alignlabs.dev

/v0/customers/{customer_id}/offramp-transfer/simulate

Path parameters

customer_idstring · uuidRequired

The unique identifier of the customer

Header parameters

Api-KeystringRequired

Your secret API key, available in the developer dashboard. Include this header on every request to authenticate your application.

Body

application/json

actionstring · enumRequired

The action to simulate

Possible values:

transfer_idstring · uuidRequired

The ID of the transfer to simulate action on

Responses

200

Successful simulation response

application/json

messagestringRequired

A message describing the result of the simulation

post

/v0/customers/{customer_id}/offramp-transfer/simulate

HTTPcURLJavaScriptPython

POST /v0/customers/{customer_id}/offramp-transfer/simulate HTTP/1.1
Host: api.alignlabs.dev
Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "action": "complete_transfer",
  "transfer_id": "123e4567-e89b-12d3-a456-426614174000"
}

200

Successful simulation response

{
  "message": "text"
}