Sphere Paysphere

Get Transfer Details

You can retrieve information about a transfer using the transfer id.

Note

You can only retrieve information about a transfer if you have the transfer id. We do not filter by receipt number or other identifiers.

For the full API specification, see the Sphere API Reference.

GET https://api.spherepay.co/v1/transfer/:id

The response will contain information about the transfer that matches the ID you provided.

Note

If a transfer is not found, the response will be a 404 error.

Response Example

{
  "ok": true,
  "object": "object",
  "statusCode": 200,
  "error": null,
  "message": "success",
  "data": {
    "transfer": {
      "id": "{{transfer_id}}",
      "number": 18,
      "type": "onRamp",
      "status": "pending",
      "meta": {},
      "lookupKey": null,
      "amount": "10.00",
      "finalAmount": null,
      "source": {
        "id": "{{bank_account_id}}",
        "currency": "usd",
        "network": "wire"
      },
      "destination": {
        "id": "{{wallet_account_id}}",
        "currency": "usdc",
        "network": "ethereum"
      },
      "instructions": {
        "memo": "BRGSFNHQBH3RKPEQDMD2",
        "imad": null,
        "omad": null,
        "human": "Send 10 usd via the wire network from {{bank_account_id}} with an account number of ********5771 to {{bank_account_id}} with an account number of ********2035. After sending usd, the transfer will be funded and 10 of usdc will be on-ramped to {{wallet_account_id}} with an address of {{wallet_address}} on the ethereum network.",
        "machine": "",
        "resource": {
          "id": "{{bank_account_id}}",
          "status": "active",
          "bankName": "Lead Bank",
          "accountHolderName": "Sphere Bank Account",
          "accountName": "Sphere Bank Account",
          "accountNumber": "1234567890",
          "customer": "{{customer_id}}",
          "last4": "2035",
          "routingNumber": "0987654321",
          "bankAddressString": "1801 Main St. Kansas City MO 64108, Kansas, United States of America",
          "meta": {},
          "currency": "usd",
          "accountType": "checking",
        }
      },
      "mock": false,
      "customer": "{{customer_id}}",
    }
  },
  "ts": "{{timestamp}}",
  "request": "{{request_id}}"
}

Last updated on

On this page