Transfer
Create a Transfer
Create a new transfer.
Authorization
bearer AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.spherepay.co/v2/transfer" \ -H "Content-Type: application/json" \ -d '{ "customer": "customer_1234567890", "quoteId": "quote_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", "source": { "type": "wallet", "id": "wallet_1234567890abcdef1234567890abcdef12345678" }, "destination": { "type": "wallet", "id": "wallet_1234567890abcdef1234567890abcdef12345678" } }'{
"id": "payout_a1b2c3d4e5f6a7b8c9d0e1f2",
"externalId": "merchant_ref_123",
"type": "on_ramp",
"status": "pendingFunding",
"customer": "customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
"fees": {
"integratorFee": {
"fixedAmount": "1.00",
"bpsRate": "10",
"bpsAmount": "0.10",
"totalAmount": "1.10",
"currency": "usd"
},
"platformFee": {
"fixedAmount": "2.00",
"bpsRate": "10",
"bpsAmount": "0.10",
"totalAmount": "2.10",
"currency": "usd"
}
},
"source": {
"id": "bankAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"type": "bank_account"
},
"destination": {
"id": "wallet_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2",
"type": "wallet",
"currency": "usdc",
"network": "sol",
"amount": "string",
"exchangeRate": "1.00"
},
"depositAccount": {
"type": "bank_account",
"bankDetails": {
"bankName": "Bank of America",
"accountHolderName": "John Doe",
"accountType": "savings",
"accountNumber": "1234567890",
"routingNumber": "1234567890",
"bic": "1234567890",
"iban": "1234567890",
"pixKey": "+5511999999999",
"brCode": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"bankAddress": "123 Main St, Anytown, USA",
"beneficiaryAddress": "123 Main St, Anytown, USA",
"memo": "BBE6C7EB4A3F"
}
},
"quote": {
"id": "quote_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"expiresAt": "2021-01-01T00:00:00.000Z"
},
"updated": "2021-01-01T00:00:00.000Z",
"created": "2021-01-01T00:00:00.000Z"
}{
"status": 400,
"detail": "Invalid request parameters",
"code": "address/invalid",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}{
"status": 404,
"detail": "Resource not found",
"code": "resource/not-found",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}{
"status": 422,
"detail": "Validation failed",
"code": "validation/failed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"errors": [
{
"detail": "Invalid email format",
"pointer": "/email"
},
{
"detail": "Name is required",
"pointer": "/name"
}
]
}Last updated on