-
Notifications
You must be signed in to change notification settings - Fork 1
Making some doc updates #116
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
9e9eaa9
c654e23
73b50dc
6aab66e
18beb30
41273f6
cbff463
d26b377
fb5f788
251b11b
998ae11
1662c0e
25fc0a8
3719936
ca17897
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,7 @@ description: "Send your first cross-border payment" | |
| --- | ||
| import { remittanceProductName } from '/snippets/variables.mdx' | ||
|
|
||
| This quickstart guides you through a regulated FI sending an individual customer payment from the US to a bank account in Mexico using just-in-time funding. | ||
| With Global P2P you can send and receive payments in any supported fiat or crypto currency. This quickstart guides you through a regulated FI sending an individual customer payment from the US to a bank account in Mexico using USDC just-in-time funding. For examples funding with real time fiat rails, see the [Sending Payments](/global-p2p/sending-receiving-payments/sending-payments) guide. | ||
|
|
||
| ## Understanding Entity Mapping for Remittances | ||
|
|
||
|
|
@@ -130,8 +130,8 @@ In this guide, the entities map as follows: | |
| -H "Content-Type: application/json" \ | ||
| -d '{ | ||
| "source": { | ||
| "umaAddress": "$alice@yourapp.example", | ||
| "currency": "USD" | ||
| "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001", | ||
| "currency": "USDC" | ||
| }, | ||
| "destination": { | ||
| "accountId": "ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123", | ||
|
|
@@ -151,36 +151,33 @@ In this guide, the entities map as follows: | |
| "fees": { "amount": 50, "currency": { "code": "USD", "decimals": 2 } }, | ||
| "paymentInstructions": [ | ||
| { | ||
| "accountOrWalletInfo": { | ||
| "reference": "UMA-Q12345-REF", | ||
| "accountType": "US_ACCOUNT", | ||
| "accountNumber": "987654321", | ||
| "routingNumber": "123456789", | ||
| "accountCategory": "CHECKING", | ||
| "bankName": "Example Bank" | ||
| } | ||
| "accountOrWalletInfo": { | ||
| "accountType": "SOLANA_WALLET", | ||
| "address": "0x1234567890123456789012345678901234567890", | ||
| "assetType": "USDC" | ||
| } | ||
| }, | ||
| { | ||
| "accountOrWalletInfo": { | ||
| "accountType": "SOLANA_WALLET", | ||
| "assetType": "USDC", | ||
| "address": "4Nd1m6Qkq7RfKuE5vQ9qP9Tn6H94Ueqb4xXHzsAbd8Wg" | ||
| } | ||
| "accountOrWalletInfo": { | ||
| "accountType": "BASE_WALLET", | ||
| "address": "0x1234567890123456789012345678901234567890", | ||
| "assetType": "USDC" | ||
| } | ||
| } | ||
| ], | ||
| "status": "PENDING" | ||
| } | ||
| ``` | ||
| ## Fund the quote (Sandbox simulation) | ||
| In production, you would trigger a real‑time push on a local instant rail (e.g., RTP, SPEI, SEPA Instant) to the provided `bankAccountInfo` using the exact `reference`. In Sandbox, you can mock funding using the simulate send endpoint. | ||
| In production, you would trigger a payment on one of the supported blockchains to the provided address. In Sandbox, you can mock funding using the simulate send endpoint. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why are we doing stablecoin stuff for P2P?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let me tweak this to highlight that you can use real-time payment or crypto rails, but the example focuses on crypto. It seems the zeitgeist is stablecoin settlements and trying to address that interest.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. But this whole demo in particular is mostly around the sofi/umaaas use case, no?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It is the UMAaas flow but there are an increasing number of neobanks / eWallets offering USD denominated accounts where balances are actually USDC. I've updated it to With Global P2P you can send and receive payments in any supported fiat or crypto currency. This quickstart guides you through a regulated FI sending an individual customer payment from the US to a bank account in Mexico using USDC just-in-time funding. For an example funding with real time fiat rails, see the Sending Payments guide. |
||
|
|
||
| ```bash | ||
| curl -sS -X POST "https://api.lightspark.com/grid/2025-10-13/sandbox/send" \ | ||
| -u "$GRID_CLIENT_ID:$GRID_API_SECRET" \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{ | ||
| "reference": "UMA-Q12345-REF", | ||
| "currencyCode": "USD", | ||
| "currencyCode": "USDC", | ||
| "currencyAmount": 10000 | ||
| }' | ||
| ``` | ||
|
|
@@ -208,19 +205,6 @@ In this guide, the entities map as follows: | |
| "receivedAmount": { "amount": 9706, "currency": { "code": "MXN", "decimals": 2 } }, | ||
| "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001", | ||
| "quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006", | ||
| "paymentInstructions": [ | ||
| { | ||
| "instructionsNotes": "Include reference code in transfer memo", | ||
| "accountOrWalletInfo": { | ||
| "accountType": "US_ACCOUNT", | ||
| "accountNumber": "1234567890", | ||
| "routingNumber": "021000021", | ||
| "bankName": "Chase Bank", | ||
| "referenceCode": "REF123456" | ||
| } | ||
| }, | ||
| ] | ||
| } | ||
| }, | ||
| "timestamp": "2025-01-15T14:32:00Z", | ||
| "webhookId": "Webhook:019542f5-b3e7-1d02-0000-000000000007", | ||
|
|
||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| ## Customer Types | ||
|
|
||
| The Grid API supports both individual and business customers. While the API schema itself makes most Personally Identifiable Information (PII) optional at initial creation, specific fields may become mandatory based on the currencies the customer will transact with. | ||
|
|
||
| Your platform’s configuration ( retrieved via `GET /config`) includes a supportedCurrencies array. Each currency object within this array has a providerRequiredCustomerFields list. If a customer is intended to use a specific currency, any fields listed for that currency must be provided when creating or updating the customer. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| ## Onboarding model | ||
|
|
||
| There are two models for regulated and unregulated platforms. | ||
|
|
||
| - Regulated platforms: Use your existing compliance processes. Create individual and business customers directly via `POST /customers`. The information you supply is used for beneficiary/counterparty compliance screening. | ||
| - Unregulated platforms: Grid performs KYC/KYB. Generate a hosted KYC/KYB link, redirect your customer to complete verification in their locale, receive a KYC result webhook. While KYC is pending, allow customers to finish account setup but block funding and money movement. |
Uh oh!
There was an error while loading. Please reload this page.