Organization API: Customer Portal: Crypto
The 7 Organization API operations for crypto.
Part of Customer Portal.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/orgs/{org_slug}/portal/crypto/address |
This customer's permanent deposit address for the network's family |
| GET | /api/v1/orgs/{org_slug}/portal/crypto/assets |
Assets this storefront can accept right now |
| POST | /api/v1/orgs/{org_slug}/portal/crypto/check |
Look for this customer's payment now, and say where it stands |
| GET | /api/v1/orgs/{org_slug}/portal/crypto/deposits |
Deposit history, including transfers still confirming |
| GET | /api/v1/orgs/{org_slug}/portal/crypto/deposits/{deposit_id} |
One deposit, for polling while it confirms |
| GET | /api/v1/orgs/{org_slug}/portal/crypto/plan |
Every way to pay this amount in crypto, cheapest first |
| GET | /api/v1/orgs/{org_slug}/portal/crypto/quote |
How much to send for a target USD credit, itemised |
This customer's permanent deposit address for the network's family
Section titled This customer's permanent deposit address for the network's familyGET /api/v1/orgs/{org_slug}/portal/crypto/address
This customer's permanent deposit address for the network's family.
Scoped to the org, so the same customer id under two different orgs gets two different addresses and their deposits can never be confused.
Parameters
Section titled Parameters| Name | In | Type | Required | Description |
|---|---|---|---|---|
org_slug |
path | string | yes | |
network |
query | string | yes | Network key, e.g. base or bitcoin |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Assets this storefront can accept right now
Section titled Assets this storefront can accept right nowGET /api/v1/orgs/{org_slug}/portal/crypto/assets
Assets this storefront can accept right now.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
org_slug |
path | string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Look for this customer's payment now, and say where it stands
Section titled Look for this customer's payment now, and say where it standsPOST /api/v1/orgs/{org_slug}/portal/crypto/check
Look for this customer's payment now, and say where it stands.
The org portal counterpart of the platform check. An org customer waiting on a crypto payment has exactly the same question as a platform one, and the storefront SPA they are served has the same refresh button.
Rate limited per org customer, and the chain read inside is throttled per address, so several open tabs cost one read rather than one each.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
org_slug |
path | string | yes |
Request body
Section titled Request bodyapplication/json
Type: object or null.
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Deposit history, including transfers still confirming
Section titled Deposit history, including transfers still confirmingGET /api/v1/orgs/{org_slug}/portal/crypto/deposits
Deposit history, including transfers still confirming.
Parameters
Section titled Parameters| Name | In | Type | Required | Description |
|---|---|---|---|---|
org_slug |
path | string | yes | |
limit |
query | integer | no | Default: 50. |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
One deposit, for polling while it confirms
Section titled One deposit, for polling while it confirmsGET /api/v1/orgs/{org_slug}/portal/crypto/deposits/{deposit_id}
One deposit, for polling while it confirms.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
deposit_id |
path | integer | yes |
org_slug |
path | string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Every way to pay this amount in crypto, cheapest first
Section titled Every way to pay this amount in crypto, cheapest firstGET /api/v1/orgs/{org_slug}/portal/crypto/plan
Every way to pay this amount in crypto, cheapest first.
The org counterpart of the platform plan endpoint. It answers the question a customer has ("how much do I send to end up with $X?") instead of showing a rate and leaving them the arithmetic, and says outright when a chain's fee would eat the payment.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
org_slug |
path | string | yes |
amount |
query | number or string | yes |
invoice_id |
query | integer or null | no |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
How much to send for a target USD credit, itemised
Section titled How much to send for a target USD credit, itemisedGET /api/v1/orgs/{org_slug}/portal/crypto/quote
How much to send for a target USD credit, itemised.
Quoting with invoice_id records a payment intent, which is what locks
the rate and lets the deposit settle that invoice when it lands instead of
arriving as a balance the customer then has to spend by hand.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
org_slug |
path | string | yes |
network |
query | string | yes |
asset |
query | string | yes |
amount |
query | number or string | yes |
invoice_id |
query | integer or null | no |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |