Bridge Integration
Update Bridge Integration Status
Updates the Bridge integration status. Supports two main operations:
- Opt-in to Bridge (status: “OPTED_IN”) - Creates KYC link for organization onboarding
- Create Virtual Account (status: “READY_FOR_DEPOSIT”) - Creates virtual account after KYC approval
curl --request PATCH \
--url https://api.example.com/bridge-integration \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "OPTED_IN",
"email": "[email protected]",
"full_name": "John Doe",
"kyc_type": "business"
}
'
{
"status": "OPTED_IN",
"customer_id": "cust_123abc",
"kyc_status": {
"id": "kyc_456def",
"full_name": "John Doe",
"email": "[email protected]",
"type": "business",
"kyc_link": "https://bridge.stellar.org/kyc/456def",
"tos_link": "https://bridge.stellar.org/tos/456def",
"kyc_status": "under_review",
"tos_status": "approved",
"customer_id": "cust_123abc",
"rejection_reasons": [
"Incomplete documentation",
"Address verification failed"
],
"created_at": "2025-01-01T00:00:00Z"
},
"virtual_account": {
"id": "va_789xyz",
"status": "activated",
"developer_fee_percent": "0.5",
"customer_id": "cust_123abc",
"source_deposit_instructions": {
"bank_beneficiary_name": "Stellar Bridge",
"currency": "usd",
"bank_name": "Wells Fargo",
"bank_address": "123 Main St, San Francisco, CA",
"bank_account_number": "1234567890",
"bank_routing_number": "121000248",
"payment_rails": [
"ach",
"wire"
]
},
"destination": {
"payment_rail": "stellar",
"currency": "usdc",
"address": "GDQP2KPQGKIHYJGXNUIYOMHARUARCA7DJT5FO2FFOOKY3B2WSQHG4W37",
"blockchain_memo": "12345"
}
},
"opted_in_by": "user_789",
"opted_in_at": "2025-01-01T00:00:00Z",
"virtual_account_created_by": "user_789",
"virtual_account_created_at": "2025-01-01T00:00:00Z"
}{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}{
"error": "Forbidden"
}{
"error": "Not found",
"extras": {
"status": 404,
"message": "Resource not found"
}
}Authorizations
Body
application/json
Request to update Bridge integration status
Email address for KYC verification (optional, defaults to user email)
Example:
Response
Bridge integration updated successfully
Complete Bridge integration information including status and related data
curl --request PATCH \
--url https://api.example.com/bridge-integration \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "OPTED_IN",
"email": "[email protected]",
"full_name": "John Doe",
"kyc_type": "business"
}
'
{
"status": "OPTED_IN",
"customer_id": "cust_123abc",
"kyc_status": {
"id": "kyc_456def",
"full_name": "John Doe",
"email": "[email protected]",
"type": "business",
"kyc_link": "https://bridge.stellar.org/kyc/456def",
"tos_link": "https://bridge.stellar.org/tos/456def",
"kyc_status": "under_review",
"tos_status": "approved",
"customer_id": "cust_123abc",
"rejection_reasons": [
"Incomplete documentation",
"Address verification failed"
],
"created_at": "2025-01-01T00:00:00Z"
},
"virtual_account": {
"id": "va_789xyz",
"status": "activated",
"developer_fee_percent": "0.5",
"customer_id": "cust_123abc",
"source_deposit_instructions": {
"bank_beneficiary_name": "Stellar Bridge",
"currency": "usd",
"bank_name": "Wells Fargo",
"bank_address": "123 Main St, San Francisco, CA",
"bank_account_number": "1234567890",
"bank_routing_number": "121000248",
"payment_rails": [
"ach",
"wire"
]
},
"destination": {
"payment_rail": "stellar",
"currency": "usdc",
"address": "GDQP2KPQGKIHYJGXNUIYOMHARUARCA7DJT5FO2FFOOKY3B2WSQHG4W37",
"blockchain_memo": "12345"
}
},
"opted_in_by": "user_789",
"opted_in_at": "2025-01-01T00:00:00Z",
"virtual_account_created_by": "user_789",
"virtual_account_created_at": "2025-01-01T00:00:00Z"
}{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}{
"error": "Forbidden"
}{
"error": "Not found",
"extras": {
"status": 404,
"message": "Resource not found"
}
}