Start a withdrawal to a bank account

Prepares the payout with the provider and opens it for one exact amount from source.address: the requested amount, or slightly less (one base unit at a time) when another open withdrawal of the customer from that address already holds it. Then send order.payment exactly. The source must hold the token the provider takes, on its chain (CROSS_ROUTE_NOT_SUPPORTED otherwise). Once the order exists, every error names it (orderId).

POST /offramp/orders

Start a withdrawal to a bank account

cURL

curl --request POST \
  --url https://v1.orchestrator.rhinestone.dev/deposit-processor/offramp/orders \
  --header 'Content-Type: application/json' \
  --data '
{
  "methodId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "beneficiary": {
    "holder": {
      "type": "individual",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "account": {
      "type": "us",
      "routingNumber": "<string>",
      "accountNumber": "<string>"
    },
    "reference": "<string>"
  },
  "amount": "100000000",
  "source": {
    "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
    "chain": "eip155:8453",
    "token": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91"
  }
}
'

201

{
  "order": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": "noah",
    "status": "pending",
    "terminal": true,
    "stages": {
      "receipt": {
        "status": "not_started"
      },
      "conversion": {
        "status": "not_started"
      },
      "delivery": {
        "status": "not_started"
      },
      "return": {
        "status": "none"
      }
    },
    "rail": {
      "kind": "fiat",
      "method": "<string>"
    },
    "fiat": {
      "charged": {
        "total": "<string>",
        "net": "<string>",
        "currency": "<string>"
      },
      "eur": {
        "total": "<string>",
        "net": "<string>"
      },
      "usd": {
        "total": "<string>",
        "net": "<string>"
      }
    },
    "crypto": {
      "asset": "<string>",
      "network": "<string>",
      "amount": "<string>"
    },
    "providerStatus": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "sender": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
    "payment": {
      "kind": "direct",
      "from": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
      "to": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
      "chain": "<string>",
      "token": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
      "amount": "100000000"
    },
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "estimate": {
    "fiatAmount": "<string>",
    "currency": "<string>",
    "totalFee": "<string>",
    "rate": "<string>"
  }
}

Headers

x-api-key · string

Integrator API key: the project’s orders

authorization · string

Customer bearer from POST /compliance/sessions: that customer’s orders, and every order on its bound account

Example:

"Bearer eyJhbGciOi..."

Body

application/json

methodId · string<uuid> · required

From GET /offramp/options

beneficiary · object · required

The bank account to pay. Passed to the provider only: never stored or logged.

Show child attributes

amount · string · required

In base units of source.token, as its ERC-20 transfer carries them

Pattern: ^\d+$

Example:

"100000000"

source · object · required

Where the crypto comes from

Show child attributes

Response

201

application/json

The order, the payment to send, and the estimate

order · object · required

Show child attributes

estimate · object · required

Priced on the requested amount

Show child attributes