Effortless customer verification now available   View changelog →
Sphere Paysphere
Transfer

Retrieve a Transfer

Retrieve a specific transfer

GET
/v2/transfer/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

The payout ID.

Query Parameters

customerstring

Response Body

curl -X GET "https://api.spherepay.co/v2/transfer/payout_d243ab2b1de4447d8a046d87fefe58cf?customer=string"
{
  "id": "payout_123456abcdefg",
  "externalId": "merchant_ref_123",
  "type": "on_ramp",
  "status": "pendingFunding",
  "customer": "customer_123abc...",
  "fees": {
    "integratorFee": {
      "fixedAmount": "1.00",
      "bpsRate": "10",
      "totalAmount": "1.10",
      "currency": "usd"
    },
    "platformFee": {
      "fixedAmount": "2.00",
      "bpsRate": "10",
      "totalAmount": "2.10",
      "currency": "usd"
    }
  },
  "source": {
    "id": "bank_account_123abc...",
    "type": "bank_account"
  },
  "destination": {
    "id": "wallet_1234567890abcdef1234567890abcdef12345678",
    "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",
      "bankAddress": "123 Main St, Anytown, USA",
      "beneficiaryAddress": "123 Main St, Anytown, USA",
      "memo": "BBE6C7E..."
    }
  },
  "updated": "2021-01-01T00:00:00.000Z",
  "created": "2021-01-01T00:00:00.000Z",
  "tracking": {
    "source": {
      "transactionId": "0xabc123...",
      "imad": "123456789012345678901234",
      "traceNumber": "123456789012345",
      "sepaReference": "ABC123456789"
    },
    "destination": {
      "transactionId": "0xabc123...",
      "imad": "123456789012345678901234",
      "traceNumber": "123456789012345",
      "sepaReference": "ABC123456789"
    }
  }
}

{
  "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"
    }
  ]
}